Type alias SimpleQueryAllOptions

SimpleQueryAllOptions: {
    batchSize?: number;
    limit?: number;
    skip?: number;
    stream?: boolean;
    ttl?: number;
}

Options for retrieving all documents in a collection.

Deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be replaced with AQL queries.

Type declaration

Optional batchSize?: number

Number of result values to be transferred by the server in each network roundtrip (or "batch").

Must be greater than zero.

See also QueryOptions.
Optional limit?: number

Maximum number of documents to return.
Optional skip?: number

Number of documents to skip in the query.
Optional stream?: boolean

If set to true, the query will be executed as a streaming query.

See also QueryOptions.
Optional ttl?: number

Time-to-live for the cursor in seconds. The cursor results may be garbage collected by ArangoDB after this much time has passed.

See also QueryOptions.

Generated using TypeDoc