@resistdesign/voltra
    Preparing search index...

    Class StructuredDdbReader

    Read-only structured queries against DynamoDB term/range indexes.

    Implements

    • StructuredSearchDependencies
    Index

    Constructors

    constructor

    Properties

    documents missing occupancy ranges terms tokenizer?

    Constructors

    Properties

    documents: {
        get: (docId: DocId) => Promise<StructuredDocFieldsRecord | undefined>;
    } = ...

    Canonical structured fields used for exact candidate verification.

    missing: StructuredMissingIndex = ...

    Documents whose eligible sort field is currently missing.

    occupancy: StructuredOccupancyIndex = ...

    Sparse criterion-chunk/sort-token occupancy queries.

    ranges: {
        all: (
            field: string,
            options?: StructuredQueryOptions,
        ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>;
        between: (
            field: string,
            lower: WhereValue,
            upper: WhereValue,
            options?: StructuredQueryOptions,
        ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>;
        gte: (
            field: string,
            lower: WhereValue,
            options?: StructuredQueryOptions,
        ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>;
        lte: (
            field: string,
            upper: WhereValue,
            options?: StructuredQueryOptions,
        ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>;
    } = ...

    Range query implementation for structured search.

    Type Declaration

    • all: (
          field: string,
          options?: StructuredQueryOptions,
      ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>

      Traverse a scalar field in native range-key order.

    • between: (
          field: string,
          lower: WhereValue,
          upper: WhereValue,
          options?: StructuredQueryOptions,
      ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>
    • gte: (
          field: string,
          lower: WhereValue,
          options?: StructuredQueryOptions,
      ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>
    • lte: (
          field: string,
          upper: WhereValue,
          options?: StructuredQueryOptions,
      ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>
    terms: {
        query: (
            field: string,
            mode: "eq" | "contains",
            value: WhereValue,
            options?: StructuredQueryOptions,
        ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>;
    } = ...

    Term query implementation for structured search.

    Type Declaration

    • query: (
          field: string,
          mode: "eq" | "contains",
          value: WhereValue,
          options?: StructuredQueryOptions,
      ) => Promise<{ candidateIds: DocId[]; lastEvaluatedKey?: string }>
    tokenizer?: Partial<StructuredStringTokenizerConfig>

    Tokenizer used by string contains/LIKE verification.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties