@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class QueryRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a Query operation.
NOOP
Constructor and Description |
---|
QueryRequest()
Default constructor for QueryRequest object.
|
QueryRequest(String tableName)
Constructs a new QueryRequest object.
|
Modifier and Type | Method and Description |
---|---|
QueryRequest |
addExclusiveStartKeyEntry(String key,
AttributeValue value) |
QueryRequest |
addExpressionAttributeNamesEntry(String key,
String value) |
QueryRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value) |
QueryRequest |
addKeyConditionsEntry(String key,
Condition value) |
QueryRequest |
addQueryFilterEntry(String key,
Condition value) |
QueryRequest |
clearExclusiveStartKeyEntries()
Removes all the entries added into ExclusiveStartKey.
|
QueryRequest |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
QueryRequest |
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.
|
QueryRequest |
clearKeyConditionsEntries()
Removes all the entries added into KeyConditions.
|
QueryRequest |
clearQueryFilterEntries()
Removes all the entries added into QueryFilter.
|
QueryRequest |
clone() |
boolean |
equals(Object obj) |
List<String> |
getAttributesToGet()
|
String |
getConditionalOperator()
|
Boolean |
getConsistentRead()
Determines the read consistency model: If set to
true , then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads. |
Map<String,AttributeValue> |
getExclusiveStartKey()
The primary key of the first item that this operation will evaluate.
|
Map<String,String> |
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
Map<String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
String |
getFilterExpression()
A string that contains conditions that DynamoDB applies after the Query operation, but before the data is
returned to you.
|
String |
getIndexName()
The name of an index to query.
|
String |
getKeyConditionExpression()
The condition that specifies the key value(s) for items to be retrieved by the Query action.
|
Map<String,Condition> |
getKeyConditions()
|
Integer |
getLimit()
The maximum number of items to evaluate (not necessarily the number of matching items).
|
String |
getProjectionExpression()
A string that identifies one or more attributes to retrieve from the table.
|
Map<String,Condition> |
getQueryFilter()
|
String |
getReturnConsumedCapacity() |
Boolean |
getScanIndexForward()
Specifies the order for index traversal: If
true (default), the traversal is performed in ascending
order; if false , the traversal is performed in descending order. |
String |
getSelect()
The attributes to be returned in the result.
|
String |
getTableName()
The name of the table containing the requested items.
|
int |
hashCode() |
Boolean |
isConsistentRead()
Determines the read consistency model: If set to
true , then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads. |
Boolean |
isScanIndexForward()
Specifies the order for index traversal: If
true (default), the traversal is performed in ascending
order; if false , the traversal is performed in descending order. |
void |
setAttributesToGet(Collection<String> attributesToGet)
|
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
|
void |
setConditionalOperator(String conditionalOperator)
|
void |
setConsistentRead(Boolean consistentRead)
Determines the read consistency model: If set to
true , then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads. |
void |
setExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
The primary hash and range keys of the first item that this operation will evaluate.
|
void |
setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.
|
void |
setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
void |
setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
void |
setFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Query operation, but before the data is
returned to you.
|
void |
setIndexName(String indexName)
The name of an index to query.
|
void |
setKeyConditionExpression(String keyConditionExpression)
The condition that specifies the key value(s) for items to be retrieved by the Query action.
|
void |
setKeyConditions(Map<String,Condition> keyConditions)
|
void |
setLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items).
|
void |
setProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the table.
|
void |
setQueryFilter(Map<String,Condition> queryFilter)
|
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
void |
setReturnConsumedCapacity(String returnConsumedCapacity) |
void |
setScanIndexForward(Boolean scanIndexForward)
Specifies the order for index traversal: If
true (default), the traversal is performed in ascending
order; if false , the traversal is performed in descending order. |
void |
setSelect(Select select)
The attributes to be returned in the result.
|
void |
setSelect(String select)
The attributes to be returned in the result.
|
void |
setTableName(String tableName)
The name of the table containing the requested items.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
QueryRequest |
withAttributesToGet(Collection<String> attributesToGet)
|
QueryRequest |
withAttributesToGet(String... attributesToGet)
|
QueryRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
|
QueryRequest |
withConditionalOperator(String conditionalOperator)
|
QueryRequest |
withConsistentRead(Boolean consistentRead)
Determines the read consistency model: If set to
true , then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads. |
QueryRequest |
withExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
The primary hash and range keys of the first item that this operation will evaluate.
|
QueryRequest |
withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.
|
QueryRequest |
withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
QueryRequest |
withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
QueryRequest |
withFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Query operation, but before the data is
returned to you.
|
QueryRequest |
withIndexName(String indexName)
The name of an index to query.
|
QueryRequest |
withKeyConditionExpression(String keyConditionExpression)
The condition that specifies the key value(s) for items to be retrieved by the Query action.
|
QueryRequest |
withKeyConditions(Map<String,Condition> keyConditions)
|
QueryRequest |
withLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items).
|
QueryRequest |
withProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the table.
|
QueryRequest |
withQueryFilter(Map<String,Condition> queryFilter)
|
QueryRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) |
QueryRequest |
withReturnConsumedCapacity(String returnConsumedCapacity) |
QueryRequest |
withScanIndexForward(Boolean scanIndexForward)
Specifies the order for index traversal: If
true (default), the traversal is performed in ascending
order; if false , the traversal is performed in descending order. |
QueryRequest |
withSelect(Select select)
The attributes to be returned in the result.
|
QueryRequest |
withSelect(String select)
The attributes to be returned in the result.
|
QueryRequest |
withTableName(String tableName)
The name of the table containing the requested items.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public QueryRequest()
public QueryRequest(String tableName)
tableName
- The name of the table containing the requested items.public void setTableName(String tableName)
The name of the table containing the requested items.
tableName
- The name of the table containing the requested items.public String getTableName()
The name of the table containing the requested items.
public QueryRequest withTableName(String tableName)
The name of the table containing the requested items.
tableName
- The name of the table containing the requested items.public void setIndexName(String indexName)
The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.
indexName
- The name of an index to query. This index can be any local secondary index or global secondary index on
the table. Note that if you use the IndexName parameter, you must also provide TableName.public String getIndexName()
The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.
public QueryRequest withIndexName(String indexName)
The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.
indexName
- The name of an index to query. This index can be any local secondary index or global secondary index on
the table. Note that if you use the IndexName parameter, you must also provide TableName.public void setSelect(String select)
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you query
a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the
parent table. If the index is configured to project all item attributes, then all of the data can be obtained
from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have
been projected into the index. If the index is configured to project all attributes, this return value is
equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when accessing an
index. You cannot use both Select and AttributesToGet together in a single request, unless the
value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
select
- The attributes to be returned in the result. You can retrieve all item attributes, specific item
attributes, the count of matching items, or in the case of an index, some or all of the attributes
projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you
query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire
item from the parent table. If the index is configured to project all item attributes, then all of the
data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that
have been projected into the index. If the index is configured to project all attributes, this return
value is equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This
return value is equivalent to specifying AttributesToGet without specifying any value for
Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when
accessing an index. You cannot use both Select and AttributesToGet together in a single
request, unless the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent
to specifying AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
Select
public String getSelect()
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you query
a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the
parent table. If the index is configured to project all item attributes, then all of the data can be obtained
from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have
been projected into the index. If the index is configured to project all attributes, this return value is
equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when accessing an
index. You cannot use both Select and AttributesToGet together in a single request, unless the
value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If
you query a local secondary index, then for each matching item in the index DynamoDB will fetch the
entire item from the parent table. If the index is configured to project all item attributes, then all of
the data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes
that have been projected into the index. If the index is configured to project all attributes, this
return value is equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This
return value is equivalent to specifying AttributesToGet without specifying any value for
Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when
accessing an index. You cannot use both Select and AttributesToGet together in a single
request, unless the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is
equivalent to specifying AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
Select
public QueryRequest withSelect(String select)
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you query
a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the
parent table. If the index is configured to project all item attributes, then all of the data can be obtained
from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have
been projected into the index. If the index is configured to project all attributes, this return value is
equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when accessing an
index. You cannot use both Select and AttributesToGet together in a single request, unless the
value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
select
- The attributes to be returned in the result. You can retrieve all item attributes, specific item
attributes, the count of matching items, or in the case of an index, some or all of the attributes
projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you
query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire
item from the parent table. If the index is configured to project all item attributes, then all of the
data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that
have been projected into the index. If the index is configured to project all attributes, this return
value is equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This
return value is equivalent to specifying AttributesToGet without specifying any value for
Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when
accessing an index. You cannot use both Select and AttributesToGet together in a single
request, unless the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent
to specifying AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
Select
public void setSelect(Select select)
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you query
a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the
parent table. If the index is configured to project all item attributes, then all of the data can be obtained
from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have
been projected into the index. If the index is configured to project all attributes, this return value is
equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when accessing an
index. You cannot use both Select and AttributesToGet together in a single request, unless the
value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
select
- The attributes to be returned in the result. You can retrieve all item attributes, specific item
attributes, the count of matching items, or in the case of an index, some or all of the attributes
projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you
query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire
item from the parent table. If the index is configured to project all item attributes, then all of the
data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that
have been projected into the index. If the index is configured to project all attributes, this return
value is equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This
return value is equivalent to specifying AttributesToGet without specifying any value for
Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when
accessing an index. You cannot use both Select and AttributesToGet together in a single
request, unless the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent
to specifying AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
Select
public QueryRequest withSelect(Select select)
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you query
a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the
parent table. If the index is configured to project all item attributes, then all of the data can be obtained
from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that have
been projected into the index. If the index is configured to project all attributes, this return value is
equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when accessing an
index. You cannot use both Select and AttributesToGet together in a single request, unless the
value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
select
- The attributes to be returned in the result. You can retrieve all item attributes, specific item
attributes, the count of matching items, or in the case of an index, some or all of the attributes
projected into the index.
ALL_ATTRIBUTES
- Returns all of the item attributes from the specified table or index. If you
query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire
item from the parent table. If the index is configured to project all item attributes, then all of the
data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES
- Allowed only when querying an index. Retrieves all attributes that
have been projected into the index. If the index is configured to project all attributes, this return
value is equivalent to specifying ALL_ATTRIBUTES
.
COUNT
- Returns the number of matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES
- Returns only the attributes listed in AttributesToGet. This
return value is equivalent to specifying AttributesToGet without specifying any value for
Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES
when accessing a table, and ALL_PROJECTED_ATTRIBUTES
when
accessing an index. You cannot use both Select and AttributesToGet together in a single
request, unless the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent
to specifying AttributesToGet without any value for Select.)
If you use the ProjectionExpression parameter, then the value for Select can only be
SPECIFIC_ATTRIBUTES
. Any other value for Select will return an error.
Select
public List<String> getAttributesToGet()
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in a Query request, unless
the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in a Query request,
unless the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent
to specifying AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
public void setAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in a Query request, unless
the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
attributesToGet
- This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in a Query request,
unless the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent
to specifying AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
public QueryRequest withAttributesToGet(String... attributesToGet)
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in a Query request, unless
the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
NOTE: This method appends the values to the existing list (if any). Use
setAttributesToGet(java.util.Collection)
or withAttributesToGet(java.util.Collection)
if you
want to override the existing values.
attributesToGet
- This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in a Query request,
unless the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent
to specifying AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
public QueryRequest withAttributesToGet(Collection<String> attributesToGet)
This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in a Query request, unless
the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent to specifying
AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
attributesToGet
- This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both AttributesToGet and Select together in a Query request,
unless the value for Select is SPECIFIC_ATTRIBUTES
. (This usage is equivalent
to specifying AttributesToGet without any value for Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
public void setLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
limit
- The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB
processes the number of items up to the limit while processing the results, it stops the operation and
returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a
subsequent operation, so that you can pick up where you left off. Also, if the processed data set size
exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up
to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the
operation. For more information, see Query and
Scan in the Amazon DynamoDB Developer Guide.public Integer getLimit()
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
public QueryRequest withLimit(Integer limit)
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.
limit
- The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB
processes the number of items up to the limit while processing the results, it stops the operation and
returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a
subsequent operation, so that you can pick up where you left off. Also, if the processed data set size
exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up
to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the
operation. For more information, see Query and
Scan in the Amazon DynamoDB Developer Guide.public void setConsistentRead(Boolean consistentRead)
Determines the read consistency model: If set to true
, then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index
with ConsistentRead set to true
, you will receive a ValidationException.
consistentRead
- Determines the read consistency model: If set to true
, then the operation uses strongly
consistent reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary
index with ConsistentRead set to true
, you will receive a ValidationException.
public Boolean getConsistentRead()
Determines the read consistency model: If set to true
, then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index
with ConsistentRead set to true
, you will receive a ValidationException.
true
, then the operation uses strongly
consistent reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary
index with ConsistentRead set to true
, you will receive a ValidationException.
public QueryRequest withConsistentRead(Boolean consistentRead)
Determines the read consistency model: If set to true
, then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index
with ConsistentRead set to true
, you will receive a ValidationException.
consistentRead
- Determines the read consistency model: If set to true
, then the operation uses strongly
consistent reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary
index with ConsistentRead set to true
, you will receive a ValidationException.
public Boolean isConsistentRead()
Determines the read consistency model: If set to true
, then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index
with ConsistentRead set to true
, you will receive a ValidationException.
true
, then the operation uses strongly
consistent reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary
index with ConsistentRead set to true
, you will receive a ValidationException.
public Map<String,Condition> getKeyConditions()
This is a legacy parameter, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
The selection criteria for the query. For a query on a table, you can have conditions only on the table primary
key attributes. You must provide the partition key name and value as an EQ
condition. You can
optionally provide a second condition, referring to the sort key.
If you don't provide a sort key condition, all of the items that match the partition key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key attributes. You must provide the index
partition key name and value as an EQ
condition. You can optionally provide a second condition,
referring to the index sort key.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
example, a
is greater than A
, and a
is greater than B
. For a
list of code values, see http://en.wikipedia
.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ
: Equal.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a different type than the one specified in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one provided
in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one provided
in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one provided
in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN
: Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String,
Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to,
the first element and less than, or equal to, the second element. If an item contains an AttributeValue
element of a different type than the one provided in the request, the value does not match. For example,
{"S":"6"}
does not compare to {"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
This is a legacy parameter, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
The selection criteria for the query. For a query on a table, you can have conditions only on the table
primary key attributes. You must provide the partition key name and value as an EQ
condition. You can optionally provide a second condition, referring to the sort key.
If you don't provide a sort key condition, all of the items that match the partition key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key attributes. You must provide the
index partition key name and value as an EQ
condition. You can optionally provide a second
condition, referring to the index sort key.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values.
For example, a
is greater than A
, and a
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ
: Equal.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one
specified in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than
the one provided in the request, the value does not match. For example, {"S":"6"}
does not
equal {"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one
provided in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than
the one provided in the request, the value does not match. For example, {"S":"6"}
does not
equal {"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than
the one provided in the request, the value does not match. For example, {"S":"6"}
does not
equal {"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN
: Greater than or equal to the first value, and less than or equal to the second
value.
AttributeValueList must contain two AttributeValue elements of the same type, either
String, Number, or Binary (not a set type). A target attribute matches if the target value is greater
than, or equal to, the first element and less than, or equal to, the second element. If an item contains
an AttributeValue element of a different type than the one provided in the request, the value does
not match. For example, {"S":"6"}
does not compare to {"N":"6"}
. Also,
{"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
public void setKeyConditions(Map<String,Condition> keyConditions)
This is a legacy parameter, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
The selection criteria for the query. For a query on a table, you can have conditions only on the table primary
key attributes. You must provide the partition key name and value as an EQ
condition. You can
optionally provide a second condition, referring to the sort key.
If you don't provide a sort key condition, all of the items that match the partition key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key attributes. You must provide the index
partition key name and value as an EQ
condition. You can optionally provide a second condition,
referring to the index sort key.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
example, a
is greater than A
, and a
is greater than B
. For a
list of code values, see http://en.wikipedia
.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ
: Equal.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a different type than the one specified in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one provided
in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one provided
in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one provided
in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN
: Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String,
Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to,
the first element and less than, or equal to, the second element. If an item contains an AttributeValue
element of a different type than the one provided in the request, the value does not match. For example,
{"S":"6"}
does not compare to {"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
keyConditions
- This is a legacy parameter, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
The selection criteria for the query. For a query on a table, you can have conditions only on the table
primary key attributes. You must provide the partition key name and value as an EQ
condition.
You can optionally provide a second condition, referring to the sort key.
If you don't provide a sort key condition, all of the items that match the partition key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key attributes. You must provide the
index partition key name and value as an EQ
condition. You can optionally provide a second
condition, referring to the index sort key.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values.
For example, a
is greater than A
, and a
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ
: Equal.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one
specified in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one
provided in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN
: Greater than or equal to the first value, and less than or equal to the second
value.
AttributeValueList must contain two AttributeValue elements of the same type, either String,
Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or
equal to, the first element and less than, or equal to, the second element. If an item contains an
AttributeValue element of a different type than the one provided in the request, the value does not
match. For example, {"S":"6"}
does not compare to {"N":"6"}
. Also,
{"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
public QueryRequest withKeyConditions(Map<String,Condition> keyConditions)
This is a legacy parameter, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
The selection criteria for the query. For a query on a table, you can have conditions only on the table primary
key attributes. You must provide the partition key name and value as an EQ
condition. You can
optionally provide a second condition, referring to the sort key.
If you don't provide a sort key condition, all of the items that match the partition key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key attributes. You must provide the index
partition key name and value as an EQ
condition. You can optionally provide a second condition,
referring to the index sort key.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
example, a
is greater than A
, and a
is greater than B
. For a
list of code values, see http://en.wikipedia
.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ
: Equal.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a different type than the one specified in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one provided
in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}
.
Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one provided
in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one provided
in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN
: Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String,
Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to,
the first element and less than, or equal to, the second element. If an item contains an AttributeValue
element of a different type than the one provided in the request, the value does not match. For example,
{"S":"6"}
does not compare to {"N":"6"}
. Also, {"N":"6"}
does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
keyConditions
- This is a legacy parameter, for backward compatibility. New applications should use KeyConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
The selection criteria for the query. For a query on a table, you can have conditions only on the table
primary key attributes. You must provide the partition key name and value as an EQ
condition.
You can optionally provide a second condition, referring to the sort key.
If you don't provide a sort key condition, all of the items that match the partition key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key attributes. You must provide the
index partition key name and value as an EQ
condition. You can optionally provide a second
condition, referring to the index sort key.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values.
For example, a
is greater than A
, and a
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
The following are descriptions of these comparison operators.
EQ
: Equal.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one
specified in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}
.
LE
: Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
LT
: Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary
(not a set type). If an item contains an AttributeValue element of a different type than the one
provided in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GE
: Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
GT
: Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue element of a different type than the
one provided in the request, the value does not match. For example, {"S":"6"}
does not equal
{"N":"6"}
. Also, {"N":"6"}
does not compare to
{"NS":["6", "2", "1"]}
.
BEGINS_WITH
: Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN
: Greater than or equal to the first value, and less than or equal to the second
value.
AttributeValueList must contain two AttributeValue elements of the same type, either String,
Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or
equal to, the first element and less than, or equal to, the second element. If an item contains an
AttributeValue element of a different type than the one provided in the request, the value does not
match. For example, {"S":"6"}
does not compare to {"N":"6"}
. Also,
{"N":"6"}
does not compare to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
public QueryRequest addKeyConditionsEntry(String key, Condition value)
public QueryRequest clearKeyConditionsEntries()
public Map<String,Condition> getQueryFilter()
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter does not support attributes of type List or Map.
A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
If you provide more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a partition key or a sort key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
example, a
is greater than A
, and a
is greater than B
. For a
list of code values, see http://en.wikipedia
.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see the Condition data type.
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter does not support attributes of type List or Map.
A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
If you provide more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a partition key or a sort key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values.
For example, a
is greater than A
, and a
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see the Condition data type.
public void setQueryFilter(Map<String,Condition> queryFilter)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter does not support attributes of type List or Map.
A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
If you provide more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a partition key or a sort key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
example, a
is greater than A
, and a
is greater than B
. For a
list of code values, see http://en.wikipedia
.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see the Condition data type.
queryFilter
- This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter does not support attributes of type List or Map.
A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
If you provide more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a partition key or a sort key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values.
For example, a
is greater than A
, and a
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see the Condition data type.
public QueryRequest withQueryFilter(Map<String,Condition> queryFilter)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter does not support attributes of type List or Map.
A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
If you provide more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a partition key or a sort key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
example, a
is greater than A
, and a
is greater than B
. For a
list of code values, see http://en.wikipedia
.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see the Condition data type.
queryFilter
- This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter does not support attributes of type List or Map.
A QueryFilter is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
If you provide more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a partition key or a sort key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values.
For example, a
is greater than A
, and a
is greater than
B
. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
For complete descriptions of all comparison operators, see the Condition data type.
public QueryRequest addQueryFilterEntry(String key, Condition value)
public QueryRequest clearQueryFilterEntries()
public void setConditionalOperator(String conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
conditionalOperator
- This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperator
public String getConditionalOperator()
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperator
public QueryRequest withConditionalOperator(String conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
conditionalOperator
- This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperator
public void setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
conditionalOperator
- This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperator
public QueryRequest withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
conditionalOperator
- This is a legacy parameter, for backward compatibility. New applications should use FilterExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a QueryFilter map:
AND
- If all of the conditions evaluate to true, then the entire map evaluates to true.
OR
- If at least one of the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then AND
is the default.
The operation will succeed only if the entire map evaluates to true.
This parameter does not support attributes of type List or Map.
ConditionalOperator
public void setScanIndexForward(Boolean scanIndexForward)
Specifies the order for index traversal: If true
(default), the traversal is performed in ascending
order; if false
, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the results in the order in which they are
stored (by sort key value). This is the default behavior. If ScanIndexForward is false
,
DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.
scanIndexForward
- Specifies the order for index traversal: If true
(default), the traversal is performed in
ascending order; if false
, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the results in the order in which they
are stored (by sort key value). This is the default behavior. If ScanIndexForward is
false
, DynamoDB reads the results in reverse order by sort key value, and then returns the
results to the client.
public Boolean getScanIndexForward()
Specifies the order for index traversal: If true
(default), the traversal is performed in ascending
order; if false
, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the results in the order in which they are
stored (by sort key value). This is the default behavior. If ScanIndexForward is false
,
DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.
true
(default), the traversal is performed in
ascending order; if false
, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the results in the order in which they
are stored (by sort key value). This is the default behavior. If ScanIndexForward is
false
, DynamoDB reads the results in reverse order by sort key value, and then returns the
results to the client.
public QueryRequest withScanIndexForward(Boolean scanIndexForward)
Specifies the order for index traversal: If true
(default), the traversal is performed in ascending
order; if false
, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the results in the order in which they are
stored (by sort key value). This is the default behavior. If ScanIndexForward is false
,
DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.
scanIndexForward
- Specifies the order for index traversal: If true
(default), the traversal is performed in
ascending order; if false
, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the results in the order in which they
are stored (by sort key value). This is the default behavior. If ScanIndexForward is
false
, DynamoDB reads the results in reverse order by sort key value, and then returns the
results to the client.
public Boolean isScanIndexForward()
Specifies the order for index traversal: If true
(default), the traversal is performed in ascending
order; if false
, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the results in the order in which they are
stored (by sort key value). This is the default behavior. If ScanIndexForward is false
,
DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.
true
(default), the traversal is performed in
ascending order; if false
, the traversal is performed in descending order.
Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.
If ScanIndexForward is true
, DynamoDB returns the results in the order in which they
are stored (by sort key value). This is the default behavior. If ScanIndexForward is
false
, DynamoDB reads the results in reverse order by sort key value, and then returns the
results to the client.
public Map<String,AttributeValue> getExclusiveStartKey()
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
public void setExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
exclusiveStartKey
- The primary key of the first item that this operation will evaluate. Use the value that was returned for
LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
public QueryRequest withExclusiveStartKey(Map<String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
exclusiveStartKey
- The primary key of the first item that this operation will evaluate. Use the value that was returned for
LastEvaluatedKey in the previous operation.
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
public QueryRequest addExclusiveStartKeyEntry(String key, AttributeValue value)
public QueryRequest clearExclusiveStartKeyEntries()
public void setReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public String getReturnConsumedCapacity()
ReturnConsumedCapacity
public QueryRequest withReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public QueryRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public void setProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
projectionExpression
- A string that identifies one or more attributes to retrieve from the table. These attributes can include
scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by
commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
public String getProjectionExpression()
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
public QueryRequest withProjectionExpression(String projectionExpression)
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
projectionExpression
- A string that identifies one or more attributes to retrieve from the table. These attributes can include
scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by
commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
ProjectionExpression replaces the legacy AttributesToGet parameter.
public void setFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
filterExpression
- A string that contains conditions that DynamoDB applies after the Query operation, but before the
data is returned to you. Items that do not satisfy the FilterExpression criteria are not
returned. A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
public String getFilterExpression()
A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
public QueryRequest withFilterExpression(String filterExpression)
A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
filterExpression
- A string that contains conditions that DynamoDB applies after the Query operation, but before the
data is returned to you. Items that do not satisfy the FilterExpression criteria are not
returned. A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.
FilterExpression replaces the legacy QueryFilter and ConditionalOperator parameters.
public void setKeyConditionExpression(String keyConditionExpression)
The condition that specifies the key value(s) for items to be retrieved by the Query action.
The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
partitionKeyName
= :partitionkeyval
If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:
partitionKeyName
= :partitionkeyval
AND sortKeyName
=
:sortkeyval
Valid comparisons for the sort key condition are as follows:
sortKeyName
= :sortkeyval
- true if the sort key value is equal to
:sortkeyval
.
sortKeyName
< :sortkeyval
- true if the sort key value is less than
:sortkeyval
.
sortKeyName
<= :sortkeyval
- true if the sort key value is less than or equal
to :sortkeyval
.
sortKeyName
> :sortkeyval
- true if the sort key value is greater than
:sortkeyval
.
sortKeyName
>= :sortkeyval
- true if the sort key value is greater than or
equal to :sortkeyval
.
sortKeyName
BETWEEN :sortkeyval1
AND :sortkeyval2
- true if
the sort key value is greater than or equal to :sortkeyval1
, and less than or equal to
:sortkeyval2
.
begins_with ( sortKeyName
, :sortkeyval
) - true if the sort key value
begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note
that the function name begins_with
is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval
and
:sortval
with actual values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S
) to represent the attribute name Size.
KeyConditionExpression then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
KeyConditionExpression replaces the legacy KeyConditions parameter.
keyConditionExpression
- The condition that specifies the key value(s) for items to be retrieved by the Query action.
The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
partitionKeyName
= :partitionkeyval
If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:
partitionKeyName
= :partitionkeyval
AND sortKeyName
= :sortkeyval
Valid comparisons for the sort key condition are as follows:
sortKeyName
= :sortkeyval
- true if the sort key value is equal to
:sortkeyval
.
sortKeyName
< :sortkeyval
- true if the sort key value is less than
:sortkeyval
.
sortKeyName
<= :sortkeyval
- true if the sort key value is less than
or equal to :sortkeyval
.
sortKeyName
> :sortkeyval
- true if the sort key value is greater than
:sortkeyval
.
sortKeyName
>= :sortkeyval
- true if the sort key value is greater
than or equal to :sortkeyval
.
sortKeyName
BETWEEN :sortkeyval1
AND :sortkeyval2
-
true if the sort key value is greater than or equal to :sortkeyval1
, and less than or equal
to :sortkeyval2
.
begins_with ( sortKeyName
, :sortkeyval
) - true if the sort key
value begins with a particular operand. (You cannot use this function with a sort key that is of type
Number.) Note that the function name begins_with
is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval
and :sortval
with actual values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S
) to represent the attribute name
Size. KeyConditionExpression then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
KeyConditionExpression replaces the legacy KeyConditions parameter.
public String getKeyConditionExpression()
The condition that specifies the key value(s) for items to be retrieved by the Query action.
The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
partitionKeyName
= :partitionkeyval
If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:
partitionKeyName
= :partitionkeyval
AND sortKeyName
=
:sortkeyval
Valid comparisons for the sort key condition are as follows:
sortKeyName
= :sortkeyval
- true if the sort key value is equal to
:sortkeyval
.
sortKeyName
< :sortkeyval
- true if the sort key value is less than
:sortkeyval
.
sortKeyName
<= :sortkeyval
- true if the sort key value is less than or equal
to :sortkeyval
.
sortKeyName
> :sortkeyval
- true if the sort key value is greater than
:sortkeyval
.
sortKeyName
>= :sortkeyval
- true if the sort key value is greater than or
equal to :sortkeyval
.
sortKeyName
BETWEEN :sortkeyval1
AND :sortkeyval2
- true if
the sort key value is greater than or equal to :sortkeyval1
, and less than or equal to
:sortkeyval2
.
begins_with ( sortKeyName
, :sortkeyval
) - true if the sort key value
begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note
that the function name begins_with
is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval
and
:sortval
with actual values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S
) to represent the attribute name Size.
KeyConditionExpression then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
KeyConditionExpression replaces the legacy KeyConditions parameter.
The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
partitionKeyName
= :partitionkeyval
If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:
partitionKeyName
= :partitionkeyval
AND sortKeyName
= :sortkeyval
Valid comparisons for the sort key condition are as follows:
sortKeyName
= :sortkeyval
- true if the sort key value is equal to
:sortkeyval
.
sortKeyName
< :sortkeyval
- true if the sort key value is less than
:sortkeyval
.
sortKeyName
<= :sortkeyval
- true if the sort key value is less than
or equal to :sortkeyval
.
sortKeyName
> :sortkeyval
- true if the sort key value is greater
than :sortkeyval
.
sortKeyName
>= :sortkeyval
- true if the sort key value is greater
than or equal to :sortkeyval
.
sortKeyName
BETWEEN :sortkeyval1
AND :sortkeyval2
-
true if the sort key value is greater than or equal to :sortkeyval1
, and less than or equal
to :sortkeyval2
.
begins_with ( sortKeyName
, :sortkeyval
) - true if the sort key
value begins with a particular operand. (You cannot use this function with a sort key that is of type
Number.) Note that the function name begins_with
is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval
and :sortval
with actual values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S
) to represent the attribute name
Size. KeyConditionExpression then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
KeyConditionExpression replaces the legacy KeyConditions parameter.
public QueryRequest withKeyConditionExpression(String keyConditionExpression)
The condition that specifies the key value(s) for items to be retrieved by the Query action.
The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
partitionKeyName
= :partitionkeyval
If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:
partitionKeyName
= :partitionkeyval
AND sortKeyName
=
:sortkeyval
Valid comparisons for the sort key condition are as follows:
sortKeyName
= :sortkeyval
- true if the sort key value is equal to
:sortkeyval
.
sortKeyName
< :sortkeyval
- true if the sort key value is less than
:sortkeyval
.
sortKeyName
<= :sortkeyval
- true if the sort key value is less than or equal
to :sortkeyval
.
sortKeyName
> :sortkeyval
- true if the sort key value is greater than
:sortkeyval
.
sortKeyName
>= :sortkeyval
- true if the sort key value is greater than or
equal to :sortkeyval
.
sortKeyName
BETWEEN :sortkeyval1
AND :sortkeyval2
- true if
the sort key value is greater than or equal to :sortkeyval1
, and less than or equal to
:sortkeyval2
.
begins_with ( sortKeyName
, :sortkeyval
) - true if the sort key value
begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note
that the function name begins_with
is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval
and
:sortval
with actual values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S
) to represent the attribute name Size.
KeyConditionExpression then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
KeyConditionExpression replaces the legacy KeyConditions parameter.
keyConditionExpression
- The condition that specifies the key value(s) for items to be retrieved by the Query action.
The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
partitionKeyName
= :partitionkeyval
If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:
partitionKeyName
= :partitionkeyval
AND sortKeyName
= :sortkeyval
Valid comparisons for the sort key condition are as follows:
sortKeyName
= :sortkeyval
- true if the sort key value is equal to
:sortkeyval
.
sortKeyName
< :sortkeyval
- true if the sort key value is less than
:sortkeyval
.
sortKeyName
<= :sortkeyval
- true if the sort key value is less than
or equal to :sortkeyval
.
sortKeyName
> :sortkeyval
- true if the sort key value is greater than
:sortkeyval
.
sortKeyName
>= :sortkeyval
- true if the sort key value is greater
than or equal to :sortkeyval
.
sortKeyName
BETWEEN :sortkeyval1
AND :sortkeyval2
-
true if the sort key value is greater than or equal to :sortkeyval1
, and less than or equal
to :sortkeyval2
.
begins_with ( sortKeyName
, :sortkeyval
) - true if the sort key
value begins with a particular operand. (You cannot use this function with a sort key that is of type
Number.) Note that the function name begins_with
is case-sensitive.
Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval
and :sortval
with actual values at runtime.
You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
Size = :myval
To work around this, define a placeholder (such a #S
) to represent the attribute name
Size. KeyConditionExpression then is as follows:
#S = :myval
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
KeyConditionExpression replaces the legacy KeyConditions parameter.
public Map<String,String> getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. The following are some use cases for
using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public QueryRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. The following are some use cases for
using ExpressionAttributeNames:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public QueryRequest addExpressionAttributeNamesEntry(String key, String value)
public QueryRequest clearExpressionAttributeNamesEntries()
public Map<String,AttributeValue> getExpressionAttributeValues()
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public QueryRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
expressionAttributeValues
- One or more values that can be substituted in an expression.
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
public QueryRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
public QueryRequest clearExpressionAttributeValuesEntries()
public void setExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
hashKey
- a map entry including the name and value of the primary hash key.rangeKey
- a map entry including the name and value of the primary range key, or null if it is a hash-only table.IllegalArgumentException
public QueryRequest withExclusiveStartKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
Returns a reference to this object so that method calls can be chained together.
hashKey
- a map entry including the name and value of the primary hash key.rangeKey
- a map entry including the name and value of the primary range key, or null if it is a hash-only table.IllegalArgumentException
public String toString()
toString
in class Object
Object.toString()
public QueryRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2017. All rights reserved.