azure.storage.table.tableservice module

class azure.storage.table.tableservice.TableService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)[source]

Bases: azure.storage.storageclient.StorageClient

This is the main class managing Azure Table resources.

The Azure Table service offers structured storage in the form of tables. Tables store data as collections of entities. Entities are similar to rows. An entity has a primary key and a set of properties. A property is a name, typed-value pair, similar to a column. The Table service does not enforce any schema for tables, so two entities in the same table may have different sets of properties. Developers may choose to enforce a schema on the client side. A table may contain any number of entities.

Variables:
  • key_encryption_key (object) – The key-encryption-key optionally provided by the user. If provided, will be used to encrypt/decrypt in supported methods. For methods requiring decryption, either the key_encryption_key OR the resolver must be provided. If both are provided, the resolver will take precedence. Must implement the following methods for APIs requiring encryption: wrap_key(key)–wraps the specified key (bytes) using an algorithm of the user’s choice. Returns the encrypted key as bytes. get_key_wrap_algorithm()–returns the algorithm used to wrap the specified symmetric key. get_kid()–returns a string key id for this key-encryption-key. Must implement the following methods for APIs requiring decryption: unwrap_key(key, algorithm)–returns the unwrapped form of the specified symmetric key using the string-specified algorithm. get_kid()–returns a string key id for this key-encryption-key.
  • key_resolver_function(kid) (function) – A function to resolve keys optionally provided by the user. If provided, will be used to decrypt in supported methods. For methods requiring decryption, either the key_encryption_key OR the resolver must be provided. If both are provided, the resolver will take precedence. It uses the kid string to return a key-encryption-key implementing the interface defined above.
  • row_key, property_name) encryption_resolver_functions (function(partition_key,) – A function that takes in an entity’s partition key, row key, and property name and returns a boolean that indicates whether that property should be encrypted.
  • require_encryption (bool) – A flag that may be set to ensure that all messages successfully uploaded to the queue and all those downloaded and successfully read from the queue are/were encrypted while on the server. If this flag is set, all required parameters for encryption/decryption must be provided. See the above comments on the key_encryption_key and resolver.
Parameters:
  • account_name (str) – The storage account name. This is used to authenticate requests signed with an account key and to construct the storage endpoint. It is required unless a connection string is given.
  • account_key (str) – The storage account key. This is used for shared key authentication.
  • sas_token (str) – A shared access signature token to use to authenticate requests instead of the account key. If account key and sas token are both specified, account key will be used to sign.
  • is_emulated (bool) – Whether to use the emulator. Defaults to False. If specified, will override all other parameters besides connection string and request session.
  • protocol (str) – The protocol to use for requests. Defaults to https.
  • endpoint_suffix (str) – The host base component of the url, minus the account name. Defaults to Azure (core.windows.net). Override this to use the China cloud (core.chinacloudapi.cn).
  • request_session (requests.Session) – The session object to use for http requests.
  • connection_string (str) – If specified, this will override all other parameters besides request session. See http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ for the connection string format.
  • socket_timeout (int) – If specified, this will override the default socket timeout. The timeout specified is in seconds. See DEFAULT_SOCKET_TIMEOUT in _constants.py for the default value.
batch(*args, **kwds)[source]

Creates a batch object which can be used as a context manager. Commits the batch on exit.

Parameters:
  • table_name (str) – The name of the table to commit the batch to.
  • timeout (int) – The server timeout, expressed in seconds.
commit_batch(table_name, batch, timeout=None)[source]

Commits a TableBatch request.

Parameters:
  • table_name (str) – The name of the table to commit the batch to.
  • batch (TableBatch) – The batch to commit.
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

A list of the batch responses corresponding to the requests in the batch.

Return type:

list of response objects

create_table(table_name, fail_on_exist=False, timeout=None)[source]

Creates a new table in the storage account.

Parameters:
  • table_name (str) – The name of the table to create. The table name may contain only alphanumeric characters and cannot begin with a numeric character. It is case-insensitive and must be from 3 to 63 characters long.
  • fail_on_exist (bool) – Specifies whether to throw an exception if the table already exists.
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

A boolean indicating whether the table was created. If fail_on_exist was set to True, this will throw instead of returning false.

Return type:

bool

delete_entity(table_name, partition_key, row_key, if_match='*', timeout=None)[source]

Deletes an existing entity in a table. Throws if the entity does not exist.

When an entity is successfully deleted, the entity is immediately marked for deletion and is no longer accessible to clients. The entity is later removed from the Table service during garbage collection.

Parameters:
  • table_name (str) – The name of the table containing the entity to delete.
  • partition_key (str) – The PartitionKey of the entity.
  • row_key (str) – The RowKey of the entity.
  • if_match (str) – The client may specify the ETag for the entity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The delete operation will be performed only if the ETag sent by the client matches the value maintained by the server, indicating that the entity has not been modified since it was retrieved by the client. To force an unconditional delete, set If-Match to the wildcard character (*).
  • timeout (int) – The server timeout, expressed in seconds.
delete_table(table_name, fail_not_exist=False, timeout=None)[source]

Deletes the specified table and any data it contains.

When a table is successfully deleted, it is immediately marked for deletion and is no longer accessible to clients. The table is later removed from the Table service during garbage collection.

Note that deleting a table is likely to take at least 40 seconds to complete. If an operation is attempted against the table while it was being deleted, an AzureConflictHttpError will be thrown.

Parameters:
  • table_name (str) – The name of the table to delete.
  • fail_not_exist (bool) – Specifies whether to throw an exception if the table doesn’t exist.
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

A boolean indicating whether the table was deleted. If fail_not_exist was set to True, this will throw instead of returning false.

Return type:

bool

exists(table_name, timeout=None)[source]

Returns a boolean indicating whether the table exists.

Parameters:
  • table_name (str) – The name of table to check for existence.
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

A boolean indicating whether the table exists.

Return type:

bool

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)[source]

