reduct-js/lib/esm/messages/QueryEntry.d.ts

ReductStore Client SDK for Javascript/NodeJS/Typescript

import { LabelMap } from "../Record";
export declare enum QueryType {
    QUERY = 0,
    REMOVE = 1
}
export interface QueryEntry {
    query_type: string;
    /** Start query from (Unix timestamp in microseconds) */
    start?: bigint;
    /** Stop query at (Unix timestamp in microseconds) */
    stop?: bigint;
    /** Include records with label */
    include?: Record<string, string>;
    /** Exclude records with label */
    exclude?: Record<string, string>;
    /** Return a record every S seconds */
    each_s?: number;
    /** Return a record every N records */
    each_n?: number;
    /** Limit the number of records returned */
    limit?: number;
    /** TTL of query in seconds */
    ttl?: number;
    /** Retrieve only metadata */
    only_metadata?: boolean;
    /** Continuous query, it doesn't stop until the TTL is reached */
    continuous?: boolean;
    /** Conditional query */
    when?: any;
    /** Strict conditional query
     * If true, the query returns an error if any condition cannot be evaluated
     */
    strict?: boolean;
    /** Additional parameters for extensions */
    ext?: Record<string, any>;
}
/**
 * Options for querying records
 */
export declare class QueryOptions {
    /** Time to live in seconds */
    ttl?: number;
    /** Include records with label
     *  @deprecated: use when instead. Will be remove in v1.16.0
     * */
    include?: LabelMap;
    /** Exclude records with label
     *  @deprecated: use when instead. Will be remove in v1.16.0
     * */
    exclude?: LabelMap;
    /** Return only one record per S second
     * @deprecated: use $each_t operator in when instead. Will be remove in v1.18.0
     * */
    eachS?: number;
    /** Return only one record per N records
     *  @deprecated: use $each_n operator in when instead. Will be remove in v1.18.0
     * */
    eachN?: number;
    /** Limit number of records
     *  @deprecated: use $limit operator in when instead. Will be remove in v1.18.0
     * */
    limit?: number;
    /** Don't stop query until TTL is reached */
    continuous?: boolean;
    /** Poll interval for new records only for continue=true */
    pollInterval?: number;
    /** Return only metadata */
    head?: boolean;
    /** Conditional query */
    when?: Record<string, any>;
    /**  strict conditional query */
    strict?: boolean;
    /** Additional parameters for extensions */
    ext?: Record<string, any>;
    static serialize(queryType: QueryType, data: QueryOptions, start?: bigint, stop?: bigint): QueryEntry;
}