Azure::Data::Tables::TableClient Class Reference

Table Client.

#include <tables_clients.hpp>

Public Member Functions
	TableClient (std::string const &serviceUrl, std::string const &tableName, const TableClientOptions &options={})
	Initializes a new instance of tableClient.
	TableClient (const std::string &serviceUrl, const std::string &tableName, std::shared_ptr< Core::Credentials::TokenCredential > credential, const TableClientOptions &options={})
	Initializes a new instance of tableClient.
	TableClient (const std::string &tableName, std::shared_ptr< Azure::Data::Tables::Credentials::SharedKeyCredential > credential, std::string url, const TableClientOptions &options={})
	Initializes a new instance of tableClient.
Response< Models::Table >	Create (Core::Context const &context={})
	Create the table indicated in the tableName field of the client.
Response< Models::DeleteResult >	Delete (Core::Context const &context={})
	Delete the table indicated in the tableName field of the client.
Response< Models::TableAccessPolicy >	GetAccessPolicy (Core::Context const &context={})
	Get table access policy.
Response< Models::SetTableAccessPolicyResult >	SetAccessPolicy (Models::TableAccessPolicy const &tableAccessPolicy, Core::Context const &context={})
	Set table access policy.
Response< Models::CreateEntityResult >	CreateEntity (Models::TableEntity const &tableEntity, Models::CreateEntityOptions const &options={}, Core::Context const &context={})
	Create table entity.
Response< Models::UpdateEntityResult >	UpdateEntity (Models::TableEntity const &tableEntity, Models::UpdateEntityOptions const &options={}, Core::Context const &context={})
	Update table entity.
Response< Models::MergeEntityResult >	MergeEntity (Models::TableEntity const &tableEntity, Models::MergeEntityOptions const &options={}, Core::Context const &context={})
	Merge table entity.
Response< Models::DeleteEntityResult >	DeleteEntity (Models::TableEntity const &tableEntity, Core::Context const &context={})
	Delete table entity.
Response< Models::UpsertEntityResult >	UpsertEntity (Models::TableEntity const &tableEntity, Models::UpsertEntityOptions const &options={}, Core::Context const &context={})
	Upsert table entity.
Models::QueryEntitiesPagedResponse	QueryEntities (Models::QueryEntitiesOptions const &options={}, Core::Context const &context={})
	Query table entities.
Transaction	CreateTransaction (std::string const &partitionKey)
	Creates a new transaction.
Response< Models::SubmitTransactionResult >	SubmitTransaction (Transaction &transaction, Core::Context const &context={})
	Submits a transaction.

Static Public Member Functions
static TableClient	CreateFromConnectionString (const std::string &connectionString, const std::string &tableName, const TableClientOptions &options={})
	Initializes a new instance of tableClient.

Constructor & Destructor Documentation

TableClient() [1/3]

TableClient::TableClient ( std::string const &  serviceUrl, std::string const &  tableName, const TableClientOptions &  options = {}  )

explicit

Parameters

serviceUrl	The URL of the service account that is the target of the desired operation. The URL may contain SAS query parameters.
tableName	The name of the table.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

TableClient() [2/3]

TableClient::TableClient ( const std::string &  serviceUrl, const std::string &  tableName, std::shared_ptr< Core::Credentials::TokenCredential >  credential, const TableClientOptions &  options = {}  )

explicit

Parameters

serviceUrl	The URL of the service account that is the target of the desired operation. The URL may contain SAS query parameters.
tableName	The name of the table.
credential	The shared key credential used to sign requests.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

TableClient() [3/3]

TableClient::TableClient ( const std::string &  tableName, std::shared_ptr< Azure::Data::Tables::Credentials::SharedKeyCredential >  credential, std::string  url, const TableClientOptions &  options = {}  )

explicit

Parameters

tableName	The name of the table.
credential	The shared key credential used to sign requests.
url	A url referencing the table that includes the name of the account and the name of
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Member Function Documentation

Create()

Azure::Response< Models::Table > TableClient::Create

(

Core::Context const &

context = {}

)

Parameters

context

