couchbase/dist/rangeScan.js

The official Couchbase Node.js Client Library.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.PrefixScan = exports.SamplingScan = exports.RangeScan = exports.ScanTerm = void 0;
/**
 * Represents a search term for a RangeScan.
 *
 * @see {@link RangeScan}
 * @category Key-Value
 */
class ScanTerm {
    /**
     * @internal
     */
    constructor(term, exclusive) {
        this.term = term;
        this.exclusive = exclusive;
    }
}
exports.ScanTerm = ScanTerm;
/**
 * A RangeScan performs a scan on a range of keys with the range specified through
 * a start and end ScanTerm.
 *
 * @category Key-Value
 */
class RangeScan {
    /**
     * @internal
     */
    constructor(start, end) {
        this.start = start;
        this.end = end;
    }
    /**
     * Returns string representation of scan type.
     */
    getScanType() {
        return 'range_scan';
    }
}
exports.RangeScan = RangeScan;
/**
 * A SamplingScan performs a scan on a random sampling of keys with the sampling bounded by
 * a limit.
 *
 * @category Key-Value
 */
class SamplingScan {
    /**
     * @internal
     */
    constructor(limit, seed) {
        this.limit = limit;
        this.seed = seed;
    }
    /**
     * Returns string representation of scan type.
     */
    getScanType() {
        return 'sampling_scan';
    }
}
exports.SamplingScan = SamplingScan;
/**
 * A PrefixScan scan type selects every document whose ID starts with a certain prefix.
 *
 * @category Key-Value
 */
class PrefixScan {
    /**
     * @internal
     */
    constructor(prefix) {
        this.prefix = prefix;
    }
    /**
     * Returns string representation of scan type.
     */
    getScanType() {
        return 'prefix_scan';
    }
}
exports.PrefixScan = PrefixScan;