Container for the parameters to the Query operation.
Namespace: Amazon.DynamoDB.ModelGets the values of one or more items and its attributes by primary key (composite primary key, only).
Narrow the scope of the query using comparison operators on the RangeKeyValue of the composite key. Use the ScanIndexForward parameter to get results in forward or reverse order by range key.
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)
Syntax
| C# | Visual Basic | Visual C++ |
public class QueryRequest : AmazonWebServiceRequest
Public Class QueryRequest _ Inherits AmazonWebServiceRequest
public ref class QueryRequest : public AmazonWebServiceRequest
Members
| All Members | Constructors  | Properties  | Methods |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| QueryRequest()()()() | Initializes a new instance of the QueryRequest class |
| AttributesToGet |
List of Attribute names. If attribute names are not specified then all attributes will be returned. If some attributes are not found,
they will not appear in the result.
Constraints: |
| ConsistentRead |
If set to true, then a consistent read is issued. Otherwise eventually-consistent is used.
|
| Count |
If set to true, Amazon DynamoDB returns a total number of items that match the query parameters, instead of a list of the matching
items and their attributes. Do not set Count to true while providing a list of AttributesToGet, otherwise Amazon
DynamoDB returns a validation error.
|
| Equals(Object) | (Inherited from Object.) |
| ExclusiveStartKey |
Primary key of the item from which to continue an earlier query. An earlier query might provide this value as the LastEvaluatedKey if
that query operation was interrupted before completing the query; either because of the result set size or the Limit parameter. The
LastEvaluatedKey can be passed back in a new query request to continue the operation from that point.
|
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| HashKeyValue |
Attribute value of the hash component of the composite primary key.
|
| Limit |
The maximum number of items to return. If Amazon DynamoDB hits this limit while querying the table, it stops the query and returns the
matching values up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to continue the query. Also, if the result
set size exceeds 1MB before Amazon DynamoDB hits this limit, it stops the query and returns the matching values, and a
LastEvaluatedKey to apply in a subsequent operation to continue the query.
Constraints: |
| RangeKeyCondition |
A container for the attribute values and comparison operators to use for the query.
|
| ScanIndexForward |
Specifies forward or backward traversal of the index. Amazon DynamoDB returns results reflecting the requested order, determined by the
range key. The default value is true (forward).
|
| TableName |
The name of the table in which you want to query. Allowed characters are a-z, A-Z, 0-9, _ (underscore), -
(hyphen) and . (period).
Constraints: |
| ToString()()()() | (Inherited from Object.) |
| WithAttributesToGet(IEnumerable<(Of <<'(String>)>>)) |
Adds elements to the AttributesToGet collection
|
| WithAttributesToGet(array<String>[]()[][]) |
Adds elements to the AttributesToGet collection
|
| WithConsistentRead(Boolean) |
Sets the ConsistentRead property
|
| WithCount(Boolean) |
Sets the Count property
|
| WithExclusiveStartKey(Key) |
Sets the ExclusiveStartKey property
|
| WithHashKeyValue(AttributeValue) |
Sets the HashKeyValue property
|
| WithLimit(Int32) |
Sets the Limit property
|
| WithRangeKeyCondition(Condition) |
Sets the RangeKeyCondition property
|
| WithScanIndexForward(Boolean) |
Sets the ScanIndexForward property
|
| WithTableName(String) |
Sets the TableName property
|
Inheritance Hierarchy
System..::..Object
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.DynamoDB.Model..::..QueryRequest
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.DynamoDB.Model..::..QueryRequest
See Also
