Skip to content

Commit 105cbe7

Browse files
authored
Add index entityField info to scan dcs
1 parent fcfe5fa commit 105cbe7

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ The `scan()` method accepts two arguments. The first argument is an `options` ob
552552

553553
| Option | Type | Description |
554554
| -------- | :--: | ----------- |
555-
| index | `string` | Name of secondary index to scan. If not specified, the query executes on the primary index. (IndexName) |
555+
| index | `string` | Name of secondary index to scan. If not specified, the query executes on the primary index. The index must include the table's `entityField` attribute for automatic parsing of returned data. (IndexName) |
556556
| limit | `number` | The maximum number of items to retrieve per scan. (Limit) |
557557
| consistent | `boolean` | Enable a consistent read of the items (ConsistentRead) |
558558
| capacity | `string` | Return the amount of consumed capacity. One of either `none`, `total`, or `indexes` (ReturnConsumedCapacity) |

0 commit comments

Comments
 (0)