Interface ScanOptions

interface ScanOptions {
    batchByteLimit?: number;
    batchItemLimit?: number;
    concurrency?: number;
    consistentWith?: MutationState;
    idsOnly?: boolean;
    timeout?: number;
    transcoder?: Transcoder;
}

Properties

batchByteLimit? batchItemLimit? concurrency? consistentWith? idsOnly? timeout? transcoder?

Properties

Optional batchByteLimit

batchByteLimit?: number

The limit applied to the number of bytes returned from the server for each partition batch.

Optional batchItemLimit

batchItemLimit?: number

The limit applied to the number of items returned from the server for each partition batch.

Optional concurrency

concurrency?: number

Specifies the number of vBuckets which the client should scan in parallel.

Optional consistentWith

consistentWith?: MutationState

Specifies a MutationState which the scan should be consistent with.

See

MutationState

Optional idsOnly

idsOnly?: boolean

If the scan should only return document ids.

Optional timeout

timeout?: number

The timeout for this operation, represented in milliseconds.

Optional transcoder

transcoder?: Transcoder

Specifies an explicit transcoder to use for this specific operation.

Settings

Member Visibility

Theme

On This Page

batchByteLimitbatchItemLimitconcurrencyconsistentWithidsOnlytimeouttranscoder