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.
Methods
(inner) getAll(request) → {Promise}
- Source:
- See:
Returns all items in a table or a secondary index. This uses Scan internally.
Example
await getAll({ TableName: 'SomeTable' });
// Will return all items in `SomeTable`Parameters:
| Name | Type | Description |
|---|---|---|
request |
Object | Parameters as expected by DynamoDB |
Returns:
A promise that resolves to an array of Items returned by the DynamoDB response
- Type
- Promise
(inner) getAllFor(tableName, requestopt) → {Promise}
- Source:
- See:
Returns a function that returns all items in a table or a secondary index. This uses Scan internally.
You would typically use this function through forTable.
Example
await getAllFor('SomeTable')({ Limit: 10 });
// Will return first 10 items in `SomeTable`Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
tableName |
The name of the table to perform the operation on. This will override any |
||
request |
Object |
<optional> |
Parameters as expected by DynamoDB |
Returns:
A promise that resolves to an array of Items returned by the DynamoDB response
- Type
- Promise