Represents a request to query items in a DynamoDB table using the Document Model. This class introduces a modern expression-based API that replaces legacy parameter-based approaches. Legacy parameters such as QueryFilter, AttributesToGet are not supported. Use KeyConditionExpression, FilterExpression, and ProjectionExpression instead.
In this article ▶
Inheritance Hierarchy
Amazon.DynamoDBv2.DocumentModel.DocumentOperationRequest
Amazon.DynamoDBv2.DocumentModel.QueryDocumentOperationRequest
Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
Syntax
public class QueryDocumentOperationRequest : DocumentOperationRequest
The QueryDocumentOperationRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
QueryDocumentOperationRequest() |
Initializes a new instance of the Amazon.DynamoDBv2.DocumentModel.QueryDocumentOperationRequest class. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BackwardSearch | System.Boolean |
Flag that signals if the search is traversing backwards |
|
|
CollectResults | System.Boolean |
Whether to collect GetNextSet and GetRemaining results in Matches property. Default is true. If set to false, Matches will always be empty. |
|
|
ConsistentRead | System.Boolean |
Gets or sets the consistent read flag. |
|
|
FilterExpression | Amazon.DynamoDBv2.DocumentModel.Expression |
Gets or sets the filter expression specifying which items should be returned. |
|
|
IndexName | System.String |
Gets or sets the index name to query against. |
|
|
KeyConditionExpression | Amazon.DynamoDBv2.DocumentModel.Expression |
Gets or sets the key condition expression specifying which items should be returned. |
|
|
Limit | System.Int32 |
Gets or sets the maximum number of items to return. |
|
|
PaginationToken | System.String |
Pagination token corresponding to the item where the last Query operation stopped, inclusive of the previous result set. Set this value to resume Query operation from the next item. This token should be retrieved from a Search object. |
|
|
ProjectionExpression | Amazon.DynamoDBv2.DocumentModel.Expression |
Gets or sets the projection expression specifying which attributes should be retrieved. |
|
|
Select | Amazon.DynamoDBv2.DocumentModel.SelectValues |
Enum specifying what data to return from query. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer