Configuration for the Table.Scan operation
Declaration Syntax| C# |
public class ScanOperationConfig
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | ScanOperationConfig()()()() |
Initializes a default Table.Scan config object
Filter is empty, Limit is Int32.MaxValue
|
 | AttributesToGet |
List of attributes to retrieve as part of the search
|
| CollectResults |
Whether to collect GetNextSet and GetRemaining results in Matches property.
Default is true. If set to false, Matches will always be empty.
|
| 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.
|
| Equals(Object) | (Inherited from Object.) |
| Filter |
Filter for the search operation
|
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| Limit |
Upper limit on the number of items scanned per request
for matching conditions.
|
| 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: |
| Select |
Enum specifying what data to return from query.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| 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: |
Inheritance Hierarchy| Object | |
 | ScanOperationConfig |