Table of Contents

Class ScanOperationConfig

Namespace
Amazon.DynamoDBv2.DocumentModel
Assembly
AWSSDK.DynamoDBv2.dll

Configuration for the Table.Scan operation

public class ScanOperationConfig
Inheritance
ScanOperationConfig
Inherited Members

Constructors

ScanOperationConfig()

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

public ScanOperationConfig()

Properties

AttributesToGet

List of attributes to retrieve as part of the search

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

Property Value

List<string>

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 ScanFilter Filter { get; set; }

Property Value

ScanFilter

FilterExpression

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

public Expression FilterExpression { get; set; }

Property Value

Expression

IndexName

Name of the index to scan against.

public string IndexName { get; set; }

Property Value

string

Limit

Upper limit on the number of items scanned per request for matching conditions.

public int Limit { get; set; }

Property Value

int

PaginationToken

Pagination token corresponding to the item where the last Scan operation stopped, inclusive of the previous result set. Set this value to resume Scan operation from the next item. This token should be retrieved from a Search object.

public string PaginationToken { get; set; }

Property Value

string

Segment

For parallel Scan requests, Segment identifies an individual segment to be scanned by an application "worker" (such as a thread or a process). Each worker issues a Scan request with a distinct value for the segment it will scan. Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread would specify a Segment value of 0, the second thread would specify 1, and so on. LastEvaluatedKey returned from a parallel scan request must be used with same Segment id in a subsequent operation. The value for Segment must be less than or equal to 0, and less than the value provided for TotalSegments. If you specify Segment, you must also specify TotalSegments.

Constraints:

public int Segment { get; set; }

Property Value

int

Select

Enum specifying what data to return from query.

public SelectValues Select { get; set; }

Property Value

SelectValues

TotalSegments

For parallel Scan requests, TotalSegmentsrepresents the total number of segments for a table that is being scanned. Segments are a way to logically divide a table into equally sized portions, for the duration of the Scan request. The value of TotalSegments corresponds to the number of application "workers" (such as threads or processes) that will perform the parallel Scan. For example, if you want to scan a table using four application threads, you would specify a TotalSegments value of 4. The value for TotalSegments must be greater than or equal to 1, and less than or equal to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential rather than parallel. If you specify TotalSegments, you must also specify Segment.

Constraints:

public int TotalSegments { get; set; }

Property Value

int