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::NamedKeyCredential > credential, std::string url, const TableClientOptions &options={})
	Initializes a new instance of tableClient.
	TableClient (const std::string &serviceUrl, std::shared_ptr< Azure::Data::Tables::Credentials::AzureSasCredential > credential, const std::string &tableName, const TableClientOptions &options={})
	Initializes a new instance of tableClient.
Response< Models::TableAccessPolicy >	GetAccessPolicy (Core::Context const &context={})
	Retrieves details about any stored access policies specified on the table that may be used with Shared Access Signatures.
Response< Models::SetTableAccessPolicyResult >	SetAccessPolicy (Models::TableAccessPolicy const &tableAccessPolicy, Core::Context const &context={})
	Sets stored access policies for the table that may be used with Shared Access Signatures.
Response< Models::AddEntityResult >	AddEntity (Models::TableEntity const &tableEntity, Models::AddEntityOptions const &options={}, Core::Context const &context={})
	Add entity in a table.
Response< Models::UpdateEntityResult >	UpdateEntity (Models::TableEntity const &tableEntity, Models::UpdateEntityOptions const &options={}, Core::Context const &context={})
	Update entity in a table.
Response< Models::MergeEntityResult >	MergeEntity (Models::TableEntity const &tableEntity, Models::MergeEntityOptions const &options={}, Core::Context const &context={})
	Merge entity in a table.
Response< Models::DeleteEntityResult >	DeleteEntity (Models::TableEntity const &tableEntity, Core::Context const &context={})
	Deletes the specified entity in a table.
Response< Models::UpsertEntityResult >	UpsertEntity (Models::TableEntity const &tableEntity, Models::UpsertEntityOptions const &options={}, Core::Context const &context={})
	Upsert specified entity in a table.
Models::QueryEntitiesPagedResponse	QueryEntities (Models::QueryEntitiesOptions const &options={}, Core::Context const &context={})
	Queries entities in a table.
Response< Models::TableEntity >	GetEntity (const std::string &partitionKey, const std::string &rowKey, Core::Context const &context={})
	Queries a single entity in a table.
Response< Models::SubmitTransactionResult >	SubmitTransaction (std::vector< Models::TransactionStep > const &steps, 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/4]

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/4]

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/4]

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

explicit

Parameters

tableName	The name of the table.
credential	The named 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.

TableClient() [4/4]

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

explicit

Parameters

serviceUrl	The service Url
credential	The SAS credential used to sign requests.
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.

Member Function Documentation

AddEntity()

Azure::Response< Models::AddEntityResult > TableClient::AddEntity	(	Models::TableEntity const &	tableEntity,
		Models::AddEntityOptions 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

Add 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.

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.

GetEntity()

Azure::Response< Models::TableEntity > TableClient::GetEntity	(	const std::string &	partitionKey,
		const std::string &	rowKey,
		Core::Context const &	context = {}
	)

Parameters

partitionKey	The partition key of the entity.
rowKey	The row key of the entity.
context	for canceling long running operations.

Returns

Table entity.

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	(	std::vector< Models::TransactionStep > const &	steps,
		Core::Context const &	context = {}
	)

Parameters

steps	the transaction steps to execute.
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