Microsoft Azure Storage Client Library for C++  7.5.0
The Microsoft Azure Storage Client Library for C++ is a library for working with the Azure Storage Services in C++.
Public Types | Public Member Functions | List of all members
azure::storage::table_batch_operation Class Reference

Represents a batch operation on a table. More...

Public Types

typedef std::vector< azure::storage::table_operationoperations_type
 

Public Member Functions

 table_batch_operation ()
 Initializes a new instance of the azure::storage::table_batch_operation class. More...
 
void delete_entity (table_entity entity)
 Creates a new table operation to delete the specified entity. More...
 
void insert_entity (table_entity entity)
 Creates a new table operation to insert the specified entity. More...
 
void insert_or_merge_entity (table_entity entity)
 Creates a new table operation to insert the specified entity if it does not exist; if the entity does exist, then the contents of the specified entity are merged with the existing entity. More...
 
void insert_or_replace_entity (table_entity entity)
 Creates a new table operation to insert the specified entity if the entity does not exist; if the entity does exist, then its contents are replaced with the specified entity. More...
 
void merge_entity (table_entity entity)
 Creates a new table operation to merge the contents of the specified entity with the existing entity. More...
 
void replace_entity (table_entity entity)
 Creates a new table operation to replace the contents of the specified entity. More...
 
void retrieve_entity (utility::string_t partition_key, utility::string_t row_key)
 Creates a new table operation to replace the contents of the specified entity. More...
 
operations_type & operations ()
 Gets a reference to an azure::storage::table_batch_operation::operations_type object containing an enumerable collection of operations comprising a batch operation. More...
 
const operations_type & operations () const
 Gets a reference to an azure::storage::table_batch_operation::operations_type object containing an enumerable collection of operations comprising a batch operation. More...
 

Detailed Description

Represents a batch operation on a table.

Constructor & Destructor Documentation

◆ table_batch_operation()

azure::storage::table_batch_operation::table_batch_operation ( )
inline

Initializes a new instance of the azure::storage::table_batch_operation class.

Member Function Documentation

◆ delete_entity()

void azure::storage::table_batch_operation::delete_entity ( table_entity  entity)
inline

Creates a new table operation to delete the specified entity.

Parameters
entityThe entity to be deleted from the table.
Returns
An azure::storage::table_operation object.

◆ insert_entity()

void azure::storage::table_batch_operation::insert_entity ( table_entity  entity)
inline

Creates a new table operation to insert the specified entity.

Parameters
entityThe entity to be inserted into the table.
Returns
An azure::storage::table_operation object.

◆ insert_or_merge_entity()

void azure::storage::table_batch_operation::insert_or_merge_entity ( table_entity  entity)
inline

Creates a new table operation to insert the specified entity if it does not exist; if the entity does exist, then the contents of the specified entity are merged with the existing entity.

Parameters
entityThe entity whose contents are being inserted or merged.
Returns
An azure::storage::table_operation object.

◆ insert_or_replace_entity()

void azure::storage::table_batch_operation::insert_or_replace_entity ( table_entity  entity)
inline

Creates a new table operation to insert the specified entity if the entity does not exist; if the entity does exist, then its contents are replaced with the specified entity.

Parameters
entityThe entity whose contents are being inserted or replaced.
Returns
An azure::storage::table_operation object.

◆ merge_entity()

void azure::storage::table_batch_operation::merge_entity ( table_entity  entity)
inline

Creates a new table operation to merge the contents of the specified entity with the existing entity.

Parameters
entityThe entity whose contents are being merged.
Returns
An azure::storage::table_operation object.

◆ operations() [1/2]

operations_type& azure::storage::table_batch_operation::operations ( )
inline

Gets a reference to an azure::storage::table_batch_operation::operations_type object containing an enumerable collection of operations comprising a batch operation.

Returns
An azure::storage::table_batch_operation::operations_type object.

◆ operations() [2/2]

const operations_type& azure::storage::table_batch_operation::operations ( ) const
inline

Gets a reference to an azure::storage::table_batch_operation::operations_type object containing an enumerable collection of operations comprising a batch operation.

Returns
An azure::storage::table_batch_operation::operations_type object.

◆ replace_entity()

void azure::storage::table_batch_operation::replace_entity ( table_entity  entity)
inline

Creates a new table operation to replace the contents of the specified entity.

Parameters
entityThe entity whose contents are being replaced.
Returns
An azure::storage::table_operation object.

◆ retrieve_entity()

void azure::storage::table_batch_operation::retrieve_entity ( utility::string_t  partition_key,
utility::string_t  row_key 
)
inline

Creates a new table operation to replace the contents of the specified entity.

Parameters
partition_keyThe partition key of the entity to be replaced.
row_keyThe row key of the entity to be replaced.
Returns
An azure::storage::table_operation object.