Generates a shared access signature for the table service. Use the returned signature with the sas_token parameter of TableService.

Parameters:
  • resource_types (ResourceTypes) – Specifies the resource types that are accessible with the account SAS.
  • permission (AccountPermissions) – The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy.
  • expiry (date or str) – The time at which the shared access signature becomes invalid. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.
  • start (date or str) – The time at which the shared access signature becomes valid. If omitted, start time for this call is assumed to be the time when the storage service receives the request. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.
  • ip (str) – Specifies an IP address or a range of IP addresses from which to accept requests. If the IP address from which the request originates does not match the IP address or address range specified on the SAS token, the request is not authenticated. For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses.
  • protocol (str) – Specifies the protocol permitted for a request made. The default value is https,http. See Protocol for possible values.
Returns:

A Shared Access Signature (sas) token.

Return type:

str

generate_table_shared_access_signature(table_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, start_pk=None, start_rk=None, end_pk=None, end_rk=None)[source]

Generates a shared access signature for the table. Use the returned signature with the sas_token parameter of TableService.

Parameters:
  • table_name (str) – The name of the table to create a SAS token for.
  • permission (TablePermissions) – The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy.
  • expiry (date or str) – The time at which the shared access signature becomes invalid. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.
  • start (date or str) – The time at which the shared access signature becomes valid. If omitted, start time for this call is assumed to be the time when the storage service receives the request. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.
  • id (str) – A unique value up to 64 characters in length that correlates to a stored access policy. To create a stored access policy, use set_table_acl().
  • ip (str) – Specifies an IP address or a range of IP addresses from which to accept requests. If the IP address from which the request originates does not match the IP address or address range specified on the SAS token, the request is not authenticated. For example, specifying sip=‘168.1.5.65’ or sip=‘168.1.5.60-168.1.5.70’ on the SAS restricts the request to those IP addresses.
  • protocol (str) – Specifies the protocol permitted for a request made. The default value is https,http. See Protocol for possible values.
  • start_pk (str) – The minimum partition key accessible with this shared access signature. startpk must accompany startrk. Key values are inclusive. If omitted, there is no lower bound on the table entities that can be accessed.
  • start_rk (str) – The minimum row key accessible with this shared access signature. startpk must accompany startrk. Key values are inclusive. If omitted, there is no lower bound on the table entities that can be accessed.
  • end_pk (str) – The maximum partition key accessible with this shared access signature. endpk must accompany endrk. Key values are inclusive. If omitted, there is no upper bound on the table entities that can be accessed.
  • end_rk (str) – The maximum row key accessible with this shared access signature. endpk must accompany endrk. Key values are inclusive. If omitted, there is no upper bound on the table entities that can be accessed.
Returns:

A Shared Access Signature (sas) token.

Return type:

str

get_entity(table_name, partition_key, row_key, select=None, accept='application/json;odata=minimalmetadata', property_resolver=None, timeout=None)[source]

Get an entity from the specified table. Throws if the entity does not exist.

