Module Values.ExecuteStatementOutputSource

This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL. For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set. A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set. If NextToken is present, you need to paginate the result set and include NextToken.

Sourcetype nonrec t = {
  1. items : ItemList.t option;
    (*

    If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values. For the write operations this value will be empty.

    *)
  2. nextToken : PartiQLNextToken.t option;
    (*

    If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.

    *)
  3. consumedCapacity : ConsumedCapacity.t option;
  4. lastEvaluatedKey : Key.t option;
    (*

    The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

    *)
}
Sourcetype nonrec error = [
  1. | `ConditionalCheckFailedException of ConditionalCheckFailedException.t
  2. | `DuplicateItemException of DuplicateItemException.t
  3. | `InternalServerError of InternalServerError.t
  4. | `ItemCollectionSizeLimitExceededException of ItemCollectionSizeLimitExceededException.t
  5. | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t
  6. | `RequestLimitExceeded of RequestLimitExceeded.t
  7. | `ResourceNotFoundException of ResourceNotFoundException.t
  8. | `ThrottlingException of ThrottlingException.t
  9. | `TransactionConflictException of TransactionConflictException.t
  10. | `Unknown_operation_error of string * string option
]
Sourceval make : ?items:??? -> ?nextToken:??? -> ?consumedCapacity:??? -> ?lastEvaluatedKey:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ConditionalCheckFailedException of ConditionalCheckFailedException.t | `DuplicateItemException of DuplicateItemException.t | `InternalServerError of InternalServerError.t | `ItemCollectionSizeLimitExceededException of ItemCollectionSizeLimitExceededException.t | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t | `RequestLimitExceeded of RequestLimitExceeded.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `TransactionConflictException of TransactionConflictException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ConditionalCheckFailedException of ConditionalCheckFailedException.t | `DuplicateItemException of DuplicateItemException.t | `InternalServerError of InternalServerError.t | `ItemCollectionSizeLimitExceededException of ItemCollectionSizeLimitExceededException.t | `ProvisionedThroughputExceededException of ProvisionedThroughputExceededException.t | `RequestLimitExceeded of RequestLimitExceeded.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `TransactionConflictException of TransactionConflictException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Map of ([> `String of AttributeName.t ] * Awso.Botodata.value) list ] list | `Map of ([> `String of AttributeName.t ] * Awso.Botodata.value) list | `String of PartiQLNextToken.t | `Structure of (string * [> `Double of ConsumedCapacityUnits.t | `Map of ([> `String of IndexName.t ] * [> `Structure of (string * [> `Double of ConsumedCapacityUnits.t ]) list ]) list | `String of TableArn.t | `Structure of (string * [> `Double of ConsumedCapacityUnits.t ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t