prorm API Reference
    Preparing search index...

    Interface ScanParams

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

    Restricts which attributes are returned. Use expressionAttributeNames for any #alias tokens referenced here (same rules as getItem()).

    expressionAttributeNames?: Record<string, string>
    expressionAttributeValues?: Record<string, unknown>
    limit?: number
    exclusiveStartKey?: DynamoDbItem
    consistentRead?: boolean
    segment?: number

    For parallel scans: this segment's index (0-based).

    totalSegments?: number

    For parallel scans: total number of segments.

    Settings
    Member Visibility

    On This Page
    Properties