couchbase
    Preparing search index...

    Interface ScanOptions

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

    Properties

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

    Properties

    batchByteLimit?: number

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

    batchItemLimit?: number

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

    concurrency?: number

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

    consistentWith?: MutationState

    Specifies a MutationState which the scan should be consistent with.

    MutationState

    idsOnly?: boolean

    If the scan should only return document ids.

    timeout?: number

    The timeout for this operation, represented in milliseconds.

    transcoder?: Transcoder

    Specifies an explicit transcoder to use for this specific operation.

    Settings

    Member Visibility

    On This Page

    Properties