The input to add a condition expression to.
One or more conditions to turn into a condition expression.
A copy of conditionableRequest with the condition expression set.
Adds a filter expression to an input object. A filter expression refines results returned from a scan or query. The filter applies after the search and you will be billed for the bandwidth of all results before the filter is applied.
Any existing filter expression will be amended.
The input to add a filter expression to.
One or more filters to turn into a filter expression.
A copy of filterableRequest with the condition expression set.
Add a projection expression to an input object. A projection expression defines what attributes are returned in the result. This can save on bandwidth.
For documentation on attribute names see: http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html
The input to add a projection expression to.
An array of attribute names to fetch.
A copy of projectableRequest with the projection expression set.
Add more items to an existing TransactWriteItemsInput object.
An existing TransactWriteItemsInput object.
Any combination of inputs into putItem
, deleteItem
and updateItem
.
Build a request object that can be passed into batchWriteItem
.
An array of the key values for each item to delete.
Input for the batchWriteItem
method.
Build a request object that can be passed into batchGetItem
.
An array of the key values for each item to request.
Input for the batchGetItem
method.
Build a request object that can be passed into batchWriteItem
.
The items to put.
Input for the batchWriteItem
method.
Build a request object that can be passed into createTable
.
This is most useful for setting up testing.
A single TableSchema or an array of TableSchemas when including secondary indexes.
Represents one strongly consistent read per second, or two eventually consistent reads per second, for an item up to 4 KB in size.
Represents one write per second for an item up to 1 KB in size.
Input for the createTable
method.
Build a request object that can be passed into deleteItem
If TableSchema.versionKeyField
is set the delete will only succeed
if the item in the database has the same value.
The item to delete. Must at least have the partition key, the sort key if applicable, and the version field if applicable.
Input for the deleteItem
method.
Build a request object that can be passed into deleteTable
.
This is most useful for setting up testing.
Input for the deleteTable
method.
Build a request object that can be passed into getItem
.
The key of the item to get.
Sort key of the item to get, if set in the schema.
Input for the getItem
method.
Build a request object that can be passed into putItem
.
If TableSchema.versionKeyField
is set the put will only succeed
if the item in the database has the same value (and then the version
will be incremented).
The item to put to the database.
Input for the putItem
method.
Build a request object that can be passed into query
. The query operation performs
an efficient search on one partition key value with an optional condition on the sort
key.
If tableSchema.indexName
is set the query will be performed on the secondary index
with that name.
The hash key of the item to get.
The operator that can be used to constrain results. Must be one of:
"=", "<", "<=", ">", ">=", "BETWEEN", "begins_with"
. If not defined
all sort key values will be returned.
Values the sortKeyOp works on. This must be 2 values for
BETWEEN
and 1 for all other operators.
Input for the query
method.
Build a serialized item that can be put in DynamoDB. This syntax is also used for expression and key values.
The item to serialize.
A put item.
Build a request object that can be passed into scan
. The scan operation performs
a linear search through all objects in the table. It can be filtered to only return
some values, though all objects in the database will still be read and your account
billed accordingly.
If tableSchema.indexName
is set the scan will be performed on the secondary index
with that name.
One or more filters to turn into a filter expression.
Input for the scan
method.
Build a request object that can be passed into transactWriteItems
.
Any combination of inputs into putItem
, deleteItem
and updateItem
.
Build a request object that can be passed into updateItem
based upon a
set of UpdateExpressionActions. Each UpdateExpressionAction defines
an operation to take as part of updating in the database.
If TableSchema.versionKeyField
is set the update will only succeed
if the item in the database has the same value (and then the version
will be incremented).
The item being updated. This item is only used for its keys and may already be updated. This item will not be modified.
An array of actions to turn into an UpdateExpression.
Input for the updateItem
method.
Build a request object that can be passed into updateTimeToLive
.
Time to live settings will be enabled if tableSchema.ttlField
is defined and disabled otherwise.
Input for the updateTimeToLive
method.
Generated using TypeDoc
Adds a condition expression to an input object. A condition expression defines under what conditions the item can be put/deleted.
Any existing condition expression will be amended.