dyna-record
    Preparing search index...

    Interface ParentSearchOptions<T, In>

    Options of the parent search surfaces (Parent.search and parent.search). in: accepts a single searchable relationship property name; filter keys narrow to the searched entities' @SearchFilterable attributes.

    interface ParentSearchOptions<
        T extends default,
        In extends SearchableRelationshipProperties<T>,
    > {
        filter?: SearchFilterParams<ParentSearchedEntities<T, In>>;
        in?: In;
        topK?: number;
    }

    Type Parameters

    Index

    Properties

    filter? in? topK?

    Properties

    filter?: SearchFilterParams<ParentSearchedEntities<T, In>>

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

    in?: In

    Narrows the search to a single searchable relationship of the parent. Omitted, the search spans the parent's full searchable adjacency.

    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