Parameters:
  • table_name (str) – The name of the table to get the entity from.
  • partition_key (str) – The PartitionKey of the entity.
  • row_key (str) – The RowKey of the entity.
  • select (str) – Returns only the desired properties of an entity from the set.
  • accept (str) – Specifies the accepted content type of the response payload. See TablePayloadFormat for possible values.
  • property_resolver (callback function in format of func(pk, rk, prop_name, prop_value, service_edm_type)) – A function which given the partition key, row key, property name, property value, and the property EdmType if returned by the service, returns the EdmType of the property. Generally used if accept is set to JSON_NO_METADATA.
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

The retrieved entity.

Return type:

Entity

get_table_acl(table_name, timeout=None)[source]

Returns details about any stored access policies specified on the table that may be used with Shared Access Signatures.

Parameters:
  • table_name (str) – The name of an existing table.
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

A dictionary of access policies associated with the table.

Return type:

dict of str to AccessPolicy:

get_table_service_properties(timeout=None)[source]

Gets the properties of a storage account’s Table service, including logging, analytics and CORS rules.

Parameters:timeout (int) – The server timeout, expressed in seconds.
Returns:The table service properties.
Return type:ServiceProperties
get_table_service_stats(timeout=None)[source]

Retrieves statistics related to replication for the Table service. It is only available when read-access geo-redundant replication is enabled for the storage account.

With geo-redundant replication, Azure Storage maintains your data durable in two locations. In both locations, Azure Storage constantly maintains multiple healthy replicas of your data. The location where you read, create, update, or delete data is the primary storage account location. The primary location exists in the region you choose at the time you create an account via the Azure Management Azure classic portal, for example, North Central US. The location to which your data is replicated is the secondary location. The secondary location is automatically determined based on the location of the primary; it is in a second data center that resides in the same region as the primary location. Read-only access is available from the secondary location, if read-access geo-redundant replication is enabled for your storage account.

Parameters:timeout (int) – The timeout parameter is expressed in seconds.
Returns:The table service stats.
Return type:ServiceStats
insert_entity(table_name, entity, timeout=None)[source]

Inserts a new entity into the table. Throws if an entity with the same PartitionKey and RowKey already exists.

When inserting an entity into a table, you must specify values for the PartitionKey and RowKey system properties. Together, these properties form the primary key and must be unique within the table. Both the PartitionKey and RowKey values must be string values; each key value may be up to 64 KB in size. If you are using an integer value for the key value, you should convert the integer to a fixed-width string, because they are canonically sorted. For example, you should convert the value 1 to 0000001 to ensure proper sorting.

Parameters:
  • table_name (str) – The name of the table to insert the entity into.
  • entity (a dict or Entity) – The entity to insert. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

The etag of the inserted entity.

Return type:

str

insert_or_merge_entity(table_name, entity, timeout=None)[source]

Merges an existing entity or inserts a new entity if it does not exist in the table.

If insert_or_merge_entity is used to merge an entity, any properties from the previous entity will be retained if the request does not define or include them.

Parameters:
  • table_name (str) – The name of the table in which to insert or merge the entity.
  • entity (a dict or Entity) – The entity to insert or merge. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

The etag of the entity.

Return type:

str

insert_or_replace_entity(table_name, entity, timeout=None)[source]

Replaces an existing entity or inserts a new entity if it does not exist in the table. Because this operation can insert or update an entity, it is also known as an “upsert” operation.

If insert_or_replace_entity is used to replace an entity, any properties from the previous entity will be removed if the new entity does not define them.

Parameters:
  • table_name (str) – The name of the table in which to insert or replace the entity.
  • entity (a dict or Entity) – The entity to insert or replace. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

The etag of the entity.

Return type:

str

list_tables(num_results=None, marker=None, timeout=None)[source]

Returns a generator to list the tables. The generator will lazily follow the continuation tokens returned by the service and stop when all tables have been returned or num_results is reached.

If num_results is specified and the account has more than that number of tables, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired.

Parameters:
  • num_results (int) – The maximum number of tables to return.
  • marker (obj) – An opaque continuation object. This value can be retrieved from the next_marker field of a previous generator object if num_results was specified and that generator has finished enumerating results. If specified, this generator will begin returning results from the point where the previous generator stopped.
  • timeout (int) – The server timeout, expressed in seconds. This function may make multiple calls to the service in which case the timeout value specified will be applied to each individual call.
Returns:

A generator which produces Table objects.

Return type:

ListGenerator:

merge_entity(table_name, entity, if_match='*', timeout=None)[source]

Updates an existing entity by merging the entity’s properties. Throws if the entity does not exist.

This operation does not replace the existing entity as the update_entity operation does. A property cannot be removed with merge_entity.

Any properties with null values are ignored. All other properties will be updated or added.

