You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -250,7 +250,7 @@ const MyTable = new Table({
250
250
| alias |`string`| no | An optional alias to reference your table when using "batch" features |
251
251
| partitionKey |`string`| yes | The attribute name of your table's partitionKey |
252
252
| sortKey |`string`| no | The attribute name of your table's sortKey |
253
-
| entityField |`boolean` or `string`| no | Disables or overrides entity tracking field name (default: `_tp`) |
253
+
| entityField |`boolean` or `string`| no | Disables or overrides entity tracking field name (default: `_et`) |
254
254
| attributes |`object`| no | Complex type that optionally specifies the name and type of each attributes (see below) |
255
255
| indexes |`object`| no | Complex type that optionally specifies the name keys of your secondary indexes (see below) |
256
256
| autoExecute |`boolean`| no | Enables automatic execution of the DocumentClient method (default: `true`) |
@@ -290,7 +290,7 @@ indexes: {
290
290
}
291
291
```
292
292
293
-
**NOTE:** The **index name** must match the index name on your table as it will be used in queries and other operations.
293
+
**NOTE:** The **index name** must match the index name on your table as it will be used in queries and other operations. The index must include the table's `entityField` attribute for automatic parsing of returned data.
294
294
295
295
## Entities
296
296
@@ -503,7 +503,7 @@ The second argument is an `options` object that specifies the details of your qu
503
503
504
504
| Option | Type | Description |
505
505
| -------- | :--: | ----------- |
506
-
| index |`string`| Name of secondary index to query. If not specified, the query executes on the primary index. (IndexName) |
506
+
| index |`string`| Name of secondary index to query. 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) |
507
507
| limit |`number`| The maximum number of items to retrieve per query. (Limit) |
508
508
| reverse |`boolean`| Reverse the order or returned items. (ScanIndexForward) |
509
509
| consistent |`boolean`| Enable a consistent read of the items (ConsistentRead) |
0 commit comments