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.
The Scan operation returns one or more items and item attributes by accessing
every item in a table or a secondary index. To have DynamoDB return fewer items, you
can provide a FilterExpression operation.
If the total size of scanned items exceeds the maximum dataset size limit of 1 MB,
the scan completes and results are returned to the user. The LastEvaluatedKey
value is also returned and the requestor can use the LastEvaluatedKey to continue
the scan in a subsequent operation. Each scan response also includes number of items
that were scanned (ScannedCount) as part of the request. If using a FilterExpression,
a scan result can result in no items meeting the criteria and the Count will
result in zero. If you did not use a FilterExpression in the scan request,
then Count is the same as ScannedCount.
Count and ScannedCount only return the count of items specific to a
single scan request and, unless the table is less than 1MB, do not represent the total
number of items in the table.
A single Scan operation first reads up to the maximum number of items set (if
using the Limit parameter) or a maximum of 1 MB of data and then applies any
filtering to the results if a FilterExpression is provided. If LastEvaluatedKey
is present in the response, pagination is required to complete the full table scan.
For more information, see Paginating
the Results in the Amazon DynamoDB Developer Guide.
Scan operations proceed sequentially; however, for faster performance on a
large table or secondary index, applications can request a parallel Scan operation
by providing the Segment and TotalSegments parameters. For more information,
see Parallel
Scan in the Amazon DynamoDB Developer Guide.
By default, a Scan uses eventually consistent reads when accessing the items
in a table. Therefore, the results from an eventually consistent Scan may not
include the latest item changes at the time the scan iterates through each item in
the table. If you require a strongly consistent read of each item as the scan iterates
through the items in the table, you can set the ConsistentRead parameter to
true. Strong consistency only relates to the consistency of the read at the item level.
DynamoDB does not provide snapshot isolation for a scan operation when the ConsistentRead
parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that
all reads in a scan see a consistent snapshot of the table when the scan operation
was requested.
For .NET Core this operation is only available in asynchronous form. Please refer to ScanAsync.
Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
public virtual ScanResponse Scan( ScanRequest request )
Container for the necessary parameters to execute the Scan service method.
| Exception | Condition |
|---|---|
| InternalServerErrorException | An error occurred on the server side. |
| ProvisionedThroughputExceededException | The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide. |
| RequestLimitExceededException | Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase. |
| ResourceNotFoundException | The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE. |
| ThrottlingException | The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception. |
The following example shows how to scan items in a table.
Note: the Scan operation goes through every item in the table
to check if the item matches all the scan conditions. This makes
the Scan operation particularly slow and expensive (in terms of provisioned throughput).
We will now retrieve all items where the Pages attribute is greater
than the numerical value "200" and where the Title attribute contains
the string "Adventures".
// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
// Define scan conditions
Dictionary<string, Condition> conditions = new Dictionary<string, Condition>();
// Title attribute should contain the string "Adventures"
Condition titleCondition = new Condition();
titleCondition.ComparisonOperator = ComparisonOperator.CONTAINS;
titleCondition.AttributeValueList.Add(new AttributeValue { S = "Adventures" });
conditions["Title"] = titleCondition;
// Pages attributes must be greater-than the numeric value "200"
Condition pagesCondition = new Condition();
pagesCondition.ComparisonOperator = ComparisonOperator.GT;
pagesCondition.AttributeValueList.Add(new AttributeValue { N = "200" });
conditions["Pages"] = pagesCondition;
// Define marker variable
Dictionary<string, AttributeValue> startKey = null;
do
{
// Create Scan request
ScanRequest request = new ScanRequest
{
TableName = "SampleTable",
ExclusiveStartKey = startKey,
ScanFilter = conditions
};
// Issue request
ScanResult result = client.Scan(request);
// View all returned items
List<Dictionary<string, AttributeValue>> items = result.Items;
foreach (Dictionary<string, AttributeValue> item in items)
{
Console.WriteLine("Item:");
foreach (var keyValuePair in item)
{
Console.WriteLine("{0} : S={1}, N={2}, SS=[{3}], NS=[{4}]",
keyValuePair.Key,
keyValuePair.Value.S,
keyValuePair.Value.N,
string.Join(", ", keyValuePair.Value.SS ?? new List<string>()),
string.Join(", ", keyValuePair.Value.NS ?? new List<string>()));
}
}
// Set marker variable
startKey = result.LastEvaluatedKey;
} while (startKey != null && startKey.Count > 0);
The following example shows how we can utilize parallel scan to partition a table into
10 segments and scan each segment in a separate thread.
To avoid resource contention between threads, the results will be written into 10 separate
files. Each segment will have a file of its own.
// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
// Define scan conditions
Dictionary<string, Condition> conditions = new Dictionary<string, Condition>();
// Pages attributes must be greater-than the numeric value "200"
Condition pagesCondition = new Condition();
pagesCondition.ComparisonOperator = ComparisonOperator.GT;
pagesCondition.AttributeValueList.Add(new AttributeValue { N = "200" });
conditions["Pages"] = pagesCondition;
// Setup 10 simultaneous threads, each thread calling Scan operation
// with its own segment value.
int totalSegments = 10;
Parallel.For(0, totalSegments, segment =>
{
// Define marker variable
Dictionary<string, AttributeValue> startKey = null;
do
{
// Create Scan request
ScanRequest request = new ScanRequest
{
TableName = "SampleTable",
ExclusiveStartKey = startKey,
ScanFilter = conditions,
// Total segments to split the table into
TotalSegments = totalSegments,
// Current segment to scan
Segment = segment
};
// Issue request
var result = client.Scan(request);
// Write returned items to file
string path = string.Format("ParallelScan-{0}-of-{1}.txt", totalSegments, segment);
List<Dictionary<string, AttributeValue>> items = result.Items;
using (Stream stream = File.OpenWrite(path))
using (StreamWriter writer = new StreamWriter(stream))
{
foreach (Dictionary<string, AttributeValue> item in items)
{
writer.WriteLine("Item:");
foreach (var keyValuePair in item)
{
writer.WriteLine("{0} : S={1}, N={2}, SS=[{3}], NS=[{4}]",
keyValuePair.Key,
keyValuePair.Value.S,
keyValuePair.Value.N,
string.Join(", ", keyValuePair.Value.SS ?? new List<string>()),
string.Join(", ", keyValuePair.Value.NS ?? new List<string>()));
}
}
}
// Set marker variable
startKey = result.LastEvaluatedKey;
} while (startKey != null && startKey.Count > 0);
});
.NET Framework:
Supported in: 4.5 and newer, 3.5