Type Alias DynamoReadPlan

Type Declaration

• {
      consistentRead?: boolean;
      expressionAttributeNames?: Record<string, string>;
      key: Record<string, unknown>;
      projectionExpression?: string;
      type: "GetItem";
  }
• {
      consistentRead?: boolean;
      exclusiveStartKey?: Record<string, unknown>;
      expressionAttributeNames: Record<string, string>;
      expressionAttributeValues: Record<string, unknown>;
      filterExpression?: string;
      indexName?: string;
      indexType?: "GSI" | "LSI";
      keyConditionExpression: string;
      limit?: number;
      projectionExpression?: string;
      returnConsumedCapacity?: ReturnConsumedCapacityMode;
      scanIndexForward?: boolean;
      select?: QuerySelectMode;
      type: "Query";
      userAuthorFilter?: boolean;
  }

  • Optional ReadonlyconsistentRead?: boolean

    Base table only; invalid with indexName — validated in repository.

  • Optional ReadonlyexclusiveStartKey?: Record<string, unknown>

  • ReadonlyexpressionAttributeNames: Record<string, string>

  • ReadonlyexpressionAttributeValues: Record<string, unknown>

  • Optional ReadonlyfilterExpression?: string

  • Optional ReadonlyindexName?: string

  • Optional ReadonlyindexType?: "GSI" | "LSI"

  • ReadonlykeyConditionExpression: string

  • Optional Readonlylimit?: number

  • Optional ReadonlyprojectionExpression?: string

  • Optional ReadonlyreturnConsumedCapacity?: ReturnConsumedCapacityMode

  • Optional ReadonlyscanIndexForward?: boolean

  • Optional Readonlyselect?: QuerySelectMode

  • Readonlytype: "Query"

  • Optional ReadonlyuserAuthorFilter?: boolean

    True when the access pattern supplied a user filterExpression (low-level Dynamo path).

• {
      consistentRead?: boolean;
      exclusiveStartKey?: Record<string, unknown>;
      expressionAttributeNames: Record<string, string>;
      expressionAttributeValues: Record<string, unknown>;
      filterExpression?: string;
      indexName?: string;
      indexType?: "GSI" | "LSI";
      limit?: number;
      projectionExpression?: string;
      returnConsumedCapacity?: ReturnConsumedCapacityMode;
      segment?: number;
      totalSegments?: number;
      type: "Scan";
      userAuthorFilter?: boolean;
  }