Method DropReplicaAsync
DropReplicaAsync(String, Region, DropReplicaOptions, CancellationToken)
Cloud Service only.
Drops replica from a table.
Declaration
public Task<TableResult> DropReplicaAsync(string tableName, Region region, DropReplicaOptions options = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
String | tableName | Name of the table. |
Region | region | Region from where to drop the replica. |
DropReplicaOptions | options | (Optional) Options for the operation. If not
specified or null , appropriate defaults will be used.
|
CancellationToken | cancellationToken | (Optional) Cancellation token. |
Returns
Type | Description |
---|---|
Task<TableResult> | Task returning TableResult. |
Remarks
This operation drops replica from a Global Active table. For more information, see Global Active Tables in NDCS .
As with ExecuteTableDDLAsync, the result returned from this API does not imply operation completion. Same considerations as described in ExecuteTableDDLAsync about long-running operations apply here, including the need to use WaitForCompletionAsync(Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken) to asynchronously wait for operation completion.
Exceptions
Type | Condition |
---|---|
TimeoutException | Operation has timed out. |
InvalidOperationException | The table or 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
DropReplicaAsync(String, String, DropReplicaOptions, CancellationToken)
Cloud Service only.
Drops replica from a table.
Declaration
public Task<TableResult> DropReplicaAsync(string tableName, string regionId, DropReplicaOptions options = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
String | tableName | Name of the table. |
String | regionId | Region id of the region from where to drop the replica. |
DropReplicaOptions | options | (Optional) Options for the operation. If not
specified or null , appropriate defaults will be used.
|
CancellationToken | cancellationToken | (Optional) Cancellation token. |
Returns
Type | Description |
---|---|
Task<TableResult> | Task returning TableResult. |
Remarks
This API is equivalent to
DropReplicaAsync(String, Region, DropReplicaOptions, CancellationToken)
except that it takes the region id as
regionId
parameter instead of Region instance. E.g.
"ap-mumbai-1", "us-ashburn-1", etc.
Exceptions
Type | Condition |
---|---|
TimeoutException | Operation has timed out. |
InvalidOperationException | The table or 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. |