C# Class Amazon.DynamoDBv2.DocumentModel.Table

The Table class is the starting object when using the Document API. It is used to Get documents from the DynamnoDB table and write documents back to the DynamoDB table.
Show file Open project: aws/aws-sdk-net Class Usage Examples

Private Properties

Property Type Description
ClearTableData void
Copy Table
Copy Table
DeleteHelper Document
DescribeTable Amazon.DynamoDBv2.Model.TableDescription
GetItemHelper Document
GetType DynamoDBEntryType
HaveKeysChanged bool
LoadTable Table
LoadTableAsync void
LoadTableInfo void
MakeKey Key
MakeKey Key
PutItemHelper Document
Table System
TryLoadTable bool
UpdateHelper Document
UpdateHelper Document
UserAgentRequestEventHandler void
UserAgentRequestEventHandlerAsync void
UserAgentRequestEventHandlerSync void
ValidateConditional void

Public Methods

Method Description
ClearTableCache ( ) : void

Clears current table cache. Next time a Table is created, its information will be loaded from DynamoDB.
CreateBatchGet ( ) : DocumentBatchGet

Creates a DocumentBatchGet object for the current table, allowing a batch-get operation against DynamoDB.
CreateBatchWrite ( ) : DocumentBatchWrite

Creates a DocumentBatchWrite object for the current table, allowing a batch-put/delete operation against DynamoDB.
DeleteItemAsync ( Document document, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the DeleteItem operation.
DeleteItemAsync ( Document document, DeleteItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the DeleteItem operation.
DeleteItemAsync ( DynamoDBEntry>.IDictionary key, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the DeleteItem operation.
DeleteItemAsync ( DynamoDBEntry>.IDictionary key, DeleteItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the DeleteItem operation.
DeleteItemAsync ( Primitive hashKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the DeleteItem operation.
DeleteItemAsync ( Primitive hashKey, DeleteItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the DeleteItem operation.
DeleteItemAsync ( Primitive hashKey, Primitive rangeKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the DeleteItem operation.
DeleteItemAsync ( Primitive hashKey, Primitive rangeKey, DeleteItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the DeleteItem operation.
GetItemAsync ( DynamoDBEntry>.IDictionary key, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the GetItem operation.
GetItemAsync ( DynamoDBEntry>.IDictionary key, GetItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the GetItem operation.
GetItemAsync ( Primitive hashKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the GetItem operation.
GetItemAsync ( Primitive hashKey, GetItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the GetItem operation.
GetItemAsync ( Primitive hashKey, Primitive rangeKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the GetItem operation.
GetItemAsync ( Primitive hashKey, Primitive rangeKey, GetItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the GetItem operation.
LoadTable ( IAmazonDynamoDB ddbClient, string tableName ) : 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 throw an exception if the table does not exist.
LoadTable ( IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion ) : Table

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.
LoadTableAsync ( IAmazonDynamoDB ddbClient, string tableName, AmazonDynamoDBCallbackcallback, AsyncOptionsasyncOptions = null ) : void

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 return an exception if the table does not exist within the callback.
LoadTableAsync ( IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion, AmazonDynamoDBCallbackcallback, AsyncOptionsasyncOptions = null ) : void

Creates a Table object with the specified name, using the passed-in client to load the table definition. This method return an exception if the table does not exist within the callback.
PutItemAsync ( Document doc, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the PutItem operation.
PutItemAsync ( Document doc, PutItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the PutItem operation.
Query ( Primitive hashKey, Amazon.DynamoDBv2.DocumentModel.Expression filterExpression ) : Search

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 ( Primitive hashKey, QueryFilter filter ) : Search

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 ( QueryFilter filter ) : Search

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 config ) : Search

Initiates a Search object to Query a DynamoDB table, with the specified config. No calls are made until the Search object is used.
Scan ( Amazon.DynamoDBv2.DocumentModel.Expression filterExpression ) : Search

Initiates a Search object to Scan a DynamoDB table, with the specified expression. No calls are made until the Search object is used.
Scan ( ScanFilter filter ) : Search

Initiates a Search object to Scan a DynamoDB table, with the specified filter. No calls are made until the Search object is used.
Scan ( ScanOperationConfig config ) : Search

Initiates a Search object to Scan a DynamoDB table, with the specified config. No calls are made until the Search object is used.
TryLoadTable ( IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion, Table &table ) : bool

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 ddbClient, string tableName, Table &table ) : bool

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.
UpdateItemAsync ( Document doc, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the UpdateItem operation.
UpdateItemAsync ( Document doc, DynamoDBEntry>.IDictionary key, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the UpdateItem operation.
UpdateItemAsync ( Document doc, DynamoDBEntry>.IDictionary key, UpdateItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the UpdateItem operation.
UpdateItemAsync ( Document doc, Primitive hashKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the UpdateItem operation.
UpdateItemAsync ( Document doc, Primitive hashKey, Primitive rangeKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the UpdateItem operation.
UpdateItemAsync ( Document doc, Primitive hashKey, Primitive rangeKey, UpdateItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the UpdateItem operation.
UpdateItemAsync ( Document doc, Primitive hashKey, UpdateItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the UpdateItem operation.
UpdateItemAsync ( Document doc, UpdateItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void

Initiates the asynchronous execution of the UpdateItem operation.

Private Methods

Method Description
ClearTableData ( ) : void
Copy ( ) : Table
Copy ( Table newConsumer ) : Table
DeleteHelper ( Key key, DeleteItemOperationConfig config, bool isAsync ) : Document
DescribeTable ( string tableName ) : TableDescription
GetItemHelper ( Key key, GetItemOperationConfig config, bool isAsync ) : Document
GetType ( string attributeType ) : DynamoDBEntryType
HaveKeysChanged ( Document doc ) : bool
LoadTable ( IAmazonDynamoDB ddbClient, string tableName, Table consumer, DynamoDBEntryConversion conversion ) : Table
LoadTableAsync ( IAmazonDynamoDB ddbClient, string tableName, Table consumer, DynamoDBEntryConversion conversion, AmazonDynamoDBCallbackcallback, AsyncOptionsasyncOptions = null ) : void
LoadTableInfo ( ) : void
MakeKey ( DynamoDBEntry>.IDictionary doc ) : Key
MakeKey ( Primitive hashKey, Primitive rangeKey ) : Key
PutItemHelper ( Document doc, PutItemOperationConfig config, bool isAsync ) : Document
Table ( IAmazonDynamoDB ddbClient, string tableName, Table consumer, DynamoDBEntryConversion conversion ) : System
TryLoadTable ( IAmazonDynamoDB ddbClient, string tableName, Table consumer, DynamoDBEntryConversion conversion, Table &table ) : bool
UpdateHelper ( Document doc, Key key, UpdateItemOperationConfig config, bool isAsync ) : Document
UpdateHelper ( Document doc, Primitive hashKey, Primitive rangeKey, UpdateItemOperationConfig config, bool isAsync ) : Document
UserAgentRequestEventHandler ( object sender, RequestEventArgs args, bool isAsync ) : void
UserAgentRequestEventHandlerAsync ( object sender, RequestEventArgs args ) : void
UserAgentRequestEventHandlerSync ( object sender, RequestEventArgs args ) : void
ValidateConditional ( IConditionalOperationConfig config ) : void

Validates that the conditional properties on the config object are correctly set.

Method Details

ClearTableCache() public static method

Clears current table cache. Next time a Table is created, its information will be loaded from DynamoDB.
public static ClearTableCache ( ) : void
return void

CreateBatchGet() public method

Creates a DocumentBatchGet object for the current table, allowing a batch-get operation against DynamoDB.
public CreateBatchGet ( ) : DocumentBatchGet
return DocumentBatchGet

CreateBatchWrite() public method

Creates a DocumentBatchWrite object for the current table, allowing a batch-put/delete operation against DynamoDB.
public CreateBatchWrite ( ) : DocumentBatchWrite
return DocumentBatchWrite

DeleteItemAsync() public method

Initiates the asynchronous execution of the DeleteItem operation.
public DeleteItemAsync ( Document document, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
document Document Document to delete.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

DeleteItemAsync() public method

Initiates the asynchronous execution of the DeleteItem operation.
public DeleteItemAsync ( Document document, DeleteItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
document Document Document to delete.
config DeleteItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

DeleteItemAsync() public method

Initiates the asynchronous execution of the DeleteItem operation.
public DeleteItemAsync ( DynamoDBEntry>.IDictionary key, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
key DynamoDBEntry>.IDictionary Key of the document.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

DeleteItemAsync() public method

Initiates the asynchronous execution of the DeleteItem operation.
public DeleteItemAsync ( DynamoDBEntry>.IDictionary key, DeleteItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
key DynamoDBEntry>.IDictionary Key of the document.
config DeleteItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

DeleteItemAsync() public method

Initiates the asynchronous execution of the DeleteItem operation.
public DeleteItemAsync ( Primitive hashKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
hashKey Primitive Hash key element of the document.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

DeleteItemAsync() public method

Initiates the asynchronous execution of the DeleteItem operation.
public DeleteItemAsync ( Primitive hashKey, DeleteItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
hashKey Primitive Hash key element of the document.
config DeleteItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

DeleteItemAsync() public method

Initiates the asynchronous execution of the DeleteItem operation.
public DeleteItemAsync ( Primitive hashKey, Primitive rangeKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
hashKey Primitive Hash key element of the document.
rangeKey Primitive Range key element of the document.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

DeleteItemAsync() public method

Initiates the asynchronous execution of the DeleteItem operation.
public DeleteItemAsync ( Primitive hashKey, Primitive rangeKey, DeleteItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
hashKey Primitive Hash key element of the document.
rangeKey Primitive Range key element of the document.
config DeleteItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

GetItemAsync() public method

Initiates the asynchronous execution of the GetItem operation.
public GetItemAsync ( DynamoDBEntry>.IDictionary key, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
key DynamoDBEntry>.IDictionary Key of the document.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

GetItemAsync() public method

Initiates the asynchronous execution of the GetItem operation.
public GetItemAsync ( DynamoDBEntry>.IDictionary key, GetItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
key DynamoDBEntry>.IDictionary Ley of the document.
config GetItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

GetItemAsync() public method

Initiates the asynchronous execution of the GetItem operation.
public GetItemAsync ( Primitive hashKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
hashKey Primitive Hash key element of the document.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

GetItemAsync() public method

Initiates the asynchronous execution of the GetItem operation.
public GetItemAsync ( Primitive hashKey, GetItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
hashKey Primitive Hash key element of the document.
config GetItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

GetItemAsync() public method

Initiates the asynchronous execution of the GetItem operation.
public GetItemAsync ( Primitive hashKey, Primitive rangeKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
hashKey Primitive Hash key element of the document.
rangeKey Primitive Range key element of the document.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

GetItemAsync() public method

Initiates the asynchronous execution of the GetItem operation.
public GetItemAsync ( Primitive hashKey, Primitive rangeKey, GetItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
hashKey Primitive Hash key element of the document.
rangeKey Primitive Range key element of the document.
config GetItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

LoadTable() public static method

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.
public static LoadTable ( IAmazonDynamoDB ddbClient, string tableName ) : Table
ddbClient IAmazonDynamoDB Client to use to access DynamoDB.
tableName string Name of the table.
return Table

LoadTable() public static method

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.
public static LoadTable ( IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion ) : Table
ddbClient IAmazonDynamoDB Client to use to access DynamoDB.
tableName string Name of the table.
conversion DynamoDBEntryConversion Conversion to use for converting .NET values to DynamoDB values.
return Table

LoadTableAsync() public static method

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 return an exception if the table does not exist within the callback.
public static LoadTableAsync ( IAmazonDynamoDB ddbClient, string tableName, AmazonDynamoDBCallbackcallback, AsyncOptionsasyncOptions = null ) : void
ddbClient IAmazonDynamoDB Client to use to access DynamoDB.
tableName string Name of the table.
callback AmazonDynamoDBCallback
The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

LoadTableAsync() public static method

Creates a Table object with the specified name, using the passed-in client to load the table definition. This method return an exception if the table does not exist within the callback.
public static LoadTableAsync ( IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion, AmazonDynamoDBCallbackcallback, AsyncOptionsasyncOptions = null ) : void
ddbClient IAmazonDynamoDB Client to use to access DynamoDB.
tableName string Name of the table.
conversion DynamoDBEntryConversion Conversion to use for converting .NET values to DynamoDB values.
callback AmazonDynamoDBCallback
The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

PutItemAsync() public method

Initiates the asynchronous execution of the PutItem operation.
public PutItemAsync ( Document doc, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Document to save.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

PutItemAsync() public method

Initiates the asynchronous execution of the PutItem operation.
public PutItemAsync ( Document doc, PutItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Document to save.
config PutItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

Query() public method

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.
public Query ( Primitive hashKey, Amazon.DynamoDBv2.DocumentModel.Expression filterExpression ) : Search
hashKey Primitive Value of the hash key for the query operation.
filterExpression Amazon.DynamoDBv2.DocumentModel.Expression Expression to use.
return Search

Query() public method

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.
public Query ( Primitive hashKey, QueryFilter filter ) : Search
hashKey Primitive Value of the hash key for the query operation.
filter QueryFilter Filter to use.
return Search

Query() public method

Initiates a Search object to Query a DynamoDB table, with the specified filter. No calls are made until the Search object is used.
public Query ( QueryFilter filter ) : Search
filter QueryFilter Filter to use.
return Search

Query() public method

Initiates a Search object to Query a DynamoDB table, with the specified config. No calls are made until the Search object is used.
public Query ( QueryOperationConfig config ) : Search
config QueryOperationConfig Configuration to use.
return Search

Scan() public method

Initiates a Search object to Scan a DynamoDB table, with the specified expression. No calls are made until the Search object is used.
public Scan ( Amazon.DynamoDBv2.DocumentModel.Expression filterExpression ) : Search
filterExpression Amazon.DynamoDBv2.DocumentModel.Expression Expression to apply to the scan.
return Search

Scan() public method

Initiates a Search object to Scan a DynamoDB table, with the specified filter. No calls are made until the Search object is used.
public Scan ( ScanFilter filter ) : Search
filter ScanFilter Filter to apply to the scan.
return Search

Scan() public method

Initiates a Search object to Scan a DynamoDB table, with the specified config. No calls are made until the Search object is used.
public Scan ( ScanOperationConfig config ) : Search
config ScanOperationConfig Configuration to use.
return Search

TryLoadTable() public static method

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.
public static TryLoadTable ( IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion, Table &table ) : bool
ddbClient IAmazonDynamoDB Client to use to access DynamoDB.
tableName string Name of the table.
conversion DynamoDBEntryConversion Conversion to use for converting .NET values to DynamoDB values.
table Table Loaded table.
return bool

TryLoadTable() public static method

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.
public static TryLoadTable ( IAmazonDynamoDB ddbClient, string tableName, Table &table ) : bool
ddbClient IAmazonDynamoDB Client to use to access DynamoDB.
tableName string Name of the table.
table Table Loaded table.
return bool

UpdateItemAsync() public method

Initiates the asynchronous execution of the UpdateItem operation.
public UpdateItemAsync ( Document doc, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Document to update.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

UpdateItemAsync() public method

Initiates the asynchronous execution of the UpdateItem operation.
public UpdateItemAsync ( Document doc, DynamoDBEntry>.IDictionary key, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Attributes to update.
key DynamoDBEntry>.IDictionary Key of the document.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

UpdateItemAsync() public method

Initiates the asynchronous execution of the UpdateItem operation.
public UpdateItemAsync ( Document doc, DynamoDBEntry>.IDictionary key, UpdateItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Attributes to update.
key DynamoDBEntry>.IDictionary Key of the document.
config UpdateItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

UpdateItemAsync() public method

Initiates the asynchronous execution of the UpdateItem operation.
public UpdateItemAsync ( Document doc, Primitive hashKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Attributes to update.
hashKey Primitive Hash key element of the document.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

UpdateItemAsync() public method

Initiates the asynchronous execution of the UpdateItem operation.
public UpdateItemAsync ( Document doc, Primitive hashKey, Primitive rangeKey, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Attributes to update.
hashKey Primitive Hash key element of the document.
rangeKey Primitive Range key element of the document.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

UpdateItemAsync() public method

Initiates the asynchronous execution of the UpdateItem operation.
public UpdateItemAsync ( Document doc, Primitive hashKey, Primitive rangeKey, UpdateItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Attributes to update.
hashKey Primitive Hash key element of the document.
rangeKey Primitive Range key element of the document.
config UpdateItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

UpdateItemAsync() public method

Initiates the asynchronous execution of the UpdateItem operation.
public UpdateItemAsync ( Document doc, Primitive hashKey, UpdateItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Attributes to update.
hashKey Primitive Hash key element of the document.
config UpdateItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void

UpdateItemAsync() public method

Initiates the asynchronous execution of the UpdateItem operation.
public UpdateItemAsync ( Document doc, UpdateItemOperationConfig config, AmazonDynamoDBCallback callback, AsyncOptions asyncOptions = null ) : void
doc Document Document to update.
config UpdateItemOperationConfig Configuration to use.
callback AmazonDynamoDBCallback The callback that will be invoked when the asynchronous operation completes.
asyncOptions Amazon.Runtime.AsyncOptions An instance of AsyncOptions that specifies how the async method should be executed.
return void