Class ExecuteStatementRequest
- Namespace
- Amazon.DynamoDBv2.Model
- Assembly
- AWSSDK.DynamoDBv2.dll
Container for the parameters to the ExecuteStatement operation. 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.
public class ExecuteStatementRequest : AmazonDynamoDBRequest
- Inheritance
-
ExecuteStatementRequest
Constructors
ExecuteStatementRequest()
public ExecuteStatementRequest()
Properties
ConsistentRead
Gets and sets the property ConsistentRead.
The consistency of a read operation. If set to
true
, then a strongly
consistent read is used; otherwise, an eventually consistent read is used.
public bool ConsistentRead { get; set; }
Property Value
Limit
Gets and sets the property Limit.
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, along with a key in
LastEvaluatedKey
to apply in a subsequent operation so you can
pick up where you left off. Also, if the processed dataset size exceeds 1 MB before
DynamoDB reaches this limit, it stops the operation and returns the matching values
up to the limit, and a key in LastEvaluatedKey
to apply in a subsequent
operation to continue the operation.
public int Limit { get; set; }
Property Value
NextToken
Gets and sets the property NextToken.
Set this value to get remaining results, if
NextToken
was returned in
the statement response.
public string NextToken { get; set; }
Property Value
Parameters
Gets and sets the property Parameters.
The parameters for the PartiQL statement, if any.
public List<AttributeValue> Parameters { get; set; }
Property Value
ReturnConsumedCapacity
Gets and sets the property ReturnConsumedCapacity.
public ReturnConsumedCapacity ReturnConsumedCapacity { get; set; }
Property Value
Statement
Gets and sets the property Statement.
The PartiQL statement representing the operation to run.
public string Statement { get; set; }