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 Member Functions | Static Public Member Functions | List of all members
azure::storage::table_operation Class Reference

Represents a single table operation. More...

Public Member Functions

const table_entityentity () const
 Gets the entity being operated upon. More...
 
table_operation_type operation_type () const
 Gets the type of operation. More...
 

Static Public Member Functions

static const table_operation delete_entity (table_entity entity)
 Creates a new table operation to delete the specified entity. More...
 
static const table_operation insert_entity (table_entity entity)
 Creates a new table operation to insert the specified entity. More...
 
static const table_operation 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...
 
static const table_operation 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...
 
static const table_operation merge_entity (table_entity entity)
 Creates a new table operation to merge the contents of the specified entity with the existing entity. More...
 
static const table_operation replace_entity (table_entity entity)
 Creates a new table operation to replace the contents of the specified entity. More...
 
static const table_operation retrieve_entity (utility::string_t partition_key, utility::string_t row_key)
 Creates a new table operation to retrieve the contents of the specified entity. More...
 

Detailed Description

Represents a single table operation.

Member Function Documentation

◆ delete_entity()

static const table_operation azure::storage::table_operation::delete_entity ( table_entity  entity)
inlinestatic

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.

◆ entity()

const table_entity& azure::storage::table_operation::entity ( ) const
inline

Gets the entity being operated upon.

Returns
An azure::storage::table_entity object.

◆ insert_entity()

static const table_operation azure::storage::table_operation::insert_entity ( table_entity  entity)
inlinestatic

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()

static const table_operation azure::storage::table_operation::insert_or_merge_entity ( table_entity  entity)
inlinestatic

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()

static const table_operation azure::storage::table_operation::insert_or_replace_entity ( table_entity  entity)
inlinestatic

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()

static const table_operation azure::storage::table_operation::merge_entity ( table_entity  entity)
inlinestatic

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.

◆ operation_type()

table_operation_type azure::storage::table_operation::operation_type ( ) const
inline

Gets the type of operation.

Returns
An azure::storage::table_operation_type object.

◆ replace_entity()

static const table_operation azure::storage::table_operation::replace_entity ( table_entity  entity)
inlinestatic

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()

static const table_operation azure::storage::table_operation::retrieve_entity ( utility::string_t  partition_key,
utility::string_t  row_key 
)
inlinestatic

Creates a new table operation to retrieve 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.