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++.
|
Represents a table object in the Table service. More...
Public Member Functions | |
cloud_table () | |
Initializes a new instance of the azure::storage::cloud_table class. More... | |
WASTORAGE_API | cloud_table (const storage_uri &uri) |
Initializes a new instance of the azure::storage::cloud_table class using an absolute URI to the table. More... | |
WASTORAGE_API | cloud_table (const storage_uri &uri, storage_credentials credentials) |
Initializes a new instance of the azure::storage::cloud_table class using an absolute URI to the table. More... | |
table_result | execute (const table_operation &operation) const |
Executes an operation on a table. More... | |
table_result | execute (const table_operation &operation, const table_request_options &options, operation_context context) const |
Executes an operation on a table. More... | |
pplx::task< table_result > | execute_async (const table_operation &operation) const |
Intitiates an asynchronous operation that executes an operation on a table. More... | |
WASTORAGE_API pplx::task< table_result > | execute_async (const table_operation &operation, const table_request_options &options, operation_context context) const |
Intitiates an asynchronous operation that executes an operation on a table. More... | |
std::vector< table_result > | execute_batch (const table_batch_operation &operation) const |
Executes a batch operation on a table as an atomic operation. More... | |
std::vector< table_result > | execute_batch (const table_batch_operation &operation, const table_request_options &options, operation_context context) const |
Executes a batch operation on a table as an atomic operation. More... | |
pplx::task< std::vector< table_result > > | execute_batch_async (const table_batch_operation &operation) const |
Intitiates an asynchronous operation that executes a batch operation on a table as an atomic operation. More... | |
WASTORAGE_API pplx::task< std::vector< table_result > > | execute_batch_async (const table_batch_operation &operation, const table_request_options &options, operation_context context) const |
Intitiates an asynchronous operation that executes a batch operation on a table as an atomic operation. More... | |
table_query_iterator | execute_query (const table_query &query) const |
Executes a query on a table. More... | |
WASTORAGE_API table_query_iterator | execute_query (const table_query &query, const table_request_options &options, operation_context context) const |
Executes a query on a table. More... | |
table_query_segment | execute_query_segmented (const table_query &query, const continuation_token &token) const |
Executes a query with the specified azure::storage::continuation_token to retrieve the next page of results. More... | |
table_query_segment | execute_query_segmented (const table_query &query, const continuation_token &token, const table_request_options &options, operation_context context) const |
Executes a query with the specified azure::storage::continuation_token to retrieve the next page of results. More... | |
pplx::task< table_query_segment > | execute_query_segmented_async (const table_query &query, const continuation_token &token) const |
Intitiates an asynchronous operation that executes a query with the specified azure::storage::continuation_token to retrieve the next page of results. More... | |
WASTORAGE_API pplx::task< table_query_segment > | execute_query_segmented_async (const table_query &query, const continuation_token &token, const table_request_options &options, operation_context context) const |
Intitiates an asynchronous operation that executes a query with the specified azure::storage::continuation_token to retrieve the next page of results. More... | |
void | create () |
Creates a table. More... | |
void | create (const table_request_options &options, operation_context context) |
Creates a table. More... | |
pplx::task< void > | create_async () |
Intitiates an asynchronous operation that creates a table. More... | |
WASTORAGE_API pplx::task< void > | create_async (const table_request_options &options, operation_context context) |
Intitiates an asynchronous operation that creates a table. More... | |
bool | create_if_not_exists () |
Creates the table if it does not already exist. More... | |
bool | create_if_not_exists (const table_request_options &options, operation_context context) |
Creates the table if it does not already exist. More... | |
pplx::task< bool > | create_if_not_exists_async () |
Returns a task to create the table if it does not already exist. More... | |
WASTORAGE_API pplx::task< bool > | create_if_not_exists_async (const table_request_options &options, operation_context context) |
Returns a task to create the table if it does not already exist. More... | |
void | delete_table () |
Deletes a table. More... | |
void | delete_table (const table_request_options &options, operation_context context) |
Deletes a table. More... | |
pplx::task< void > | delete_table_async () |
Intitiates an asynchronous operation that deletes a table. More... | |
WASTORAGE_API pplx::task< void > | delete_table_async (const table_request_options &options, operation_context context) |
Intitiates an asynchronous operation that deletes a table. More... | |
bool | delete_table_if_exists () |
Deletes the table if it exists. More... | |
bool | delete_table_if_exists (const table_request_options &options, operation_context context) |
Deletes the table if it exists. More... | |
pplx::task< bool > | delete_table_if_exists_async () |
Intitiates an asynchronous operation that deletes the table if it exists. More... | |
WASTORAGE_API pplx::task< bool > | delete_table_if_exists_async (const table_request_options &options, operation_context context) |
Intitiates an asynchronous operation that deletes the table if it exists. More... | |
bool | exists () const |
Checks whether the table exists. More... | |
bool | exists (const table_request_options &options, operation_context context) const |
Checks whether the table exists. More... | |
pplx::task< bool > | exists_async () const |
Intitiates an asynchronous operation that checks whether the table exists. More... | |
WASTORAGE_API pplx::task< bool > | exists_async (const table_request_options &options, operation_context context) const |
Intitiates an asynchronous operation that checks whether the table exists. More... | |
table_permissions | download_permissions () const |
Gets the permissions settings for the table. More... | |
table_permissions | download_permissions (const table_request_options &options, operation_context context) const |
Gets the permissions settings for the table. More... | |
pplx::task< table_permissions > | download_permissions_async () const |
Intitiates an asynchronous operation that gets the permissions settings for the table. More... | |
WASTORAGE_API pplx::task< table_permissions > | download_permissions_async (const table_request_options &options, operation_context context) const |
Intitiates an asynchronous operation that gets the permissions settings for the table. More... | |
void | upload_permissions (const table_permissions &permissions) |
Sets permissions for the table. More... | |
void | upload_permissions (const table_permissions &permissions, const table_request_options &options, operation_context context) |
Sets permissions for the table. More... | |
pplx::task< void > | upload_permissions_async (const table_permissions &permissions) |
Intitiates an asynchronous operation that sets permissions for the table. More... | |
WASTORAGE_API pplx::task< void > | upload_permissions_async (const table_permissions &permissions, const table_request_options &options, operation_context context) |
Intitiates an asynchronous operation that sets permissions for the table. More... | |
utility::string_t | get_shared_access_signature (const table_shared_access_policy &policy) const |
Returns a shared access signature for the table. More... | |
utility::string_t | get_shared_access_signature (const table_shared_access_policy &policy, const utility::string_t &stored_policy_identifier) const |
Returns a shared access signature for the table. More... | |
WASTORAGE_API utility::string_t | get_shared_access_signature (const table_shared_access_policy &policy, const utility::string_t &stored_policy_identifier, const utility::string_t &start_partition_key, const utility::string_t &start_row_key, const utility::string_t &end_partition_key, const utility::string_t &end_row_key) const |
Returns a shared access signature for the table. More... | |
const cloud_table_client & | service_client () const |
Gets the azure::storage::cloud_table_client object that represents the Table service. More... | |
const utility::string_t & | name () const |
Gets the table name. More... | |
const storage_uri & | uri () const |
Gets the table URI for all locations. More... | |
Represents a table object in the Table service.
|
inline |
Initializes a new instance of the azure::storage::cloud_table class.
WASTORAGE_API azure::storage::cloud_table::cloud_table | ( | const storage_uri & | uri | ) |
Initializes a new instance of the azure::storage::cloud_table class using an absolute URI to the table.
uri | An azure::storage::storage_uri object containing the absolute URI to the table for all locations. |
WASTORAGE_API azure::storage::cloud_table::cloud_table | ( | const storage_uri & | uri, |
storage_credentials | credentials | ||
) |
Initializes a new instance of the azure::storage::cloud_table class using an absolute URI to the table.
uri | An azure::storage::storage_uri object containing the absolute URI to the table for all locations. |
credentials | The azure::storage::storage_credentials to use. |
|
inline |
Creates a table.
|
inline |
Creates a table.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Intitiates an asynchronous operation that creates a table.
WASTORAGE_API pplx::task<void> azure::storage::cloud_table::create_async | ( | const table_request_options & | options, |
operation_context | context | ||
) |
Intitiates an asynchronous operation that creates a table.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Creates the table if it does not already exist.
true
if table was created; otherwise, false
.
|
inline |
Creates the table if it does not already exist.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
true
if table was created; otherwise, false
.
|
inline |
Returns a task to create the table if it does not already exist.
WASTORAGE_API pplx::task<bool> azure::storage::cloud_table::create_if_not_exists_async | ( | const table_request_options & | options, |
operation_context | context | ||
) |
Returns a task to create the table if it does not already exist.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Deletes a table.
|
inline |
Deletes a table.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Intitiates an asynchronous operation that deletes a table.
WASTORAGE_API pplx::task<void> azure::storage::cloud_table::delete_table_async | ( | const table_request_options & | options, |
operation_context | context | ||
) |
Intitiates an asynchronous operation that deletes a table.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Deletes the table if it exists.
true
if the table was deleted; otherwise, false
.
|
inline |
Deletes the table if it exists.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
true
if the table was deleted; otherwise, false
.
|
inline |
Intitiates an asynchronous operation that deletes the table if it exists.
WASTORAGE_API pplx::task<bool> azure::storage::cloud_table::delete_table_if_exists_async | ( | const table_request_options & | options, |
operation_context | context | ||
) |
Intitiates an asynchronous operation that deletes the table if it exists.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Gets the permissions settings for the table.
|
inline |
Gets the permissions settings for the table.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. |
|
inline |
Intitiates an asynchronous operation that gets the permissions settings for the table.
WASTORAGE_API pplx::task<table_permissions> azure::storage::cloud_table::download_permissions_async | ( | const table_request_options & | options, |
operation_context | context | ||
) | const |
Intitiates an asynchronous operation that gets the permissions settings for the table.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. |
|
inline |
Executes an operation on a table.
operation | An azure::storage::table_operation object that represents the operation to perform. |
|
inline |
Executes an operation on a table.
operation | An azure::storage::table_operation object that represents the operation to perform. |
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Intitiates an asynchronous operation that executes an operation on a table.
operation | An azure::storage::table_operation object that represents the operation to perform. |
WASTORAGE_API pplx::task<table_result> azure::storage::cloud_table::execute_async | ( | const table_operation & | operation, |
const table_request_options & | options, | ||
operation_context | context | ||
) | const |
Intitiates an asynchronous operation that executes an operation on a table.
operation | An azure::storage::table_operation object that represents the operation to perform. |
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Executes a batch operation on a table as an atomic operation.
operation | An azure::storage::table_batch_operation object that represents the operation to perform. |
|
inline |
Executes a batch operation on a table as an atomic operation.
operation | An azure::storage::table_batch_operation object that represents the operation to perform. |
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Intitiates an asynchronous operation that executes a batch operation on a table as an atomic operation.
operation | An azure::storage::table_batch_operation object that represents the operation to perform. |
WASTORAGE_API pplx::task<std::vector<table_result> > azure::storage::cloud_table::execute_batch_async | ( | const table_batch_operation & | operation, |
const table_request_options & | options, | ||
operation_context | context | ||
) | const |
Intitiates an asynchronous operation that executes a batch operation on a table as an atomic operation.
operation | An azure::storage::table_batch_operation object that represents the operation to perform. |
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Executes a query on a table.
query | An azure::storage::table_query object. |
WASTORAGE_API table_query_iterator azure::storage::cloud_table::execute_query | ( | const table_query & | query, |
const table_request_options & | options, | ||
operation_context | context | ||
) | const |
Executes a query on a table.
query | An azure::storage::table_query object. |
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Executes a query with the specified azure::storage::continuation_token to retrieve the next page of results.
query | An azure::storage::table_query object. |
token | An azure::storage::continuation_token object. |
|
inline |
Executes a query with the specified azure::storage::continuation_token to retrieve the next page of results.
query | An azure::storage::table_query object. |
token | An azure::storage::continuation_token object. |
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Intitiates an asynchronous operation that executes a query with the specified azure::storage::continuation_token to retrieve the next page of results.
query | An azure::storage::table_query object. |
token | An azure::storage::continuation_token object. |
WASTORAGE_API pplx::task<table_query_segment> azure::storage::cloud_table::execute_query_segmented_async | ( | const table_query & | query, |
const continuation_token & | token, | ||
const table_request_options & | options, | ||
operation_context | context | ||
) | const |
Intitiates an asynchronous operation that executes a query with the specified azure::storage::continuation_token to retrieve the next page of results.
query | An azure::storage::table_query object. |
token | An azure::storage::continuation_token object. |
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Checks whether the table exists.
true
if table exists; otherwise, false
.
|
inline |
Checks whether the table exists.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
true
if table exists; otherwise, false
.
|
inline |
Intitiates an asynchronous operation that checks whether the table exists.
WASTORAGE_API pplx::task<bool> azure::storage::cloud_table::exists_async | ( | const table_request_options & | options, |
operation_context | context | ||
) | const |
Intitiates an asynchronous operation that checks whether the table exists.
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. |
|
inline |
Returns a shared access signature for the table.
policy | The azure::storage::table_shared_access_policy for the shared access signature. |
|
inline |
Returns a shared access signature for the table.
policy | The azure::storage::table_shared_access_policy for the shared access signature. |
stored_policy_identifier | A string identifying a table-level access policy. |
WASTORAGE_API utility::string_t azure::storage::cloud_table::get_shared_access_signature | ( | const table_shared_access_policy & | policy, |
const utility::string_t & | stored_policy_identifier, | ||
const utility::string_t & | start_partition_key, | ||
const utility::string_t & | start_row_key, | ||
const utility::string_t & | end_partition_key, | ||
const utility::string_t & | end_row_key | ||
) | const |
Returns a shared access signature for the table.
policy | The azure::storage::table_shared_access_policy for the shared access signature. |
stored_policy_identifier | A string identifying a table-level access policy. |
start_partition_key | A string specifying the start partition key. |
start_row_key | A string specifying the start row key. |
end_partition_key | A string specifying the end partition key. |
end_row_key | A string specifying the end row key. |
|
inline |
Gets the table name.
|
inline |
Gets the azure::storage::cloud_table_client object that represents the Table service.
|
inline |
Sets permissions for the table.
permissions | An azure::storage::table_permissions object. |
|
inline |
Sets permissions for the table.
permissions | An azure::storage::table_permissions object. |
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. |
|
inline |
Intitiates an asynchronous operation that sets permissions for the table.
permissions | An azure::storage::table_permissions object. |
WASTORAGE_API pplx::task<void> azure::storage::cloud_table::upload_permissions_async | ( | const table_permissions & | permissions, |
const table_request_options & | options, | ||
operation_context | context | ||
) |
Intitiates an asynchronous operation that sets permissions for the table.
permissions | An azure::storage::table_permissions object. |
options | An azure::storage::table_request_options object that specifies additional options for the request. |
context | An azure::storage::operation_context object that represents the context for the current operation. |
|
inline |
Gets the table URI for all locations.