The Table class is the starting object when using the Document API. It is used to Get documents from the DynamoDB table and write documents back to the DynamoDB table.
Inheritance Hierarchy
Namespace: Amazon.DynamoDBv2.DocumentModel
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
Syntax
public class Table
The Table type exposes the following members
Properties
Methods
| Name | Description | |
|---|---|---|
|
ClearTableCache() |
Clears current table cache. Next time a Table is created, its information will be loaded from DynamoDB. |
|
|
CreateBatchGet() |
Creates a DocumentBatchGet object for the current table, allowing a batch-get operation against DynamoDB. |
|
|
CreateBatchWrite() |
Creates a DocumentBatchWrite object for the current table, allowing a batch-put/delete operation against DynamoDB. |
|
|
CreateTransactGet() |
Creates a DocumentTransactGet object for the current table, allowing a transactional get operation against DynamoDB. |
|
|
CreateTransactWrite() |
Creates a DocumentTransactWrite object for the current table, allowing a transactional condition-check/put/update/delete operation against DynamoDB. |
|
|
DeleteItem(Document, DeleteItemOperationConfig) |
Delete a document in DynamoDB, using specified configs. |
|
|
DeleteItem(Primitive, DeleteItemOperationConfig) |
Delete a document in DynamoDB, identified by hash-key, using the specified configs. |
|
|
DeleteItem(Primitive, Primitive, DeleteItemOperationConfig) |
Delete a document in DynamoDB, identified by hash-and-range primary key, using the specified configs. |
|
|
DeleteItem(IDictionary<String, DynamoDBEntry>, DeleteItemOperationConfig) |
Delete a document in DynamoDB, identified by a key, using specified configs. |
|
|
DeleteItemAsync(Document, CancellationToken) |
Initiates the asynchronous execution of the DeleteItem operation.
|
|
|
DeleteItemAsync(Document, DeleteItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the DeleteItem operation.
|
|
|
DeleteItemAsync(Primitive, CancellationToken) |
Initiates the asynchronous execution of the DeleteItem operation.
|
|
|
DeleteItemAsync(Primitive, DeleteItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the DeleteItem operation.
|
|
|
DeleteItemAsync(Primitive, Primitive, CancellationToken) |
Initiates the asynchronous execution of the DeleteItem operation.
|
|
|
DeleteItemAsync(Primitive, Primitive, DeleteItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the DeleteItem operation.
|
|
|
DeleteItemAsync(IDictionary<String, DynamoDBEntry>, CancellationToken) |
Initiates the asynchronous execution of the DeleteItem operation.
|
|
|
DeleteItemAsync(IDictionary<String, DynamoDBEntry>, DeleteItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the DeleteItem operation.
|
|
|
FromAttributeMap(Dictionary<String, AttributeValue>) |
Creates a Document from an attribute map. |
|
|
GetItem(Primitive, GetItemOperationConfig) |
Gets a document from DynamoDB by hash primary key, using specified configs. |
|
|
GetItem(Primitive, Primitive, GetItemOperationConfig) |
Gets a document from DynamoDB by hash-and-range primary key, using specified configs. |
|
|
GetItem(IDictionary<String, DynamoDBEntry>, GetItemOperationConfig) |
Gets a document from DynamoDB by key, using specified configs. |
|
|
GetItemAsync(Primitive, CancellationToken) |
Initiates the asynchronous execution of the GetItem operation.
|
|
|
GetItemAsync(Primitive, GetItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the GetItem operation.
|
|
|
GetItemAsync(Primitive, Primitive, CancellationToken) |
Initiates the asynchronous execution of the GetItem operation.
|
|
|
GetItemAsync(Primitive, Primitive, GetItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the GetItem operation.
|
|
|
GetItemAsync(IDictionary<String, DynamoDBEntry>, CancellationToken) |
Initiates the asynchronous execution of the GetItem operation.
|
|
|
GetItemAsync(IDictionary<String, DynamoDBEntry>, GetItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the GetItem operation.
|
|
|
LoadTable(IAmazonDynamoDB, TableConfig) |
Creates a Table object with the specified configuration, using the passed-in client to load the table definition. This method will throw an exception if the table does not exist. |
|
|
LoadTable(IAmazonDynamoDB, string) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. The returned table will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema This method will throw an exception if the table does not exist. |
|
|
LoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will throw an exception if the table does not exist. |
|
|
LoadTable(IAmazonDynamoDB, string, bool) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will throw an exception if the table does not exist. |
|
|
LoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion, bool) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will throw an exception if the table does not exist. |
|
|
LoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion, bool, MetadataCachingMode) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will throw an exception if the table does not exist. |
|
|
PutItem(Document, PutItemOperationConfig) |
Puts a document into DynamoDB, using optional configs. |
|
|
PutItemAsync(Document, CancellationToken) |
Initiates the asynchronous execution of the PutItem operation.
|
|
|
PutItemAsync(Document, PutItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the PutItem operation.
|
|
|
Query(Primitive, QueryFilter) |
Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and filter. No calls are made until the Search object is used. |
|
|
Query(Primitive, Expression) |
Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and expression. No calls are made until the Search object is used. |
|
|
Query(QueryFilter) |
Initiates a Search object to Query a DynamoDB table, with the specified filter. No calls are made until the Search object is used. |
|
|
Query(QueryOperationConfig) |
Initiates a Search object to Query a DynamoDB table, with the specified config. No calls are made until the Search object is used. |
|
|
Scan(ScanFilter) |
Initiates a Search object to Scan a DynamoDB table, with the specified filter. No calls are made until the Search object is used. |
|
|
Scan(Expression) |
Initiates a Search object to Scan a DynamoDB table, with the specified expression. No calls are made until the Search object is used. |
|
|
Scan(ScanOperationConfig) |
Initiates a Search object to Scan a DynamoDB table, with the specified config. No calls are made until the Search object is used. |
|
|
ToAttributeMap(Document) |
Creates a map of attribute names mapped to AttributeValue objects. Converts .NET types using the conversion specified in this Table. |
|
|
ToAttributeUpdateMap(Document, bool) |
Creates a map of attribute names mapped to AttributeValueUpdate objects. |
|
|
ToExpectedAttributeMap(Document) |
Creates a map of attribute names mapped to ExpectedAttributeValue objects. |
|
|
TryDeleteItem(Document, DeleteItemOperationConfig) |
Delete a document in DynamoDB, using specified configs. |
|
|
TryDeleteItem(Primitive, DeleteItemOperationConfig) |
Delete a document in DynamoDB, identified by a hash primary key, using specified configs. |
|
|
TryDeleteItem(Primitive, Primitive, DeleteItemOperationConfig) |
Delete a document in DynamoDB, identified by hash-and-range primary key, using the specified configs. |
|
|
TryDeleteItem(IDictionary<String, DynamoDBEntry>, DeleteItemOperationConfig) |
Delete a document in DynamoDB, identified by a key, using specified configs. |
|
|
TryLoadTable(IAmazonDynamoDB, string, out Table) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. The returned table will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema This method will return false if the table does not exist. |
|
|
TryLoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion, out Table) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will return false if the table does not exist. |
|
|
TryLoadTable(IAmazonDynamoDB, string, bool, out Table) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will return false if the table does not exist. |
|
|
TryLoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion, bool, out Table) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will return false if the table does not exist. |
|
|
TryLoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion, bool, Nullable<MetadataCachingMode>, out Table) |
Creates a Table object with the specified name, using the passed-in client to load the table definition. This method will return false if the table does not exist. |
|
|
TryLoadTable(IAmazonDynamoDB, TableConfig, out Table) |
Creates a Table object with the specified configuration, using the passed-in client to load the table definition. This method will return false if the table does not exist. |
|
|
TryPutItem(Document, PutItemOperationConfig) |
Puts a document into DynamoDB, using optional configs. |
|
|
TryUpdateItem(Document, UpdateItemOperationConfig) |
Update a document in DynamoDB, using specified config. |
|
|
TryUpdateItem(Document, IDictionary<String, DynamoDBEntry>, UpdateItemOperationConfig) |
Update a document in DynamoDB, with a key to identify the document, and using the specified config. |
|
|
TryUpdateItem(Document, Primitive, UpdateItemOperationConfig) |
Update a document in DynamoDB, with a hash primary key to identify the document, and using the specified config. |
|
|
TryUpdateItem(Document, Primitive, Primitive, UpdateItemOperationConfig) |
Update a document in DynamoDB, with a hash-and-range primary key to identify the document, and using the specified config. |
|
|
UpdateItem(Document, UpdateItemOperationConfig) |
Update a document in DynamoDB, using specified config. |
|
|
UpdateItem(Document, IDictionary<String, DynamoDBEntry>, UpdateItemOperationConfig) |
Update a document in DynamoDB, with a key to identify the document, and using the specified config. |
|
|
UpdateItem(Document, Primitive, UpdateItemOperationConfig) |
Update a document in DynamoDB, with a hash primary key to identify the document, and using the specified config. |
|
|
UpdateItem(Document, Primitive, Primitive, UpdateItemOperationConfig) |
Update a document in DynamoDB, with a hash-and-range primary key to identify the document, and using the specified config. |
|
|
UpdateItemAsync(Document, CancellationToken) |
Initiates the asynchronous execution of the UpdateItem operation.
|
|
|
UpdateItemAsync(Document, UpdateItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the UpdateItem operation.
|
|
|
UpdateItemAsync(Document, IDictionary<String, DynamoDBEntry>, CancellationToken) |
Initiates the asynchronous execution of the UpdateItem operation.
|
|
|
UpdateItemAsync(Document, IDictionary<String, DynamoDBEntry>, UpdateItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the UpdateItem operation.
|
|
|
UpdateItemAsync(Document, Primitive, CancellationToken) |
Initiates the asynchronous execution of the UpdateItem operation.
|
|
|
UpdateItemAsync(Document, Primitive, UpdateItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the UpdateItem operation.
|
|
|
UpdateItemAsync(Document, Primitive, Primitive, CancellationToken) |
Initiates the asynchronous execution of the UpdateItem operation.
|
|
|
UpdateItemAsync(Document, Primitive, Primitive, UpdateItemOperationConfig, CancellationToken) |
Initiates the asynchronous execution of the UpdateItem operation.
|
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5