vlocode-project - v1.40.0-beta-4
    Preparing search index...

    Interface Query2Options

    interface Query2Options {
        batchSize?: number;
        includeDeleted?: boolean;
        queryMore?: boolean;
        queryType?: "data" | "tooling";
        type?: "data" | "tooling";
    }
    Index

    Properties

    batchSize?: number

    A numeric value that specifies the number of records returned for a query request. Child objects count toward the number of records for the batch size. For example, in relationship queries, multiple child objects are returned per parent row returned.

    The default is 2000; the minimum is 200, and the maximum is 2000.

    There is no guarantee that the requested batch size is the actual batch size. Changes are made as necessary to maximize performance.

    2000
    
    includeDeleted?: boolean

    Boolean value that specifies if deleted records should be included in the results.

    false
    
    queryMore?: boolean

    Boolean value that if true will fetch additional records that did not fit in the responses batch until all result records are retrieved from the server.

    true
    
    queryType?: "data" | "tooling"

    Use type instead

    type?: "data" | "tooling"

    Defines the query backend type API to call. Some objects are available on both tooling and data API. When not set defaults to data