dyna-record
    Preparing search index...

    Interface IndexSearchOptions<Members, In>

    Options of the index-construct search surface. in: accepts a member entity name — member entities include include: members, which have no relationship property name on the scope parent.

    On a global index the member union is not statically enumerable (any searchable entity of the table is a member), so in: and filter fall back to their permissive runtime shapes — the runtime guards remain authoritative.

    interface IndexSearchOptions<
        Members extends default,
        In extends Members["type"],
    > {
        filter?: string extends Members["type"]
            ? SearchFilter
            : SearchFilterParams<NarrowMembersByName<Members, In>>;
        in?: In;
        topK?: number;
    }

    Type Parameters

    Index

    Properties

    filter? in? topK?

    Properties

    filter?: string extends Members["type"]
        ? SearchFilter
        : SearchFilterParams<NarrowMembersByName<Members, In>>

    Equality filter conditions over the searched members' @SearchFilterable attributes.

    in?: In

    Narrows the search to a single member entity of the index by name.

    topK?: number

    The number of most similar results to return. Defaults to 10; DynamoDB supports at most 100.

    Settings

    Member Visibility

    On This Page

    Properties