Scan(params)

Scan handle for constructing filter expressions

new Scan(params)

Create an iterator instance.
Parameters:
Name Type Description
params Object
Properties
Name Type Description
ModelCls Class The model class.
writeBatcher __WriteBatcher An instance of __WriteBatcher
options Object Iterator options
Properties:
Name Type Attributes Default Description
params.options.inconsistentRead Boolean <optional>
false When true, a strongly consistent read is performed. Note: Consistent read(inconsistentRead=false) only available when query or scan is performed on Model or LocalSecondaryIndex. To retrieve more recent results when scanning GlobalSecondaryIndex, enabling `bypassCache` instead.
params.options.shardIndex Number <optional>
Only available in scan. Distributed scan is supported by dynamodb, where multiple machines can scan non-overlapping sections of the database in parallel, boosting the throughput of a database scan. ShardIndex denotes the shard where the scan should be performed on.
params.options.shardCount Number <optional>
Only available in scan. Distributed scan is supported by dynamodb, where multiple machines can scan non-overlapping sections of the database in parallel, boosting the throughput of a database scan. ShardCount controls the number of shards in a distributed scan.
params.options.bypassCache Boolean <optional>
false DAX stores `Scan` and `Query` request results in its query cache, and the cache is not invalidated by DynamoDB updates. Set this to true to skip the DAX cache for more up-to-date results.
params.options.cacheModels Boolean <optional>
false Whether to cache models already retrieved from the database. When off, getting a model with the same key the second time in the same transaction results in an error. When on, `get`ting the same key simply returns the cached model. Previous modifications done to the model are reflected in the returned model.