Update readme samples

sdk/tables/azure-data-tables/azure/__init__.py

@@ -1 +1 @@
-__path__ = __import__('pkgutil').extend_path(__path__, __name__)  # type: str
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)  # type: ignore

sdk/tables/azure-data-tables/azure/data/__init__.py

@@ -1 +1 @@
-__path__ = __import__('pkgutil').extend_path(__path__, __name__)  # type: str
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)  # type: ignore

sdk/tables/azure-data-tables/samples/README.md

@@ -0,0 +1,81 @@
+---
+page_type: sample
+languages:
+  - python
+products:
+  - azure
+  - azure-table-storage
+urlFragment: tables-samples
+---
+
+# Samples for Azure Tables client library for Python
+
+These code samples show common scenario operations with the Azure Data Tables client library.
+The async versions of the samples require Python 3.5 or later.
+
+You can authenticate your client with a Tables API key:
+* See [sample_authentication.py][sample_authentication] and [sample_authentication_async.py][sample_authentication_async] for how to authenticate in the above cases.
+
+These sample programs show common scenarios for the Tables client's offerings.
+
+|**File Name**|**Description**|
+|-------------|---------------|
+|[sample_authentication.py][sample_authentication] and [sample_authentication_async.py][sample_authentication_async]|Different authorization methods|
+|[sample_create_client.py][create_client] and [sample_create_client_async.py][create_client_async]|Instantiate a table client|Authorizing a `TableServiceClient` object and `TableClient` object|
+|[sample_create_delete_table.py][create_delete_table] and [sample_create_delete_table_async.py][create_delete_table_async]|Creating a table in a storage account|
+|[sample_insert_delete_entities.py][insert_delete_entities] and [sample_insert_delete_entities_async.py][insert_delete_entities_async]|Inserting and deleting individual entities into a table|
+|[sample_query_tables.py][query_tables] and [sample_query_tables_async.py][query_tables_async]|Querying tables in a storage account|
+|[sample_update_upsert_merge_entities.py][update_upsert_merge] and [sample_update_upsert_merge_entities_async.py][update_upsert_merge_async]| Updating, upserting, and merging entities|
+
+
+### Prerequisites
+* Python 2.7, or 3.5 or later is required to use this package.
+* You must have an [Azure subscription](https://azure.microsoft.com/free/) and an
+[Azure storage account](https://docs.microsoft.com/azure/storage/common/storage-account-overview) to use this package
+ or you must have a [Azure Cosmos Account](https://docs.microsoft.com/azure/cosmos-db/account-overview).
+
+## Setup
+
+1. Install the Azure Data Tables client library for Python with [pip](https://pypi.org/project/pip/):
+```bash
+pip install --pre azure-data-tables
+```
+2. Clone or download this sample repository
+3. Open the sample folder in Visual Studio Code or your IDE of choice.
+
+## Running the samples
+
+1. Open a terminal window and `cd` to the directory that the samples are saved in.
+2. Set the environment variables specified in the sample file you wish to run.
+3. Follow the usage described in the file, e.g. `python sample_create_table.py`
+
+## Next steps
+
+Check out the [API reference documentation][api_reference_documentation] to learn more about
+what you can do with the Azure Data Tables client library.
+
+
+<!-- LINKS -->
+[api_reference_documentation]: https://aka.ms/azsdk/python/tables/docs
+
+[sample_authentication]:https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/sample_authentication.py
+[sample_authentication_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/async_samples/sample_authentication_async.py
+
+[create_client]:https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/sample_create_client.py
+[create_client_async]:https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/async_samples/sample_create_client_async.py
+
+[create_delete_table]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/sample_create_delete_table.py
+[create_delete_table_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/async_samples/sample_create_delete_table_async.py
+
+[insert_delete_entities]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/sample_insert_delete_entities.py
+[insert_delete_entities_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/async_samples/sample_insert_delete_entities_async.py
+
+[query_entities]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/sample_query_table.py
+[query_table_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/async_samples/sample_query_table_async.py
+
+[query_tables]:https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/sample_query_tables.py
+[query_tables_async]:https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/async_samples/sample_query_tables_async.py
+
+[update_upsert_merge]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/sample_update_upsert_merge_entities.py
+[update_upsert_merge_async]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/tables/azure-data-tables/samples/async_samples/sample_update_upsert_merge_entities_async.py
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python/sdk/tables/azure-data-tables/README.png)

sdk/tables/azure-data-tables/samples/async_samples/sample_authentication_async.py

@@ -0,0 +1,86 @@
+# coding: utf-8
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: table_samples_authentication.py
+
+DESCRIPTION:
+    These samples demonstrate authenticating a client via:
+        * connection string
+        * shared access key
+        * generating a sas token with which the returned signature can be used with
+    the credential parameter of any TableServiceClient or TableClient
+
+USAGE:
+    python table_samples_authentication.py
+
+    Set the environment variables with your own values before running the sample:
+    1) AZURE_STORAGE_CONNECTION_STRING - the connection string to your storage account
+    2) AZURE_STORAGE_ACCOUNT_URL - the Table service account URL
+    3) AZURE_STORAGE_ACCOUNT_NAME - the name of the storage account
+    4) AZURE_STORAGE_ACCESS_KEY - the storage account access key
+"""
+
+
+from datetime import datetime, timedelta
+import os
+import asyncio
+
+class TableAuthSamples(object):
+    connection_string = os.getenv("AZURE_TABLES_CONNECTION_STRING")
+    access_key = os.getenv("AZURE_TABLES_KEY")
+    account_url = os.getenv("AZURE_TABLES_ACCOUNT_URL")
+    account_name = os.getenv("AZURE_TABLES_ACCOUNT_NAME")
+
+    async def authentication_by_connection_string(self):
+        # Instantiate a TableServiceClient using a connection string
+        # [START auth_from_connection_string]
+        from azure.data.tables.aio import TableServiceClient
+        table_service = TableServiceClient.from_connection_string(conn_str=self.connection_string)
+        properties = await table_service.get_service_properties()
+        print("Connection String: {}".format(properties))
+
+    async def authentication_by_shared_key(self):
+        # Instantiate a TableServiceClient using a shared access key
+        # [START create_Table_service_client]
+        from azure.data.tables.aio import TableServiceClient
+        table_service = TableServiceClient(account_url=self.account_url, credential=self.access_key)
+        properties = await table_service.get_service_properties()
+        print("Shared Key: {}".format(properties))
+
+    async def authentication_by_shared_access_signature(self):
+        # Instantiate a TableServiceClient using a connection string
+        from azure.data.tables.aio import TableServiceClient
+        table_service = TableServiceClient.from_connection_string(conn_str=self.connection_string)
+
+        # Create a SAS token to use for authentication of a client
+        from azure.data.tables import generate_account_sas, ResourceTypes, AccountSasPermissions
+        print(self.account_name)
+        sas_token = generate_account_sas(
+            self.account_name,
+            self.access_key,
+            resource_types=ResourceTypes(service=True),
+            permission=AccountSasPermissions(read=True),
+            expiry=datetime.utcnow() + timedelta(hours=1)
+        )
+
+        token_auth_table_service = TableServiceClient(account_url=self.account_url, credential=sas_token)
+
+        properties = await table_service.get_service_properties()
+        print("Shared Access Signature: {}".format(properties))
+
+
+async def main():
+    sample = TableAuthSamples()
+    await sample.authentication_by_connection_string()
+    await sample.authentication_by_shared_key()
+    await sample.authentication_by_shared_access_signature()
+
+
+if __name__ == '__main__':
+    asyncio.run(main())

sdk/tables/azure-data-tables/samples/async_samples/sample_create_client_async.py

@@ -0,0 +1,70 @@
+# coding: utf-8
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: table_samples_authentication.py
+
+DESCRIPTION:
+    These samples demonstrate authenticating a client via:
+        * connection string
+        * shared access key
+        * generating a sas token with which the returned signature can be used with
+    the credential parameter of any TableServiceClient or TableClient
+
+USAGE:
+    python table_samples_authentication.py
+
+    Set the environment variables with your own values before running the sample:
+    1) AZURE_STORAGE_CONNECTION_STRING - the connection string to your storage account
+    2) AZURE_STORAGE_ACCOUNT_URL - the Table service account URL
+    3) AZURE_STORAGE_ACCOUNT_NAME - the name of the storage account
+    4) AZURE_STORAGE_ACCESS_KEY - the storage account access key
+"""
+
+
+from datetime import datetime, timedelta
+import os
+import asyncio
+
+
+class CreateClients(object):
+    connection_string = os.getenv("AZURE_TABLES_CONNECTION_STRING")
+    access_key = os.getenv("AZURE_TABLES_KEY")
+    account_url = os.getenv("AZURE_TABLES_ACCOUNT_URL")
+    account_name = os.getenv("AZURE_TABLES_ACCOUNT_NAME")
+    my_table = os.getenv("AZURE_TABLES_NAME") or ""
+
+    async def create_table_client(self):
+        # Instantiate a TableServiceClient using a connection string
+        # [START create_table_client]
+        from azure.data.tables.aio import TableClient
+        table_client = TableClient.from_connection_string(
+            conn_str=self.connection_string,
+            table_name="tableName"
+        )
+        print("Table name: {}".format(table_client.table_name))
+        # [END create_table_client]
+
+    async def create_table_service_client(self):
+        # Instantiate a TableServiceClient using a shared access key
+        # [START create_table_service_client]
+        from azure.data.tables.aio import TableServiceClient
+        table_service = TableServiceClient(account_url=self.account_url, credential=self.access_key)
+        properties = await table_service.get_service_properties()
+        print("Properties: {}".format(properties))
+        # [END create_table_service_client]
+
+
+async def main():
+    sample = CreateClients()
+    await sample.create_table_client()
+    await sample.create_table_service_client()
+
+
+if __name__ == '__main__':
+    asyncio.run(main())

sdk/tables/azure-data-tables/samples/async_samples/sample_create_delete_table_async.py

@@ -0,0 +1,81 @@
+import os
+import logging
+import asyncio
+
+_LOGGER = logging.getLogger(__name__)
+
+class CreateDeleteTable(object):
+    connection_string = os.getenv("AZURE_TABLES_CONNECTION_STRING")
+    access_key = os.getenv("AZURE_TABLES_KEY")
+    account_url = os.getenv("AZURE_TABLES_ACCOUNT_URL")
+    account_name = os.getenv("AZURE_TABLES_ACCOUNT_NAME")
+    table_name = "OfficeSupplies"
+
+
+    async def create_table(self):
+        from azure.data.tables.aio import TableServiceClient
+        from azure.core.exceptions import ResourceExistsError
+
+        table_service_client = TableServiceClient.from_connection_string(self.connection_string)
+        try:
+            table_item = await table_service_client.create_table(table_name=self.table_name)
+            print("Created table {}!".format(table_item.table_name))
+        except ResourceExistsError:
+            print("Table already exists")
+
+    async def create_if_not_exists(self):
+        from azure.data.tables.aio import TableServiceClient
+
+        table_service_client = TableServiceClient.from_connection_string(self.connection_string)
+        table_item = TableServiceClient.create_table_if_not_exists(table_name=self.table_name)
+        print("Table name: {}".format(table_item.table_name))
+
+
+    async def delete_table(self):
+        from azure.data.tables.aio import TableServiceClient
+        from azure.core.exceptions import ResourceNotFoundError
+
+        table_service_client = TableServiceClient.from_connection_string(self.connection_string)
+        try:
+            await table_service_client.delete_table(table_name=self.table_name)
+            print("Deleted table {}!".format(self.table_name))
+        except ResourceNotFoundError:
+            print("Table could not be found")
+
+
+    async def create_from_table_client(self):
+        from azure.data.table import TableClient
+
+        table_client = TableClient.from_connection_string(
+            conn_str=self.connection_string,
+            table_name=self.table_name
+        )
+        try:
+            table_item = await table_client.create_table()
+            print("Created table {}!".format(table_item.table_name))
+        except ResourceExistsError:
+            print("Table already exists")
+
+
+    async def delete_from_table_client(self):
+        from azure.data.table import TableClient
+
+        table_client = TableClient.from_connection_string(
+            conn_str=self.connection_string,
+            table_name=self.table_name
+        )
+        try:
+            await table_client.delete_table()
+            print("Deleted table {}!".format(self.table_name))
+        except ResourceExistsError:
+            print("Table already exists")
+
+
+async def main():
+    sample = CreateDeleteTable()
+    await sample.create_table()
+    await sample.delete_table()
+
+
+if __name__ == '__main__':
+    asyncio.run(main())

sdk/tables/azure-data-tables/samples/async_samples/sample_insert_delete_entities_async.py

@@ -0,0 +1,69 @@
+import os
+import asyncio
+
+class InsertDeleteEntity(object):
+    connection_string = os.getenv("AZURE_TABLES_CONNECTION_STRING")
+    access_key = os.getenv("AZURE_TABLES_KEY")
+    account_url = os.getenv("AZURE_TABLES_ACCOUNT_URL")
+    account_name = os.getenv("AZURE_TABLES_ACCOUNT_NAME")
+    table_name = "OfficeSupplies"
+
+    entity = {
+        'PartitionKey': 'color',
+        'RowKey': 'brand',
+        'text': 'Marker',
+        'color': 'Purple',
+        'price': '5'
+    }
+
+    async def create_entity(self):
+        from azure.data.tables.aio import TableClient
+        from azure.core.exceptions import ResourceExistsError, HttpResponseError
+
+        table_client = TableClient.from_connection_string(self.connection_string, self.table_name)
+
+        # Create a table in case it does not already exist
+        try:
+            await table_client.create_table()
+        except HttpResponseError:
+            print("Table already exists")
+
+        try:
+            entity = await table_client.create_entity(entity=self.entity)
+            print(entity)
+        except ResourceExistsError:
+            print("Entity already exists")
+
+
+    async def delete_entity(self):
+        from azure.data.tables.aio import TableClient
+        from azure.core.exceptions import ResourceNotFoundError, ResourceExistsError
+        from azure.core import MatchConditions
+
+        table_client = TableClient(account_url=self.account_url, credential=self.access_key, table_name=self.table_name)
+
+        # Create entity to delete (to showcase etag)
+        try:
+            resp = await table_client.create_entity(entity=self.entity)
+        except ResourceExistsError:
+            print("Entity already exists!")
+
+        try:
+            # will delete if match_condition and etag are satisfied
+            await table_client.delete_entity(
+                row_key=self.entity["RowKey"],
+                partition_key=self.entity["PartitionKey"]
+            )
+            print("Successfully deleted!")
+        except ResourceNotFoundError:
+            print("Entity does not exists")
+
+
+async def main():
+    ide = InsertDeleteEntity()
+    await ide.create_entity()
+    await ide.delete_entity()
+
+
+if __name__ == '__main__':
+    asyncio.run(main())