Method AddDelete
AddDelete(String, MapValue, DeleteOptions, Boolean)
Adds a DeleteOperation to the collection.
Declaration
public WriteOperationCollection AddDelete(string tableName, MapValue primaryKey, DeleteOptions options, bool abortIfUnsuccessful = false)
Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | Table name. |
| MapValue | primaryKey | Primary key of the row to delete. |
| DeleteOptions | options | Options for the Delete operation. |
| Boolean | abortIfUnsuccessful | (Optional) If true and
this Delete operation fails, it will cause the entire transaction
to abort, see
WriteManyAsync(WriteOperationCollection, WriteManyOptions, CancellationToken).
|
Returns
| Type | Description |
|---|---|
| WriteOperationCollection | A reference to this instance after the Delete operation was added. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If
tableName is null or invalid or
primaryKey is null or
options contains invalid values.
|
AddDelete(String, MapValue, Boolean)
Adds a DeleteOperation to the collection.
Declaration
public WriteOperationCollection AddDelete(string tableName, MapValue primaryKey, bool abortIfUnsuccessful = false)
Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | Table name. |
| MapValue | primaryKey | Primary key of the row to delete. |
| Boolean | abortIfUnsuccessful | (Optional) If true and
this Delete operation fails, it will cause the entire transaction
to abort, see
WriteManyAsync(WriteOperationCollection, WriteManyOptions, CancellationToken).
|
Returns
| Type | Description |
|---|---|
| WriteOperationCollection | A reference to this instance after the Delete operation was added. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If
tableName is null or invalid or
primaryKey is null.
|
AddDelete(MapValue, DeleteOptions, Boolean)
Adds a DeleteOperation to the collection.
Declaration
public WriteOperationCollection AddDelete(MapValue primaryKey, DeleteOptions options, bool abortIfUnsuccessful = false)
Parameters
| Type | Name | Description |
|---|---|---|
| MapValue | primaryKey | Primary key of the row to delete. |
| DeleteOptions | options | Options for the Delete operation. |
| Boolean | abortIfUnsuccessful | (Optional) If true and
this Delete operation fails, it will cause the entire transaction
to abort, see
WriteManyAsync(String, WriteOperationCollection, WriteManyOptions, CancellationToken).
|
Returns
| Type | Description |
|---|---|
| WriteOperationCollection | A reference to this instance after the Delete operation was added. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If
primaryKey is null or
options contains invalid values.
|
AddDelete(MapValue, Boolean)
Adds a DeleteOperation to the collection.
Declaration
public WriteOperationCollection AddDelete(MapValue primaryKey, bool abortIfUnsuccessful = false)
Parameters
| Type | Name | Description |
|---|---|---|
| MapValue | primaryKey | Primary key of the row to delete. |
| Boolean | abortIfUnsuccessful | (Optional) If true and
this Delete operation fails, it will cause the entire transaction
to abort, see
WriteManyAsync(String, WriteOperationCollection, WriteManyOptions, CancellationToken).
|
Returns
| Type | Description |
|---|---|
| WriteOperationCollection | A reference to this instance after the Delete operation was added. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If
primaryKey is null.
|