Parameters:
  • table_name (str) – The name of the table containing the entity to merge.
  • entity (a dict or Entity) – The entity to merge. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.
  • if_match (str) – The client may specify the ETag for the entity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The merge operation will be performed only if the ETag sent by the client matches the value maintained by the server, indicating that the entity has not been modified since it was retrieved by the client. To force an unconditional merge, set If-Match to the wildcard character (*).
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

The etag of the entity.

Return type:

str

query_entities(table_name, filter=None, select=None, num_results=None, marker=None, accept='application/json;odata=minimalmetadata', property_resolver=None, timeout=None)[source]

Returns a generator to list the entities in the table specified. The generator will lazily follow the continuation tokens returned by the service and stop when all entities have been returned or max_results is reached.

If max_results is specified and the account has more than that number of entities, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired.

Parameters:
  • table_name (str) – The name of the table to query.
  • filter (str) – Returns only entities that satisfy the specified filter. Note that no more than 15 discrete comparisons are permitted within a $filter string. See http://msdn.microsoft.com/en-us/library/windowsazure/dd894031.aspx for more information on constructing filters.
  • select (str) – Returns only the desired properties of an entity from the set.
  • num_results (int) – The maximum number of entities to return.
  • marker (obj) – An opaque continuation object. This value can be retrieved from the next_marker field of a previous generator object if max_results was specified and that generator has finished enumerating results. If specified, this generator will begin returning results from the point where the previous generator stopped.
  • accept (str) – Specifies the accepted content type of the response payload. See TablePayloadFormat for possible values.
  • property_resolver (callback function in format of func(pk, rk, prop_name, prop_value, service_edm_type)) – A function which given the partition key, row key, property name, property value, and the property EdmType if returned by the service, returns the EdmType of the property. Generally used if accept is set to JSON_NO_METADATA.
  • timeout (int) – The server timeout, expressed in seconds. This function may make multiple calls to the service in which case the timeout value specified will be applied to each individual call.
Returns:

A generator which produces Entity objects.

Return type:

ListGenerator

set_table_acl(table_name, signed_identifiers=None, timeout=None)[source]

Sets stored access policies for the table that may be used with Shared Access Signatures.

When you set permissions for a table, the existing permissions are replaced. To update the table’s permissions, call get_table_acl() to fetch all access policies associated with the table, modify the access policy that you wish to change, and then call this function with the complete set of data to perform the update.

When you establish a stored access policy on a table, it may take up to 30 seconds to take effect. During this interval, a shared access signature that is associated with the stored access policy will throw an AzureHttpError until the access policy becomes active.

Parameters:
  • table_name (str) – The name of an existing table.
  • signed_identifiers (dict of str to AccessPolicy) – A dictionary of access policies to associate with the table. The dictionary may contain up to 5 elements. An empty dictionary will clear the access policies set on the service.
  • timeout (int) – The server timeout, expressed in seconds.
set_table_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, timeout=None)[source]

Sets the properties of a storage account’s Table service, including Azure Storage Analytics. If an element (ex Logging) is left as None, the existing settings on the service for that functionality are preserved. For more information on Azure Storage Analytics, see https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx.

Parameters:
  • logging (Logging) – The logging settings provide request logs.
  • hour_metrics (Metrics) – The hour metrics settings provide a summary of request statistics grouped by API in hourly aggregates for tables.
  • minute_metrics (Metrics) – The minute metrics settings provide request statistics for each minute for tables.
  • cors (list of CorsRule) – You can include up to five CorsRule elements in the list. If an empty list is specified, all CORS rules will be deleted, and CORS will be disabled for the service. For detailed information about CORS rules and evaluation logic, see https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx.
  • timeout (int) – The server timeout, expressed in seconds.
update_entity(table_name, entity, if_match='*', timeout=None)[source]

Updates an existing entity in a table. Throws if the entity does not exist. The update_entity operation replaces the entire entity and can be used to remove properties.

Parameters:
  • table_name (str) – The name of the table containing the entity to update.
  • entity (a dict or Entity) – The entity to update. Could be a dict or an entity object. Must contain a PartitionKey and a RowKey.
  • if_match (str) – The client may specify the ETag for the entity on the request in order to compare to the ETag maintained by the service for the purpose of optimistic concurrency. The update operation will be performed only if the ETag sent by the client matches the value maintained by the server, indicating that the entity has not been modified since it was retrieved by the client. To force an unconditional update, set If-Match to the wildcard character (*).
  • timeout (int) – The server timeout, expressed in seconds.
Returns:

The etag of the entity.

Return type:

str