for canceling long running operations.

Returns

Create table result.

CreateEntity()

Azure::Response< Models::CreateEntityResult > TableClient::CreateEntity	(	Models::TableEntity const &	tableEntity,
		Models::CreateEntityOptions const &	options = {},
		Core::Context const &	context = {}
	)

Parameters

tableEntity	The TableEntity to set.
options	Optional parameters to execute this function.
context	for canceling long running operations.

Returns

Create entity result.

CreateFromConnectionString()

TableClient TableClient::CreateFromConnectionString ( const std::string &  connectionString, const std::string &  tableName, const TableClientOptions &  options = {}  )

static

Parameters

connectionString	the connection string used to initialize.
tableName	The name of the table.
options	Optional client options that define the transport pipeline policies for authentication, retries, etc., that are applied to every request.

Returns

TableClient.

CreateTransaction()

Transaction TableClient::CreateTransaction

(

std::string const &

partitionKey

)

Parameters

partitionKey

The partition key of the transaction.

Returns

New transaction.

Delete()

Azure::Response< Models::DeleteResult > TableClient::Delete

(

Core::Context const &

context = {}

)

Parameters

context

for canceling long running operations.

Returns

Delete table result.

DeleteEntity()

Azure::Response< Models::DeleteEntityResult > TableClient::DeleteEntity	(	Models::TableEntity const &	tableEntity,
		Core::Context const &	context = {}
	)

Parameters

tableEntity	The TableEntity to delete.
context	for canceling long running operations.

Returns

Delete entity result.

GetAccessPolicy()

Azure::Response< Models::TableAccessPolicy > TableClient::GetAccessPolicy

(

Core::Context const &

context = {}

)

Parameters

context

for canceling long running operations.

Returns

Get access policy result.

MergeEntity()

Azure::Response< Models::MergeEntityResult > TableClient::MergeEntity	(	Models::TableEntity const &	tableEntity,
		Models::MergeEntityOptions const &	options = {},
		Core::Context const &	context = {}
	)

Parameters

tableEntity	The TableEntity to merge.
options	Optional parameters to execute this function.
context	for canceling long running operations.

Returns

Merge entity result.

QueryEntities()

Models::QueryEntitiesPagedResponse TableClient::QueryEntities	(	Models::QueryEntitiesOptions const &	options = {},
		Core::Context const &	context = {}
	)

Parameters

options	Optional parameters to execute this function.
context	for canceling long running operations.

Returns

Entity list paged response.

SetAccessPolicy()

Azure::Response< Models::SetTableAccessPolicyResult > TableClient::SetAccessPolicy	(	Models::TableAccessPolicy const &	tableAccessPolicy,
		Core::Context const &	context = {}
	)

Parameters

tableAccessPolicy	The TableAccessPolicy to set.
context	for canceling long running operations.

Returns

Set access policy result.

SubmitTransaction()

Azure::Response< Models::SubmitTransactionResult > TableClient::SubmitTransaction	(	Transaction &	transaction,
		Core::Context const &	context = {}
	)

Parameters

transaction	The transaction to submit.
context	for canceling long running operations.

Returns

Submit transaction result.

UpdateEntity()

Azure::Response< Models::UpdateEntityResult > TableClient::UpdateEntity	(	Models::TableEntity const &	tableEntity,
		Models::UpdateEntityOptions const &	options = {},
		Core::Context const &	context = {}
	)

Parameters

tableEntity	The TableEntity to set.
options	Optional parameters to execute this function.
context	for canceling long running operations.

Returns

Update entity result.

UpsertEntity()

Azure::Response< Models::UpsertEntityResult > TableClient::UpsertEntity	(	Models::TableEntity const &	tableEntity,
		Models::UpsertEntityOptions const &	options = {},
		Core::Context const &	context = {}
	)

Parameters

tableEntity	The TableEntity to upsert.
options	Optional parameters to execute this function.
context	for canceling long running operations.

Returns

Upsert entity result.

---

The documentation for this class was generated from the following files:

• inc/azure/data/tables/tables_clients.hpp
• src/tables_clients.cpp