Type alias CreateArangoSearchViewOptions

CreateArangoSearchViewOptions: ArangoSearchViewPropertiesOptions & {
    optimizeTopK?: string[];
    primaryKeyCache?: boolean;
    primarySort?: ({
        direction: Direction;
        field: string;
    } | {
        asc: boolean;
        field: string;
    })[];
    primarySortCache?: boolean;
    primarySortCompression?: Compression;
    storedValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][];
    type: "arangosearch";
    writebufferActive?: number;
    writebufferIdle?: number;
    writebufferSizeMax?: number;
}

Options for creating an ArangoSearch View.

Type declaration

  • Optional optimizeTopK?: string[]

    An array of strings defining sort expressions to optimize.

  • Optional primaryKeyCache?: boolean

    (Enterprise Edition only.) If set to true, then primary key columns will always be cached in memory.

    Default: false

  • Optional primarySort?: ({
        direction: Direction;
        field: string;
    } | {
        asc: boolean;
        field: string;
    })[]

    Attribute path (field) for the value of each document that will be used for sorting.

    If direction is set to "asc" or asc is set to true, the primary sorting order will be ascending.

    If direction is set to "desc" or asc is set to false, the primary sorting order will be descending.

  • Optional primarySortCache?: boolean

    (Enterprise Edition only.) If set to true, then primary sort columns will always be cached in memory.

    Default: false

  • Optional primarySortCompression?: Compression

    Compression to use for the primary sort data.

    Default: "lz4"

  • Optional storedValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][]

    Attribute paths for which values should be stored in the view index in addition to those used for sorting via primarySort.

  • type: "arangosearch"

    Type of the View.

  • Optional writebufferActive?: number

    Maximum number of concurrent active writers that perform a transaction.

    Default: 0

  • Optional writebufferIdle?: number

    Maximum number of writers cached in the pool.

    Default: 64

  • Optional writebufferSizeMax?: number

    Maximum memory byte size per writer before a writer flush is triggered.

    Default: 33554432 (32 MiB)

Settings

Theme