.. role:: raw-html-m2r(raw)
:format: html
Azure Data Tables client library for Python
===========================================
Azure Data Tables is a NoSQL data storage service that can be accessed from anywhere in the world via authenticated calls using HTTP or HTTPS.
Tables scales as needed to support the amount of data inserted, and allow for the storing of data with non-complex accessing.
The Azure Data Tables client can be used to access Azure Storage or Cosmos accounts.
`Source code `_ | `Package (PyPI) `_ | `API reference documentation `_ | `Samples `_
Getting started
---------------
The Azure Data Tables SDK can access an Azure Storage or CosmosDB account.
Prerequisites
^^^^^^^^^^^^^
* Python 2.7, or 3.6 or later is required to use this package.
* You must have an `Azure subscription `_ and either
* an `Azure Storage account `_ or
* an `Azure Cosmos Account `_.
Create account
~~~~~~~~~~~~~~
* To create a new storage account, you can use `Azure Portal `_\ , `Azure PowerShell `_\ , or `Azure CLI `_\ :
* To create a new cosmos storage account, you can use the `Azure CLI `_ or `Azure Portal `_.
Install the package
^^^^^^^^^^^^^^^^^^^
Install the Azure Data Tables client library for Python with `pip `_\ :
.. code-block:: bash
pip install --pre azure-data-tables
Create the client
~~~~~~~~~~~~~~~~~
The Azure Data Tables library allows you to interact with two types of resources:
* the tables in your account
* the entities within those tables.
Interaction with these resources starts with an instance of a `client <#clients>`_. To create a client object, you will need the account's table service endpoint URL and a credential that allows you to access the account. The ``account_url`` can be found on the page for your storage account in the `Azure Portal `_ under the "Access Keys" section or by running the following Azure CLI command:
.. code-block:: bash
# Get the table service URL for the account
az storage account show -n mystorageaccount -g MyResourceGroup --query "primaryEndpoints.table"
Once you have the account URL, it can be used to create the service client:
.. code-block:: python
from azure.data.tables import TableServiceClient
service = TableServiceClient(account_url="https://.table.core.windows.net/", credential=credential)
For more information about table service URL's and how to configure custom domain names for Azure Storage check out the `official documentation `_
Types of credentials
~~~~~~~~~~~~~~~~~~~~
The ``credential`` parameter may be provided in a number of different forms, depending on the type of authorization you wish to use. The Tables library supports the following authorizations:
* Shared Key
* Connection String
* Shared Access Signature Token
Creating the client from a shared key
"""""""""""""""""""""""""""""""""""""
To use an account `shared key `_ (aka account key or access key), provide the key as a string. This can be found in your storage account in the `Azure Portal `_ under the "Access Keys" section or by running the following Azure CLI command:
.. code-block:: bash
az storage account keys list -g MyResourceGroup -n MyStorageAccount
Use the key as the credential parameter to authenticate the client:
.. code-block:: python
from azure.data.tables import TableServiceClient
service = TableServiceClient(account_url="https://.table.core.windows.net", credential="")
Creating the client from a connection string
""""""""""""""""""""""""""""""""""""""""""""
Depending on your use case and authorization method, you may prefer to initialize a client instance with a connection string instead of providing the account URL and credential separately. To do this, pass the
connection string to the client's ``from_connection_string`` class method. The connection string can be found in your storage account in the `Azure Portal `_ under the "Access Keys" section or with the following Azure CLI command:
.. code-block:: bash
az storage account show-connection-string -g MyResourceGroup -n MyStorageAccount
.. code-block:: python
from azure.data.tables import TableServiceClient
connection_string = "DefaultEndpointsProtocol=https;AccountName=;AccountKey=;EndpointSuffix=core.windows.net"
service = TableServiceClient.from_connection_string(conn_str=connection_string)
Creating the client from a SAS token
""""""""""""""""""""""""""""""""""""
To use a `shared access signature (SAS) token `_\ , provide the token as a string. If your account URL includes the SAS token, omit the credential parameter. You can generate a SAS token from the Azure Portal under `Shared access signature `_ or use one of the ``generate_*_sas()``
functions to create a sas token for the account or table:
.. code-block:: python
from datetime import datetime, timedelta
from azure.data.tables import TableServiceClient, generate_account_sas, ResourceTypes, AccountSasPermissions
sas_token = generate_account_sas(
account_name="",
account_key="",
resource_types=ResourceTypes(service=True),
permission=AccountSasPermissions(read=True),
expiry=datetime.utcnow() + timedelta(hours=1)
)
table_service_client = TableServiceClient(account_url="https://.table.core.windows.net", credential=sas_token)
Key concepts
------------
Common uses of the Table service included:
* Storing TBs of structured data capable of serving web scale applications
* Storing datasets that do not require complex joins, foreign keys, or stored procedures and can be de-normalized for fast access
* Quickly querying data using a clustered index
* Accessing data using the OData protocol and LINQ filter expressions
The following components make up the Azure Data Tables Service:
* The account
* A table within the account, which contains a set of entities
* An entity within a table, as a dictionary
The Azure Data Tables client library for Python allows you to interact with each of these components through the
use of a dedicated client object.
Clients
^^^^^^^
Two different clients are provided to interact with the various components of the Table Service:
#. **\ ``TableServiceClient``\ ** -
* Get and set account setting
* Query, create, and delete tables within the account.
* Get a ``TableClient`` to access a specific table using the ``get_table_client`` method.
#. **\ ``TableClient``\ ** -
* Interacts with a specific table (which need not exist yet).
* Create, delete, query, and upsert entities within the specified table.
* Create or delete the specified table itself.
Entities
^^^^^^^^
Entities are similar to rows. An entity has a **\ ``PartitionKey``\ **\ , a **\ ``RowKey``\ **\ , and a set of properties. A property is a name value pair, similar to a column. Every entity in a table does not need to have the same properties. Entities can be represented as dictionaries like this as an example:
.. code-block:: python
entity = {
'PartitionKey': 'color',
'RowKey': 'brand',
'text': 'Marker',
'color': 'Purple',
'price': '5'
}
* **\ `create_entity `_\ ** - Add an entity to the table.
* **\ `delete_entity `_\ ** - Delete an entity from the table.
* **\ `update_entity `_\ ** - Update an entity's information by either merging or replacing the existing entity.
* ``UpdateMode.MERGE`` will add new properties to an existing entity it will not delete an existing properties
* ``UpdateMode.REPLACE`` will replace the existing entity with the given one, deleting any existing properties not included in the submitted entity
* **\ `query_entities `_\ ** - Query existing entities in a table using `OData filters `_.
* **\ `get_entity `_\ ** - Get a specific entity from a table by partition and row key.
* **\ `upsert_entity `_\ ** - Merge or replace an entity in a table, or if the entity does not exist, inserts the entity.
* ``UpdateMode.MERGE`` will add new properties to an existing entity it will not delete an existing properties
* ``UpdateMode.REPLACE`` will replace the existing entity with the given one, deleting any existing properties not included in the submitted entity
Examples
--------
The following sections provide several code snippets covering some of the most common Table tasks, including:
* :raw-html-m2r:`Creating a table`
* :raw-html-m2r:`Creating entities`
* :raw-html-m2r:`Querying entities`
Creating a table
^^^^^^^^^^^^^^^^
Create a table in your account and get a ``TableClient`` to perform operations on the newly created table:
.. code-block:: python
from azure.data.tables import TableServiceClient
table_service_client = TableServiceClient.from_connection_string(conn_str="")
table_name = "myTable"
table_client = table_service_client.create_table(table_name=table_name)
Creating entities
^^^^^^^^^^^^^^^^^
Create entities in the table:
.. code-block:: python
from azure.data.tables import TableServiceClient
from datetime import datetime
PRODUCT_ID = u'001234'
PRODUCT_NAME = u'RedMarker'
my_entity = {
u'PartitionKey': PRODUCT_NAME,
u'RowKey': PRODUCT_ID,
u'Stock': 15,
u'Price': 9.99,
u'Comments': u"great product",
u'OnSale': True,
u'ReducedPrice': 7.99,
u'PurchaseDate': datetime(1973, 10, 4),
u'BinaryRepresentation': b'product_name'
}
table_service_client = TableServiceClient.from_connection_string(conn_str="")
table_client = table_service_client.get_table_client(table_name="myTable")
entity = table_client.create_entity(entity=my_entity)
Querying entities
^^^^^^^^^^^^^^^^^
Querying entities in the table:
.. code-block:: python
from azure.data.tables import TableClient
my_filter = "PartitionKey eq 'RedMarker'"
table_client = TableClient.from_connection_string(conn_str="", table_name="mytable")
entities = table_client.query_entities(filter=my_filter)
for entity in entities:
for key in entity.keys():
print("Key: {}, Value: {}".format(key, entity[key]))
Optional Configuration
----------------------
Optional keyword arguments can be passed in at the client and per-operation level. The azure-core `reference documentation `_ describes available configurations for retries, logging, transport protocols, and more.
Retry Policy configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^
Use the following keyword arguments when instantiating a client to configure the retry policy:
* **retry_total** (int): Total number of retries to allow. Takes precedence over other counts.
Pass in ``retry_total=0`` if you do not want to retry on requests. Defaults to 10.
* **retry_connect** (int): How many connection-related errors to retry on. Defaults to 3.
* **retry_read** (int): How many times to retry on read errors. Defaults to 3.
* **retry_status** (int): How many times to retry on bad status codes. Defaults to 3.
* **retry_to_secondary** (bool): Whether the request should be retried to secondary, if able.
This should only be enabled of RA-GRS accounts are used and potentially stale data can be handled.
Defaults to ``False``.
Other client / per-operation configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Other optional configuration keyword arguments that can be specified on the client or per-operation.
**Client keyword arguments:**
* **connection_timeout** (int): Optionally sets the connect and read timeout value, in seconds.
* **transport** (Any): User-provided transport to send the HTTP request.
**Per-operation keyword arguments:**
* **raw_response_hook** (callable): The given callback uses the response returned from the service.
* **raw_request_hook** (callable): The given callback uses the request before being sent to service.
* **client_request_id** (str): Optional user specified identification of the request.
* **user_agent** (str): Appends the custom value to the user-agent header to be sent with the request.
* **logging_enable** (bool): Enables logging at the DEBUG level. Defaults to False. Can also be passed in at
the client level to enable it for all requests.
* **headers** (dict): Pass in custom headers as key, value pairs. E.g. ``headers={'CustomValue': value}``
Troubleshooting
---------------
General
^^^^^^^
Azure Data Tables clients raise exceptions defined in `Azure Core `_.
When you interact with the Azure table library using the Python SDK, errors returned by the service respond ot the same HTTP status codes for `REST API `_ requests. The Table service operations will throw a ``HttpResponseError`` on failure with helpful `error codes `_.
For examples, if you try to create a table that already exists, a ``409`` error is returned indicating "Conflict".
.. code-block:: python
from azure.data.tables import TableServiceClient
from azure.core.exceptions import HttpResponseError
table_name = 'YourTableName'
service_client = TableServiceClient.from_connection_string(connection_string)
# Create the table if it does not already exist
tc = service_client.create_table_if_not_exists(table_name)
try:
service_client.create_table(table_name)
except HttpResponseError:
print("Table with name {} already exists".format(table_name))
Logging
^^^^^^^
This library uses the standard
`logging `_ library for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
level.
Detailed DEBUG level logging, including request/response bodies and unredacted
headers, can be enabled on a client with the ``logging_enable`` argument:
.. code-block:: python
import sys
import logging
from azure.data.tables import TableServiceClient
# Create a logger for the 'azure' SDK
logger = logging.getLogger('azure')
logger.setLevel(logging.DEBUG)
# Configure a console output
handler = logging.StreamHandler(stream=sys.stdout)
logger.addHandler(handler)
# This client will log detailed information about its HTTP sessions, at DEBUG level
service_client = TableServiceClient.from_connection_string("your_connection_string", logging_enable=True)
Similarly, ``logging_enable`` can enable detailed logging for a single operation,
even when it is not enabled for the client:
.. code-block:: python
service_client.create_entity(entity=my_entity, logging_enable=True)
Next steps
----------
Get started with our `Table samples `_.
Several Azure Data Tables Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Tables.
Common Scenarios
^^^^^^^^^^^^^^^^
These code samples show common scenario operations with the Azure Data tables client library. The async versions of the samples (the python sample files appended with _async) show asynchronous operations with Tables and require Python 3.5 or later.
* Create and delete tables: `sample_create_delete_table.py `_ (\ `async version `_\ )
* List and query tables: `sample_query_tables.py `_ (\ `async version `_\ )
* Insert and delete entities: `sample_insert_delete_entities.py `_ (\ `async version `_\ )
* Query and list entities: `sample_query_tables.py `_ (\ `async version `_\ )
* Update, upsert, and merge entities: `sample_update_upsert_merge_entities.py `_ (\ `async version `_\ )
* Committing many requests in a single batch: `sample_batching.py `_ (\ `async version `_\ )
Additional documentation
^^^^^^^^^^^^^^^^^^^^^^^^
For more extensive documentation on Azure Data Tables, see the `Azure Data Tables documentation `_ on docs.microsoft.com.
Known Issues
------------
A list of currently known issues relating to Cosmos DB table endpoints can be found `here `_.
Contributing
------------
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the `Microsoft Open Source Code of Conduct `_. For more information see the `Code of Conduct FAQ `_ or contact `opencode@microsoft.com `_ with any additional questions or comments.
:raw-html-m2r:``
.. image:: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python/sdk/tables/azure-data-tables/README.png
:target: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python/sdk/tables/azure-data-tables/README.png
:alt: Impressions
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. toctree::
:maxdepth: 5
:glob:
:caption: Developer Documentation
azure.data.tables.rst