@karmaniverous/entity-client-dynamodb
    Preparing search index...

    Interface IndexParams

    IndexParams

    interface IndexParams {
        expressionAttributeNames: Record<string, string | undefined>;
        expressionAttributeValues: Record<
            string,
            NativeScalarAttributeValue
            | undefined,
        >;
        filterConditions: (string | undefined)[];
        projectionAttributes?: string[];
        rangeKeyCondition?: string;
        scanIndexForward?: boolean;
    }
    Index

    Properties

    expressionAttributeNames expressionAttributeValues filterConditions projectionAttributes? rangeKeyCondition? scanIndexForward?

    Properties

    expressionAttributeNames: Record<string, string | undefined>

    Expression attribute names for this index (e.g., #created -> created).

    expressionAttributeValues: Record<
        string,
        NativeScalarAttributeValue
        | undefined,
    >

    Expression attribute values for this index (e.g., :v123 -> 1700000000).

    filterConditions: (string | undefined)[]

    Filter expressions to AND together (already rendered with aliases).

    projectionAttributes?: string[]

    Optional list of attributes to project for this index.

    rangeKeyCondition?: string

    Optional key condition expression for the range key.

    scanIndexForward?: boolean

    Optional scan direction override for the index.

    Settings

    Member Visibility

    On This Page

    Properties