Class QueryOperationConfig

Namespace

Amazon.DynamoDBv2.DocumentModel

Assembly

AWSSDK.DynamoDBv2.dll

Configuration for the Table.Query operation

public class QueryOperationConfig

Inheritance

object

QueryOperationConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

QueryOperationConfig()

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

public QueryOperationConfig()

Properties

AttributesToGet

List of attributes to retrieve as part of the search

public List<string> AttributesToGet { get; set; }

Property Value

List<string>

BackwardSearch

Flag that signals if the search is traversing backwards

public bool BackwardSearch { get; set; }

Property Value

bool

CollectResults

Whether to collect GetNextSet and GetRemaining results in Matches property. Default is true. If set to false, Matches will always be empty.

public bool CollectResults { get; set; }

Property Value

bool

ConditionalOperator

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 ConditionalOperatorValues ConditionalOperator { get; set; }

Property Value

ConditionalOperatorValues

ConsistentRead

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

public bool ConsistentRead { get; set; }

Property Value

bool

Filter

Filter for the search operation

public QueryFilter Filter { get; set; }

Property Value

QueryFilter

FilterExpression

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 Expression FilterExpression { get; set; }

Property Value

Expression

IndexName

Name of the index to query against.

public string IndexName { get; set; }

Property Value

string

KeyExpression

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 Expression KeyExpression { get; set; }

Property Value

Expression

Limit

Upper limit on the number of items to return per request

public int Limit { get; set; }

Property Value

int

PaginationToken

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 string PaginationToken { get; set; }

Property Value

string

Select

Enum specifying what data to return from query.

public SelectValues Select { get; set; }

Property Value

SelectValues