{"id":1198,"date":"2021-06-15T09:44:21","date_gmt":"2021-06-15T16:44:21","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/azure-sdk\/?p=1198"},"modified":"2021-09-28T12:43:34","modified_gmt":"2021-09-28T19:43:34","slug":"announcing-the-new-azure-data-tables-libraries","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/azure-sdk\/announcing-the-new-azure-data-tables-libraries\/","title":{"rendered":"Announcing the new Azure Tables Libraries"},"content":{"rendered":"

We\u2019re excited to announce that the Azure Tables<\/strong><\/a> libraries have been released for .NET, Java, JavaScript\/TypeScript, and Python. The Azure Table service stores NoSQL data in the cloud with a key\/attribute store schema-less design. The Table storage service can be used to store flexible data sets like user data for web applications, address books, device information, or other types of metadata.<\/p>\n

The new libraries follow our Azure SDK Guidelines<\/a>, making for an idiomatic, consistent, approachable, diagnosable, and dependable library. The new libraries use the language-specific Azure Core packages for handling requests, errors, and credentials.<\/p>\n

Note: The Azure Tables libraries are capable of targeting both Azure Storage Table and Azure Cosmos DB Table API<\/a> endpoints.<\/p>\n

SDK Availability<\/h2>\n

The Azure Tables libraries can be downloaded from each languages preferred package manager.<\/p>\n\n\n\n\n\n\n\n\n
Language<\/th>\nPackage<\/th>\nCommand<\/th>\nProject Home<\/th>\nGetting Started<\/th>\n<\/tr>\n<\/thead>\n
Python<\/td>\nPyPi<\/a><\/td>\npip install azure-data-tables<\/code><\/td>\nlink<\/a><\/td>\nlink<\/a><\/td>\n<\/tr>\n
.NET<\/td>\nNuGet<\/a><\/td>\ndotnet add package Azure.Data.Tables<\/code><\/td>\nlink<\/a><\/td>\nlink<\/a><\/td>\n<\/tr>\n
JavaScript\/TypeScript<\/td>\nnpm<\/a><\/td>\nnpm install @azure\/data-tables<\/code><\/td>\nlink<\/a><\/td>\nlink<\/a><\/td>\n<\/tr>\n
Java<\/td>\nJava<\/a><\/td>\nAdd to POM.xml file<\/a><\/td>\nlink<\/a><\/td>\nlink<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

This blog post assumes you have a working developer environment for your preferred programming language and you already have a Storage or Cosmos Table account. If you do not have those refer to the Getting Started entry in the above table for your preferred programming language. To follow along with these snippets you’ll need the programming language of your choice (Python, .NET, Java, JS) installed, a text editor, and a Storage or Cosmos Table account.<\/p>\n

There will be migration guides added to each project’s homepage that will show specific examples for updating your code base to the new Azure Tables library discussed in this blog. Links to complete code examples for each language are provided at the end of the article<\/a>.<\/p>\n

Creating the clients<\/h3>\n

There are two clients for interacting with the service. The TableServiceClient<\/code> can be used for account-level interactions (creating tables, setting and getting access policies) and the TableClient<\/code> is used for table-level interactions (create or delete an entity, query or list entities). You can create clients with a key, Shared Access Signature, or using a connection string, all of which can be found in the Azure Portal<\/a>.<\/p>\n

Python<\/h4>\n
table_client = TableClient.from_connection_string(\"<your-connection-string>\", \"officeSupplies\")\r\ntable_service_client = TableServiceClient.from_connection_String(\"<your-connection-string>\")<\/code><\/pre>\n
.NET<\/h4>\n
TableClient client = new TableClient(\"connectionString\", \"officeSupplies\");\r\nTableServiceClient serviceClient = new TableServiceClient(\"connectionString\");<\/code><\/pre>\n
Java<\/h4>\n
TableClient tableClient = new TableClientBuilder()\r\n    .connectionString(\"<your-connection-string>\")\r\n    .tableName(\"officeSupplies\")\r\n    .buildClient();<\/code><\/pre>\n
JavaScript<\/h4>\n
const client = TableClient.fromConnectionString(\"<your-connection-string>\", \"officeSupplies\");<\/code><\/pre>\n
Create a table and add an entity to it<\/h3>\n
Table names can be any alphanumeric string between 3 and 63 characters. A table can be created from either the TableClient<\/code> or the TableServiceClient<\/code>, the following snippets will show how to create one from a TableClient<\/code>.<\/p>\n
An Entity can contain up to 255 properties, with the three system properties of PartitionKey<\/code>, RowKey<\/code>, and Timestamp<\/code>. The first two properties must be provided on all entities and the Timestamp<\/code> property will be modified by the service. For more information, see the service documentation<\/a>. Entities can only be inserted and queried from the TableClient<\/code>.<\/p>\n
Python<\/h4>\n
table_client = TableClient.from_connection_string(\"<your-connection-string>\", \"myTable\")\r\ntable_client.create()\r\n\r\nmy_entity = {\r\n    \"PartitionKey\": \"markers\",\r\n    \"RowKey\": \"id-001\",\r\n    \"Product\": \"Markers\",\r\n    \"Price\": 5.00,\r\n    \"Count\": 10,\r\n    \"Available\": True\r\n}\r\n\r\ntable_client.create_entity(my_entity)<\/code><\/pre>\n
.NET<\/h4>\n
var tableClient = new TableClient(\r\n    new Uri(serviceUri),\r\n    tableName,\r\n    new TableSharedKeyCredential(accountName, storageAccountKey));\r\ntableClient.Create();\r\n\r\nvar partitionKey = \"markers\";\r\nvar rowKey = \"id-001\";\r\nvar entity = new TableEntity(partitionKey, rowKey)\r\n{\r\n    { \"Product\", \"Marker Set\" },\r\n    { \"Price\", 5.00 },\r\n    { \"Quantity\", 21 }\r\n};\r\ntableClient.AddEntity(entity);<\/code><\/pre>\n
Java<\/h4>\n
TableClient tableClient = new TableClientBuilder()\r\n    .connectionString(\"<your-connection-string>\")\r\n    .tableName(tableName)\r\n    .buildClient();\r\n\r\nString partitionKey = \"markers\";\r\nString rowKey = \"id-001\";\r\nTableEntity entity = new TableEntity(partitionKey, rowKey)\r\n    .addProperty(\"Product\", \"Marker Set\")\r\n    .addProperty(\"Price\", 5.00)\r\n    .addProperty(\"Quantity\", 21);\r\n\r\ntableClient.createEntity(entity);<\/code><\/pre>\n
JavaScript<\/h4>\n
const tableName = \"SampleCreateAndDeleteTable2\";\r\nconst client = TableClient.fromConnectionString(\"<your-connection-string>\", tableName);\r\nawait client.createTable();\r\n\r\nconst entity = {\r\n  partitionKey: \"p1\",\r\n  rowKey: \"r1\",\r\n  date: new Date()\r\n};\r\nawait client.createEntity(entity);<\/code><\/pre>\n
Querying Table Entities<\/h3>\n
The TableClient<\/code> allows the user to create custom queries using OData filters. For more information on writing table and entity queries check out the service documentation<\/a>.<\/p>\n
Python<\/h4>\n
query_filter = \"PartitionKey eq @pk_filter or RowKey eq @rk_filter\"\r\nparameters = {\r\n    \"pk_filter\": \"markers\",\r\n    \"rk_filter\": \"id-001\",\r\n}\r\n\r\nfor entity in table_client.query_entities(query_filter, parameters=parameters):\r\n    print(entity[\"Product\"], entity[\"Count\"])<\/code><\/pre>\n
.NET<\/h4>\n
string MyPK = \"markers\";\r\nstring MyRK = \"id-001\";\r\nstring filter = TableOdataFilter.Create($\"PartitionKey eq {MyPK} or RowKey eq {MyRK}\")\r\n\r\nPageable<TableEntity> entities = tableClient.Query<TableEntity>(filter: filter);\r\n\r\nforeach (TableEntity entity in entities)\r\n{\r\n    Console.WriteLine($\"{entity.GetString(\"Product\")}: {entity.GetInteger(\"Count\")}\");\r\n}<\/code><\/pre>\n
Java<\/h4>\n
ListEntitiesOptions options = new ListEntitiesOptions()\r\n    .setFilter(\"PartitionKey eq 'markers' or RowKey eq 'id-001'\");\r\n\r\nfor (TableEntity entity : tableClient.listEntities(options)) {\r\n    Map<String, Object> properties = entity.getProperties();\r\n    System.out.println(String.format(\"%s: %d\", properties.get(\"Product\"), properties.get(\"Count\")));\r\n}<\/code><\/pre>\n
JavaScript<\/h4>\n
const partitionKey = \"markers\";\r\nconst id = \"id-001\"\r\nlet entities = client.listEntities({    queryOptions: { filter: odata`PartitionKey eq ${partitionKey} or RowKey eq ${id}` });\r\n\r\nfor await (const entity of entities) {\r\n    console.log(`${entity.Product}: ${entity.Count}`);\r\n}<\/code><\/pre>\n
Batch Transactions<\/h3>\n
The Table service allows multiple entity operations (create, delete, update, and upsert) to be made in a single request using transactional batch operations. The transaction is an “all-or-nothing” approach, if there is a failure in one of the operations, the entire operation will fail. A transaction can perform any combination of create, delete, update, and upsert operations. For more information, see the service documentation<\/a>.<\/p>\n
Note: All operations within a transaction must target the same partition key.<\/p>\n
Python<\/h4>\n
table_client = TableClient.from_connection_string(\"<your-connection-string>\", \"myProductTable\")\r\n\r\nentity1 = {\"PartitionKey\": \"pk0001\", \"RowKey\": \"A1\", \"Name\": \"Marker Set\", \"Price\": 5.0, \"Quantity\": 21}\r\nentity2 = {\"PartitionKey\": \"pk0001\", \"RowKey\": \"A2\"}\r\nentity3 = {\"PartitionKey\": \"pk0001\", \"RowKey\": \"A3\", \"Name\": \"Pen Set\", \"Price\": 2.0, \"Quantity\": 6}\r\nentity4 = {\"PartitionKey\": \"pk0001\", \"RowKey\": \"A4\", \"Name\": \"Pencil\", \"Price\": 1.5, \"Quantity\": 100}\r\n\r\noperations = [\r\n    (\"upsert\", entity1),\r\n    (\"delete\", entity2),\r\n    (\"create\", entity3),\r\n    (\"update\", entity4, {\"mode\": \"replace\"})\r\n]\r\n\r\ntable_client.submit_transaction(operations)<\/code><\/pre>\n
.NET<\/h4>\n
var tableClient = new TableClient(\r\n    new Uri(serviceUri),\r\n    tableName,\r\n    new TableSharedKeyCredential(accountName, storageAccountKey));\r\n\r\nstring partitionKey = \"BatchInsertSample\";\r\nList<TableEntity> entityList = new List<TableEntity>\r\n{\r\n    new TableEntity(partitionKey, \"01\")\r\n    {\r\n        { \"Product\", \"Marker\" },\r\n        { \"Price\", 5.00 },\r\n        { \"Brand\", \"Premium\" }\r\n    },\r\n    new TableEntity(partitionKey, \"02\")\r\n    {\r\n        { \"Product\", \"Pen\" },\r\n        { \"Price\", 3.00 },\r\n        { \"Brand\", \"Premium\" }\r\n    },\r\n    new TableEntity(partitionKey, \"03\")\r\n    {\r\n        { \"Product\", \"Paper\" },\r\n        { \"Price\", 0.10 },\r\n        { \"Brand\", \"Premium\" }\r\n    },\r\n    new TableEntity(partitionKey, \"04\")\r\n    {\r\n        { \"Product\", \"Glue\" },\r\n        { \"Price\", 1.00 },\r\n        { \"Brand\", \"Generic\" }\r\n    },\r\n};\r\n\r\n\/\/ Create the batch.\r\nList<TableTransactionAction> addEntitiesBatch = new List<TableTransactionAction>();\r\n\r\n\/\/ Add the entities to be added to the batch.\r\naddEntitiesBatch.AddRange(entityList.Select(e => new TableTransactionAction(TableTransactionActionType.Add, e)));\r\n\r\n\/\/ Submit the batch.\r\nResponse<IReadOnlyList<Response>> response = await client.SubmitTransactionAsync(addEntitiesBatch).ConfigureAwait(false);\r\n\r\nfor (int i = 0; i < entityList.Count; i++)\r\n{\r\n    Console.WriteLine($\"The ETag for the entity with RowKey: '{entityList[i].RowKey}' is {response.Value[i].Headers.ETag}\");\r\n}<\/code><\/pre>\n
Java<\/h4>\n
TableClient tableClient = new TableClientBuilder()\r\n    .tableName(\"myProductTable\")\r\n    .connectionString(\"<your-connection-string>\")\r\n    .buildClient();\r\n\r\n\/\/ Now let's create a list to add transactional batch actions to.\r\nList<TableTransactionAction> transactionActions = new ArrayList<>();\r\n\r\nString partitionKey = \"pk001\";\r\n\r\nTableEntity firstEntity = new TableEntity(partitionKey, \"rk001\")\r\n    .addProperty(\"Name\", \"Marker Set\")\r\n    .addProperty(\"Price\", 5.0)\r\n    .addProperty(\"Quantity\", 21);\r\n\r\nTableEntity secondEntity = new TableEntity(partitionKey, \"rk002\")\r\n    .addProperty(\"Brand\", \"Crayola\")\r\n    .addProperty(\"Color\", \"Blue\");\r\n\r\nTableEntity entityToUpdate = new TableEntity(partitionKey, \"rk003\")\r\n    .addProperty(\"Brand\", \"Crayola\")\r\n    .addProperty(\"Color\", \"Red\");\r\n\r\nTableEntity entityToDelete = new TableEntity(partitionKey, \"rk004\")\r\n    .addProperty(\"Brand\", \"Crayola\")\r\n    .addProperty(\"Color\", \"Green\");\r\n\r\ntransactionActions.add(new TableTransactionAction(TableTransactionActionType.CREATE, firstEntity));\r\ntransactionActions.add(new TableTransactionAction(TableTransactionActionType.CREATE, secondEntity));\r\ntransactionActions.add(new TableTransactionAction(TableTransactionActionType.UPDATE_MERGE, entityToUpdate));\r\ntransactionActions.add(new TableTransactionAction(TableTransactionActionType.DELETE, entityToDelete));\r\n\r\nTableTransactionResult tableTransactionResult = tableClient.submitTransaction(transactionActions);<\/code><\/pre>\n
JavaScript<\/h4>\n
\/\/ See authenticationMethods sample for other options of creating a new client\r\nconst client = TableClient.fromConnectionString(\"<your-connection-string>\", \"tableName\");\r\nconst partitionKey = \"Stationery\";\r\n\r\n\/\/ Create a transaction\r\nconst transaction = new TableTransaction();\r\n\r\n\/\/ Add actions to the transaction\r\ntransaction.createEntity({\r\n  partitionKey,\r\n  rowKey: \"A1\",\r\n  name: \"Marker Set\",\r\n  price: 5.0,\r\n  quantity: 21\r\n});\r\ntransaction.createEntity({\r\n  partitionKey,\r\n  rowKey: \"A2\",\r\n  name: \"Pen Set\",\r\n  price: 2.0,\r\n  quantity: 6\r\n});\r\ntransaction.createEntity({\r\n  partitionKey,\r\n  rowKey: \"A3\",\r\n  name: \"Pencil\",\r\n  price: 1.5,\r\n  quantity: 100\r\n});\r\n\r\n\/\/ Submit the transaction using the actions list built by the helper\r\nconst transactionResult = await client.submitTransaction(transaction.actions);<\/code><\/pre>\n
Conclusion<\/h2>\n
We hope this was a valuable technical introduction to Azure Tables<\/code> and what you can use today to build and ship rich experiences.<\/p>\n
If you want to learn more and get started, here are some quick links to our official documentation:<\/p>\n