@aws-sdk/lib-dynamodb 3.850.0 → 3.856.0

package/README.md

@@ -303,6 +303,77 @@ await impreciseClient.send(
 );
 ```
 
+### Example: performing a full table scan
+
+Before performing a full table scan, consider whether your query can be satisfied by a more efficient operation.
+For instance, if you are searching for a set of rows by primary keys, `BatchGetItem` may be better.
+
+First, initialize the base Client and Document Client.
+
+```ts
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient, paginateScan, ScanCommand } from "@aws-sdk/lib-dynamodb";
+
+const client = new DynamoDBClient({
+  region: "us-west-2",
+});
+
+const docClient = DynamoDBDocumentClient.from(client);
+
+const paginatorConfiguration = {
+  client: docClient,
+};
+
+/**
+ * This is a function so as to create
+ * separate objects per request.
+ *
+ * The objects passed into AWS SDK Command instances
+ * are retained as references, so this prevents unexpected mutations.
+ */
+const scanRequestInput = () => ({
+  TableName: "YOUR_TABLE_NAME",
+  Limit: 100,
+});
+```
+
+The recommended way to iterate the scan is with our library's paginator helper function.
+
+```ts
+// Recommended method, using the AWS SDK paginator:
+let pageNumber = 1;
+for await (const page of paginateScan(paginatorConfiguration, scanRequestInput())) {
+  console.log("page:", pageNumber++);
+  console.log(page.Items);
+}
+```
+
+Alternatively, the equivalent manual method, which is exactly what the paginator function
+is doing internally, is with a loop utilizing the pagination token from the responses:
+
+```ts
+// Manual method, using the ScanCommand and pagination token:
+let pageNumber = 1;
+const firstPage = await docClient.send(new ScanCommand(scanRequestInput()));
+console.log("page:", pageNumber++);
+console.log(firstPage.Items);
+
+let paginationToken = firstPage.LastEvaluatedKey;
+
+while (paginationToken) {
+  const page = await docClient.send(
+    new ScanCommand({
+      ...scanRequestInput(),
+      ExclusiveStartKey: paginationToken,
+    })
+  );
+  paginationToken = page.LastEvaluatedKey;
+
+  console.log("page:", pageNumber++);
+  console.log(page.Items);
+}
+```
+
 ### Client and Command middleware stacks
 
 As with other AWS SDK for JavaScript v3 clients, you can apply middleware functions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/lib-dynamodb",
-  "version": "3.850.0",
+  "version": "3.856.0",
   "description": "The document client simplifies working with items in Amazon DynamoDB by abstracting away the notion of attribute values.",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -30,18 +30,18 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/core": "3.846.0",
-    "@aws-sdk/util-dynamodb": "3.848.0",
+    "@aws-sdk/core": "3.856.0",
+    "@aws-sdk/util-dynamodb": "3.856.0",
     "@smithy/core": "^3.7.0",
     "@smithy/smithy-client": "^4.4.7",
     "@smithy/types": "^4.3.1",
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@aws-sdk/client-dynamodb": "^3.848.0"
+    "@aws-sdk/client-dynamodb": "^3.856.0"
   },
   "devDependencies": {
-    "@aws-sdk/client-dynamodb": "3.848.0",
+    "@aws-sdk/client-dynamodb": "3.856.0",
     "@tsconfig/recommended": "1.0.1",
     "@types/node": "^18.19.69",
     "concurrently": "7.0.0",