AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Configuration for the Table.Query operation

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DocumentModel.QueryOperationConfig

Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

C#
public class QueryOperationConfig

The QueryOperationConfig type exposes the following members

Constructors

NameDescription
Public Method QueryOperationConfig()

Initializes a default Table.Query config object Filter is empty, Limit is Int32.MaxValue

Properties

NameTypeDescription
Public Property AttributesToGet System.Collections.Generic.List<System.String>

List of attributes to retrieve as part of the search

Public Property BackwardSearch System.Boolean

Flag that signals if the search is traversing backwards

Public Property 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.

Public Property ConditionalOperator Amazon.DynamoDBv2.DocumentModel.ConditionalOperatorValues

A logical operator to apply to the conditions in the Filter property: AND - If all of the conditions evaluate to true, then the entire filter evaluates to true. OR - If at least one of the conditions evaluate to true, then the entire filter evaluates to true. Default value is AND.

Public Property ConsistentRead System.Boolean

If set to true, this flag ensures that the most recently written data is returned.

Public Property Filter Amazon.DynamoDBv2.DocumentModel.QueryFilter

Filter for the search operation

Public Property FilterExpression Amazon.DynamoDBv2.DocumentModel.Expression

The expression that is evaluated for each item. Only items that pass the expression are returned.

Both KeyExpression and FilterExpression contain ExpressionAttributeNames and ExpressionAttributeValues. Attribute names or values can be added to either expression and can be referenced in either expression statement. Conflicting attribute names or values will lead to an exception being thrown.

Public Property IndexName System.String

Name of the index to query against.

Public Property KeyExpression Amazon.DynamoDBv2.DocumentModel.Expression

The key expression that is evaluated for each item. Only items that pass the expression are returned.

Both KeyExpression and FilterExpression contain ExpressionAttributeNames and ExpressionAttributeValues. Attribute names or values can be added to either expression and can be referenced in either expression statement. Conflicting attribute names or values will lead to an exception being thrown.

Public Property Limit System.Int32

Upper limit on the number of items to return per request

Public Property 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.

Public Property Select Amazon.DynamoDBv2.DocumentModel.SelectValues

Enum specifying what data to return from query.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone