prorm API Reference
    Preparing search index...

    Interface QueryParams

    interface QueryParams {
        indexName?: string;
        keyConditionExpression: string;
        expressionAttributeNames?: Record<string, string>;
        expressionAttributeValues?: Record<string, unknown>;
        filterExpression?: string;
        projectionExpression?: string;
        limit?: number;
        scanIndexForward?: boolean;
        exclusiveStartKey?: DynamoDbItem;
        consistentRead?: boolean;
    }
    Index
    indexName? keyConditionExpression expressionAttributeNames? expressionAttributeValues? filterExpression? projectionExpression? limit? scanIndexForward? exclusiveStartKey? consistentRead?
    indexName?: string

    Name of a Global or Local Secondary Index to query instead of the base table.

    keyConditionExpression: string

    e.g. 'pk = :pk'

    expressionAttributeNames?: Record<string, string>
    expressionAttributeValues?: Record<string, unknown>
    filterExpression?: string

    Applied after the key condition, does not reduce RCU consumption.

    projectionExpression?: string

    Restricts which attributes are returned, e.g. '#n, total'. Use expressionAttributeNames for any reserved-word-safe #alias tokens referenced here, same as keyConditionExpression/filterExpression.

    limit?: number
    scanIndexForward?: boolean
    exclusiveStartKey?: DynamoDbItem

    Pagination cursor from a previous page's lastEvaluatedKey.

    consistentRead?: boolean

    Settings
    Member Visibility

    On This Page
    Properties