Type alias CreateAqlAnalyzerOptions

CreateAqlAnalyzerOptions: CreateAnalyzerOptionsType<"aql", {
    batchSize?: number;
    collapsePositions?: boolean;
    keepNull?: boolean;
    memoryLimit?: number;
    queryString: string;
    returnType?: AqlReturnTokenType;
}>

Options for creating an AQL Analyzer

Type declaration

  • Optional batchSize?: number

    Number between 1 and 1000 that determines the batch size for reading data from the query.

    Default: 1

  • Optional collapsePositions?: boolean

    If set to true, the position is set to 0 for all members of the query result array.

    Default: false

  • Optional keepNull?: boolean

    If set to false, null values will be discarded from the View index.

    Default: true

  • Optional memoryLimit?: number

    Memory limit for query execution in bytes.

    Default: 1048576 (1 MiB)

  • queryString: string

    AQL query to be executed.

  • Optional returnType?: AqlReturnTokenType

    Data type of the returned tokens.

    Default: "string"