Method GetTableAsync

GetTableAsync(String, GetTableOptions, CancellationToken)

Retrieves static information about a table in the form of TableResult.
Declaration
public Task<TableResult> GetTableAsync(string tableName, GetTableOptions options = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
String tableName Name of the table.
GetTableOptions options (Optional) Options for GetTable operation. If not specified or null, appropriate defaults will be used. See GetTableOptions.
CancellationToken cancellationToken (Optional) Cancellation token.
Returns
Type Description
Task<TableResult> Task returning TableResult.
Remarks
This information includes the table state, provisioned throughput, capacity and schema. Dynamic information such as usage is obtained using GetTableUsageAsync(String, GetTableUsageOptions, CancellationToken).
Exceptions
Type Condition
ArgumentException If tableName is null or invalid or options contains invalid values.
TimeoutException Operation has timed out.
InvalidOperationException The service is not in a valid state to perform this operation.
NoSQLException NoSQLException or one of its subclasses is thrown if operation cannot be performed for any other reason. See documentation for corresponding subclass of NoSQLException.
See Also

GetTableAsync(TableResult, GetTableOptions, CancellationToken)

Retrieves static information about a table in the form of TableResult.
Declaration
public Task<TableResult> GetTableAsync(TableResult tableResult, GetTableOptions options = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
TableResult tableResult Table result representing ongoing table DDL operation.
GetTableOptions options (Optional) Options for GetTable operation. If not specified or null, appropriate defaults will be used. See GetTableOptions.
CancellationToken cancellationToken (Optional) Cancellation token.
Returns
Type Description
Task<TableResult> Task returning TableResult.
Remarks

This information includes the table state, provisioned throughput, capacity and schema. This method is similar to GetTableAsync(String, GetTableOptions, CancellationToken) but instead of table name it takes TableResult object returned by ExecuteTableDDLAsync. This allows, in addition to table information, to retrieve error information for the DDL operation. If DDL operation represented by tableResult failed, this follow-on call will throw exception containing the error information.

Note that as with GetTableAsync(String, GetTableOptions, CancellationToken) this operation will only retrieve information at one point in time. If you wish to asynchronously wait for DDL operation completion, use WaitForCompletionAsync(Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken) instead.

Exceptions
Type Condition
ArgumentException If tableResult is null or or options contains invalid values.
TimeoutException Operation has timed out.
InvalidOperationException The service is not in a valid state to perform this operation.
NoSQLException NoSQLException or one of its subclasses is thrown if operation cannot be performed for any other reason. See documentation for corresponding subclass of NoSQLException.
See Also