Represents a batch operation on a table.
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
public sealed class TableBatchOperation : IList<TableOperation>, ICollection<TableOperation>, IEnumerable<TableOperation>, IEnumerable
public ref class TableBatchOperation sealed : IList<TableOperation^>, ICollection<TableOperation^>, IEnumerable<TableOperation^>, IEnumerable
[<Sealed>] type TableBatchOperation = class interface IList<TableOperation> interface ICollection<TableOperation> interface IEnumerable<TableOperation> interface IEnumerable end
Public NotInheritable Class TableBatchOperation Implements IList(Of TableOperation), ICollection(Of TableOperation), IEnumerable(Of TableOperation), IEnumerable
Constructors
| Name | Description | |
|---|---|---|
| TableBatchOperation()()()() | Initializes a new instance of the TableBatchOperation class. |
Properties
| Name | Description | |
|---|---|---|
| CountCountCountCount | Gets the number of operations in this TableBatchOperation. | |
| IsReadOnlyIsReadOnlyIsReadOnlyIsReadOnly | Gets a value indicating whether the TableBatchOperation is read-only. | |
| Item[Int32]Item[Int32]Item(Int32)Item(Int32) | Gets or sets the TableOperation item at the specified index. |
Methods
| Name | Description | |
|---|---|---|
| Add(TableOperation)(TableOperation^)(TableOperation)(TableOperation) | Adds the TableOperation to the TableBatchOperation. | |
| Clear()()()() | Clears all TableOperation objects from the TableBatchOperation. | |
| Contains(TableOperation)(TableOperation^)(TableOperation)(TableOperation) | Returns true if this TableBatchOperation contains the specified element. | |
| CopyTo(TableOperation[], Int32)(array<TableOperation^>^, Int32)(TableOperation[], Int32)(TableOperation(), Int32) | Copies all the elements of the TableBatchOperation to the specified one-dimensional array starting at the specified destination array index. | |
| Delete(ITableEntity)(ITableEntity^)(ITableEntity)(ITableEntity) | Adds a TableOperation to the TableBatchOperation that deletes the specified entity from a table. | |
| Equals(Object)(Object^)(Object)(Object) | (Inherited from Object.) | |
| GetEnumerator()()()() | Returns an IEnumerator<T><T><'T>(Of T) for the TableBatchOperation. | |
| GetHashCode()()()() | (Inherited from Object.) | |
| GetType()()()() | (Inherited from Object.) | |
| IndexOf(TableOperation)(TableOperation^)(TableOperation)(TableOperation) | Returns the zero-based index of the first occurrence of the specified TableOperation item, or -1 if the TableBatchOperation does not contain the item. | |
| Insert(Int32, TableOperation)(Int32, TableOperation^)(Int32, TableOperation)(Int32, TableOperation) | Inserts a TableOperation into the TableBatchOperation at the specified index. | |
| Insert(ITableEntity)(ITableEntity^)(ITableEntity)(ITableEntity) | Adds a TableOperation to the TableBatchOperation that inserts the specified entity into a table. | |
| Insert(ITableEntity, Boolean)(ITableEntity^, Boolean)(ITableEntity, Boolean)(ITableEntity, Boolean) | Adds a TableOperation object that inserts the specified entity into the table as part of the batch operation. | |
| InsertOrMerge(ITableEntity)(ITableEntity^)(ITableEntity)(ITableEntity) | Adds a TableOperation to the TableBatchOperation that inserts the specified entity into a table if the entity does not exist; if the entity does exist then its contents are merged with the provided entity. | |
| InsertOrReplace(ITableEntity)(ITableEntity^)(ITableEntity)(ITableEntity) | Adds a TableOperation to the TableBatchOperation that inserts the specified entity into a table if the entity does not exist; if the entity does exist then its contents are replaced with the provided entity. | |
| Merge(ITableEntity)(ITableEntity^)(ITableEntity)(ITableEntity) | Adds a TableOperation to the TableBatchOperation that merges the contents of the specified entity with the existing entity in a table. | |
| Remove(TableOperation)(TableOperation^)(TableOperation)(TableOperation) | Removes the specified TableOperation item from the TableBatchOperation. | |
| RemoveAt(Int32)(Int32)(Int32)(Int32) | Removes the TableOperation at the specified index from the TableBatchOperation. | |
| Replace(ITableEntity)(ITableEntity^)(ITableEntity)(ITableEntity) | Adds a TableOperation to the TableBatchOperation that replaces the contents of the specified entity in a table. | |
| Retrieve(String, String)(String^, String^)(String, String)(String, String) | Adds a TableOperation to the TableBatchOperation that retrieves an entity with the specified partition key and row key. | |
| Retrieve<TResult><TResult><'TResult>(Of TResult)(String, String, EntityResolver<TResult>, List<String>)(String^, String^, EntityResolver<TResult>^, List<String^>^)(String, String, EntityResolver<'TResult>, List<String>)(String, String, EntityResolver(Of TResult), List(Of String)) | Adds a table operation to retrieve an entity of the specified class type with the specified partition key and row key to the batch operation. | |
| Retrieve<TElement><TElement><'TElement>(Of TElement)(String, String, List<String>)(String^, String^, List<String^>^)(String, String, List<String>)(String, String, List(Of String)) | Inserts a TableOperation into the batch that retrieves an entity based on its row key and partition key. The entity will be deserialized into the specified class type which extends ITableEntity. | |
| ToString()()()() | (Inherited from Object.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
| IEnumerable.::..GetEnumerator()()()() | Returns an IEnumerator. |
Remarks
A batch operation is a collection of table operations which are executed by the Storage Service REST API as a single atomic operation, by invoking an Entity Group Transaction.
A batch operation may contain up to 100 individual table operations, with the requirement that each operation entity must have same partition key. A batch with a retrieve operation cannot contain any other operations. Note that the total payload of a batch operation is limited to 4MB.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.