public class QueryRequest extends AmazonWebServiceRequest implements java.io.Serializable
A Query operation uses the primary key of a table or a secondary index to directly access items from that table or index.
Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. You can use the ScanIndexForward parameter to get results in forward or reverse order, by sort key.
Queries that do not return results consume the minimum number of read capacity units for that type of read operation.
If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the LastEvaluatedKey element to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns both an empty result set and a LastEvaluatedKey value. LastEvaluatedKey is only provided if you have used the Limit parameter, or if the result set exceeds 1 MB (prior to applying a filter).
You can query a table, a local secondary index, or a global secondary index.
For a query on a table or on a local secondary index, you can set the
ConsistentRead parameter to true
and obtain a strongly
consistent result. Global secondary indexes support eventually consistent
reads only, so do not specify ConsistentRead when querying a global
secondary index.
Constructor and Description |
---|
QueryRequest()
Default constructor for QueryRequest object.
|
QueryRequest(java.lang.String tableName)
Constructs a new QueryRequest object.
|
Modifier and Type | Method and Description |
---|---|
QueryRequest |
addExclusiveStartKeyEntry(java.lang.String key,
AttributeValue value)
The primary key of the first item that this operation will evaluate.
|
QueryRequest |
addExpressionAttributeNamesEntry(java.lang.String key,
java.lang.String value)
One or more substitution tokens for attribute names in an expression.
|
QueryRequest |
addExpressionAttributeValuesEntry(java.lang.String key,
AttributeValue value)
One or more values that can be substituted in an expression.
|
QueryRequest |
addKeyConditionsEntry(java.lang.String key,
Condition value)
|
QueryRequest |
addQueryFilterEntry(java.lang.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.
|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getAttributesToGet()
|
java.lang.String |
getConditionalOperator()
|
java.lang.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. |
java.util.Map<java.lang.String,AttributeValue> |
getExclusiveStartKey()
The primary key of the first item that this operation will evaluate.
|
java.util.Map<java.lang.String,java.lang.String> |
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
java.util.Map<java.lang.String,AttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
java.lang.String |
getFilterExpression()
A string that contains conditions that DynamoDB applies after the
Query operation, but before the data is returned to you.
|
java.lang.String |
getIndexName()
The name of an index to query.
|
java.lang.String |
getKeyConditionExpression()
The condition that specifies the key value(s) for items to be retrieved
by the Query action.
|
java.util.Map<java.lang.String,Condition> |
getKeyConditions()
|
java.lang.Integer |
getLimit()
The maximum number of items to evaluate (not necessarily the number of
matching items).
|
java.lang.String |
getProjectionExpression()
A string that identifies one or more attributes to retrieve from the
table.
|
java.util.Map<java.lang.String,Condition> |
getQueryFilter()
|
java.lang.String |
getReturnConsumedCapacity()
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
java.lang.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. |
java.lang.String |
getSelect()
The attributes to be returned in the result.
|
java.lang.String |
getTableName()
The name of the table containing the requested items.
|
int |
hashCode() |
java.lang.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. |
java.lang.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(java.util.Collection<java.lang.String> attributesToGet)
|
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
|
void |
setConditionalOperator(java.lang.String conditionalOperator)
|
void |
setConsistentRead(java.lang.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(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.
|
void |
setExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
void |
setExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
void |
setFilterExpression(java.lang.String filterExpression)
A string that contains conditions that DynamoDB applies after the
Query operation, but before the data is returned to you.
|
void |
setIndexName(java.lang.String indexName)
The name of an index to query.
|
void |
setKeyConditionExpression(java.lang.String keyConditionExpression)
The condition that specifies the key value(s) for items to be retrieved
by the Query action.
|
void |
setKeyConditions(java.util.Map<java.lang.String,Condition> keyConditions)
|
void |
setLimit(java.lang.Integer limit)
The maximum number of items to evaluate (not necessarily the number of
matching items).
|
void |
setProjectionExpression(java.lang.String projectionExpression)
A string that identifies one or more attributes to retrieve from the
table.
|
void |
setQueryFilter(java.util.Map<java.lang.String,Condition> queryFilter)
|
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
void |
setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
void |
setScanIndexForward(java.lang.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(java.lang.String select)
The attributes to be returned in the result.
|
void |
setTableName(java.lang.String tableName)
The name of the table containing the requested items.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
QueryRequest |
withAttributesToGet(java.util.Collection<java.lang.String> attributesToGet)
|
QueryRequest |
withAttributesToGet(java.lang.String... attributesToGet)
|
QueryRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
|
QueryRequest |
withConditionalOperator(java.lang.String conditionalOperator)
|
QueryRequest |
withConsistentRead(java.lang.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(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)
The primary key of the first item that this operation will evaluate.
|
QueryRequest |
withExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
QueryRequest |
withExpressionAttributeValues(java.util.Map<java.lang.String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
QueryRequest |
withFilterExpression(java.lang.String filterExpression)
A string that contains conditions that DynamoDB applies after the
Query operation, but before the data is returned to you.
|
QueryRequest |
withIndexName(java.lang.String indexName)
The name of an index to query.
|
QueryRequest |
withKeyConditionExpression(java.lang.String keyConditionExpression)
The condition that specifies the key value(s) for items to be retrieved
by the Query action.
|
QueryRequest |
withKeyConditions(java.util.Map<java.lang.String,Condition> keyConditions)
|
QueryRequest |
withLimit(java.lang.Integer limit)
The maximum number of items to evaluate (not necessarily the number of
matching items).
|
QueryRequest |
withProjectionExpression(java.lang.String projectionExpression)
A string that identifies one or more attributes to retrieve from the
table.
|
QueryRequest |
withQueryFilter(java.util.Map<java.lang.String,Condition> queryFilter)
|
QueryRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
QueryRequest |
withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption
that is returned in the response:
|
QueryRequest |
withScanIndexForward(java.lang.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(java.lang.String select)
The attributes to be returned in the result.
|
QueryRequest |
withTableName(java.lang.String tableName)
The name of the table containing the requested items.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public QueryRequest()
public QueryRequest(java.lang.String tableName)
tableName
- The name of the table containing the requested items.
public java.lang.String getTableName()
The name of the table containing the requested items.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
The name of the table containing the requested items.
public void setTableName(java.lang.String tableName)
The name of the table containing the requested items.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table containing the requested items.
public QueryRequest withTableName(java.lang.String tableName)
The name of the table containing the requested items.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName
- The name of the table containing the requested items.
public java.lang.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.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
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 setIndexName(java.lang.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.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
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 QueryRequest withIndexName(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
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 java.lang.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.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES,
SPECIFIC_ATTRIBUTES, COUNT
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(java.lang.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.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES,
SPECIFIC_ATTRIBUTES, COUNT
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(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES,
SPECIFIC_ATTRIBUTES, COUNT
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.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES,
SPECIFIC_ATTRIBUTES, COUNT
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES,
SPECIFIC_ATTRIBUTES, COUNT
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 java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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(java.util.Collection<java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.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.
Constraints:
Range: 1 -
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 setLimit(java.lang.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.
Constraints:
Range: 1 -
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 QueryRequest withLimit(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 -
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 java.lang.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.
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 java.lang.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.
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 void setConsistentRead(java.lang.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 QueryRequest withConsistentRead(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.util.Map<java.lang.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(java.util.Map<java.lang.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(java.util.Map<java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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(java.lang.String key, Condition value)
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.
The method adds a new key-value pair into KeyConditions parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into KeyConditions.value
- The corresponding value of the entry to be added into
KeyConditions.public QueryRequest clearKeyConditionsEntries()
Returns a reference to this object so that method calls can be chained together.
public java.util.Map<java.lang.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(java.util.Map<java.lang.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(java.util.Map<java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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(java.lang.String key, Condition value)
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.
The method adds a new key-value pair into QueryFilter parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into QueryFilter.value
- The corresponding value of the entry to be added into
QueryFilter.public QueryRequest clearQueryFilterEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.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.
Constraints:
Allowed Values: AND, OR
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(java.lang.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.
Constraints:
Allowed Values: AND, OR
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(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
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.
Constraints:
Allowed Values: AND, OR
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
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 java.lang.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.
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 java.lang.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.
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 void setScanIndexForward(java.lang.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 QueryRequest withScanIndexForward(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.util.Map<java.lang.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 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 void setExclusiveStartKey(java.util.Map<java.lang.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(java.util.Map<java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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(java.lang.String key, AttributeValue value)
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 method adds a new key-value pair into ExclusiveStartKey parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into ExclusiveStartKey.value
- The corresponding value of the entry to be added into
ExclusiveStartKey.public QueryRequest clearExclusiveStartKeyEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String getReturnConsumedCapacity()
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
ReturnConsumedCapacity
public void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
ReturnConsumedCapacity
public QueryRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
ReturnConsumedCapacity
public QueryRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity
- Determines the level of detail about provisioned throughput consumption that is returned in the response:
INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.
Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.
ReturnConsumedCapacity
public java.lang.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.
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 setProjectionExpression(java.lang.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 QueryRequest withProjectionExpression(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.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 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 setFilterExpression(java.lang.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 QueryRequest withFilterExpression(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.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 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 void setKeyConditionExpression(java.lang.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 QueryRequest withKeyConditionExpression(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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 java.util.Map<java.lang.String,java.lang.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.
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 void setExpressionAttributeNames(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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(java.lang.String key, java.lang.String value)
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.
The method adds a new key-value pair into ExpressionAttributeNames parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into
ExpressionAttributeNames.value
- The corresponding value of the entry to be added into
ExpressionAttributeNames.public QueryRequest clearExpressionAttributeNamesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.util.Map<java.lang.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.
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 void setExpressionAttributeValues(java.util.Map<java.lang.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(java.util.Map<java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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(java.lang.String key, AttributeValue value)
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.
The method adds a new key-value pair into ExpressionAttributeValues parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into
ExpressionAttributeValues.value
- The corresponding value of the entry to be added into
ExpressionAttributeValues.public QueryRequest clearExpressionAttributeValuesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.