Type alias SimpleQueryByExampleOptions

SimpleQueryByExampleOptions: {
    batchSize?: number;
    limit?: number;
    skip?: number;
    ttl?: number;
}

Options for retrieving documents by example.

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 database.QueryOptions.

  • Optional limit?: number

    Maximum number of documents to return.

  • Optional skip?: number

    Number of documents to skip in the query.

  • 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 database.QueryOptions.

Deprecated

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