AWS SDK Version 4 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.

Input for the Query operation in the object-persistence programming model

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DataModel.BaseOperationConfig
    Amazon.DynamoDBv2.DataModel.QueryConfig

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

Syntax

C#
public class QueryConfig : BaseOperationConfig

The QueryConfig type exposes the following members

Constructors

NameDescription
Public Method QueryConfig()

Properties

NameTypeDescription
Public Property BackwardQuery System.Nullable<System.Boolean>

Indicates whether a query should traverse the index backwards in descending order by range key value. If the property is false (or not set), traversal shall be in ascending order.

Public Property ConditionalOperator Amazon.DynamoDBv2.DocumentModel.ConditionalOperatorValues

The logical operator to apply to the filter conditions.

Public Property ConsistentRead System.Nullable<System.Boolean>

Property that directs Amazon.DynamoDBv2.DataModel.DynamoDBContext to use consistent reads. If property is not set, behavior defaults to non-consistent reads.

Public Property Conversion Amazon.DynamoDBv2.DynamoDBEntryConversion Inherited from Amazon.DynamoDBv2.DataModel.BaseOperationConfig.
Public Property IndexName System.String

Indicates the name of the index to query against. This value is optional if the index name can be inferred from the call.

Public Property IsEmptyStringValueEnabled System.Nullable<System.Boolean> Inherited from Amazon.DynamoDBv2.DataModel.BaseOperationConfig.
Public Property OverrideTableName System.String Inherited from Amazon.DynamoDBv2.DataModel.BaseOperationConfig.
Public Property QueryFilter System.Collections.Generic.List<Amazon.DynamoDBv2.DataModel.ScanCondition>

Query filter for the Query operation. Evaluates the query results and returns only the matching values. If you specify more than one condition, then by default all of the conditions must evaluate to true. To match only some conditions, set Amazon.DynamoDBv2.DataModel.QueryConfig.ConditionalOperator to Amazon.DynamoDBv2.DocumentModel.ConditionalOperatorValues.Or.

Public Property RetrieveDateTimeInUtc System.Nullable<System.Boolean>

If true, all System.DateTime properties are retrieved in UTC timezone while reading data from DynamoDB. Else, the local timezone is used.

Public Property TableNamePrefix System.String Inherited from Amazon.DynamoDBv2.DataModel.BaseOperationConfig.

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