Merge pull request #271101 from AbhinavTrips/main

Python Code addition

Author: prmerger-automator[bot]

articles/cosmos-db/hierarchical-partition-keys.md

@@ -65,6 +65,7 @@ Find the latest preview version of each supported SDK:
 | .NET SDK v3 | >= 3.33.0 | <https://www.nuget.org/packages/Microsoft.Azure.Cosmos/3.33.0/> |
 | Java SDK v4 | >= 4.42.0 | <https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos/CHANGELOG.md#4420-2023-03-17/> |
 | JavaScript SDK v4 | 4.0.0 | <https://www.npmjs.com/package/@azure/cosmos/> |
+| Python SDK | >= 4.6.0 | <https://pypi.org/project/azure-cosmos/4.6.0/> |
 
 ## Create a container by using hierarchical partition keys
 
@@ -172,6 +173,14 @@ console.log(container.id);
 
 ```
 
+#### [Python SDK](#tab/python)
+
+```python
+container = database.create_container(
+        id=container_name, partition_key=PartitionKey(path=["/tenantId", "/userId", "/sessionId"], kind="MultiHash")
+    )
+```
+
 ---
 
 ### Azure Resource Manager templates
@@ -300,6 +309,18 @@ const item: UserSession = {
 // Pass in the object, and the SDK automatically extracts the full partition key path
 const { resource: document } = await = container.items.create(item);
 
+```
+
+#### [Python SDK](#tab/python)
+
+```python
+# specify values for all fields on partition key path
+item_definition = {'id': 'f7da01b0-090b-41d2-8416-dacae09fbb4a',
+                        'tenantId': 'Microsoft',
+                        'userId': '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b',
+                        'sessionId': '0000-11-0000-1111'}
+
+item = container.create_item(body=item_definition)
 ```
 ---
 
@@ -374,6 +395,20 @@ const partitionKey: PartitionKey = new PartitionKeyBuilder()
 // Create the item in the container
 const { resource: document } = await container.items.create(item, partitionKey);
 ```
+
+#### [Python SDK](#tab/python)
+
+For python, just make sure that values for all the fields in the partition key path are specified in the item definition.
+
+```python
+# specify values for all fields on partition key path
+item_definition = {'id': 'f7da01b0-090b-41d2-8416-dacae09fbb4a',
+                        'tenantId': 'Microsoft',
+                        'userId': '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b',
+                        'sessionId': '0000-11-0000-1111'}
+
+item = container.create_item(body=item_definition)
+```
 ---
 
 ### Perform a key/value lookup (point read) of an item
@@ -432,6 +467,14 @@ const partitionKey: PartitionKey = new PartitionKeyBuilder()
 // Perform a point read
 const { resource: document } = await container.item(id, partitionKey).read();
 ```
+
+#### [Python SDK](#tab/python)
+
+```python
+item_id = "f7da01b0-090b-41d2-8416-dacae09fbb4a"
+pk = ["Microsoft", "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b", "0000-11-0000-1111"]
+container.read_item(item=item_id, partition_key=pk)
+```
 ---
 
 ### Run a query
@@ -514,6 +557,20 @@ while (queryIterator.hasMoreResults()) {
 }
 ```
 
+#### [Python SDK](#tab/python)
+
+```python
+pk = ["Microsoft", "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b", "0000-11-0000-1111"]
+items = list(container.query_items(
+    query="SELECT * FROM r WHERE r.tenantId=@tenant_id and r.userId=@user_id and r.sessionId=@session_id",
+    parameters=[
+        {"name": "@tenant_id", "value": pk[0]},
+        {"name": "@user_id", "value": pk[1]},
+        {"name": "@session_id", "value": pk[2]}
+    ]
+))
+```
+
 ---
 
 #### Targeted multi-partition query on a subpartitioned container
@@ -575,6 +632,22 @@ while (queryIterator.hasMoreResults()) {
     const { resources: results } = await queryIterator.fetchNext();
     // Process result
 }
+```
+
+#### [Python SDK](#tab/python)
+
+```python
+pk = ["Microsoft", "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b", "0000-11-0000-1111"]
+# enable_cross_partition_query should be set to True as the container is partitioned
+items = list(container.query_items(
+    query="SELECT * FROM r WHERE r.tenantId=@tenant_id and r.userId=@user_id",
+    parameters=[
+        {"name": "@tenant_id", "value": pk[0]},
+        {"name": "@user_id", "value": pk[1]}
+    ],
+    enable_cross_partition_query=True
+))
+
 ```
 ---
 

articles/cosmos-db/nosql/index-metrics.md

@@ -14,8 +14,13 @@ ms.reviewer: jucocchi
 
 Azure Cosmos DB provides indexing metrics to show both utilized indexed paths and recommended indexed paths. You can use the indexing metrics to optimize query performance, especially in cases where you aren't sure how to modify the [indexing policy](../index-policy.md)).
 
-> [!NOTE]
-> The indexing metrics are only supported in the .NET SDK (version 3.21.0 or later) and Java SDK (version 4.19.0 or later)
+## Supported SDK versions
+Indexing metrics are supported in the following SDK versions:
+| SDK | Supported versions |
+| --- | --- | 
+| .NET SDK v3 | >= 3.21.0 |
+| Java SDK v4 | >= 4.19.0 | 
+| Python SDK | >= 4.6.0 | 
 
 ## Enable indexing metrics
 
@@ -91,6 +96,17 @@ const { resources: resultsIndexMetrics, indexMetrics } = await container.items
     .fetchAll();
 console.log("IndexMetrics: ", indexMetrics);
 ```
+
+## [Python SDK](#tab/python)
+You can capture index metrics by passing in the populate_index_metrics keyword in query items and then reading the value for "x-ms-cosmos-index-utilization" header from the response. This header is returned only if the query returns some items.
+
+```python
+query_items = container.query_items(query="Select * from c",
+    enable_cross_partition_query=True,
+    populate_index_metrics=True)
+
+print(container.client_connection.last_response_headers['x-ms-cosmos-index-utilization'])
+```
 ---
 
 ### Example output

articles/cosmos-db/nosql/materialized-views.md

@@ -1,7 +1,7 @@
 ---
 title: Materialized views (preview)
 titleSuffix: Azure Cosmos DB for NoSQL
-description: Learn how to efficiently query a base container by using predefined filters in materialized views for Azure Cosmos DB for NoSQL. Use Materialized Views as Global Secondary Indexes.
+description: Learn how to efficiently query a base container by using predefined filters in materialized views for Azure Cosmos DB for NoSQL. Use materilaized views as global secondary indexes to avoid expensive cross-partition queries.
 author: AbhinavTrips
 ms.author: abtripathi
 ms.reviewer: sidandrews
@@ -21,15 +21,18 @@ ms.date: 06/09/2023
 
 Applications frequently are required to make queries that don't specify a partition key. In these cases, the queries might scan through all data for a small result set. The queries end up being expensive because they inadvertently run as a cross-partition query.
 
-Materialized views, when defined, help provide a way to efficiently query a base container in Azure Cosmos DB by using filters that don't include the partition key. When users write to the base container, the materialized view is built automatically in the background. This view can have a different partition key for efficient lookups. The view also contains only fields that are explicitly projected from the base container. This view is a read-only table. The Azure Cosmos DB Materialized Views for NoSQL API, can be used as Global Secondary Indexes for your workloads.
+Materialized views, when defined, help provide a way to efficiently query a base container in Azure Cosmos DB by using filters that don't include the partition key. When users write to the base container, the materialized view is built automatically in the background. This view can have a different partition key for efficient lookups. The view also contains only fields that are explicitly projected from the base container. This view is a read-only table. The Azure Cosmos DB materialized views can be used as global secondary indexes to avoid expensive cross-partition queries.
 
-With the Azure Cosmos DB Materialized Views (or the Global Secondary Index) for NoSQL API, you can:
+> [!IMPORTANT]
+> The materialized view feature of Azure Cosmos DB for NoSQL can be used as Global Secondary Indexes. Users can specify the fields that are projected from the base container to the materialized view and they can choose a different partition key for the materialized view. Choosing a different partition key based on the most common queries, helps in scoping the queries to a single logical partition and avoiding cross-partition queries..
+
+With a materialized view, you can:
 
-- Use the view as a lookup or mapping container to avoid cross-partition scans that would otherwise be expensive queries.
+- Use the view as a lookup or mapping container to persist cross-partition scans that would otherwise be expensive queries.
 - Provide a SQL-based predicate (without conditions) to populate only specific fields.
 - Use change feed triggers to create real-time views to simplify event-based scenarios that are commonly stored as separate containers.
 
-The benefits of using materialized views include, but aren't limited to:
+The benefits of using Azure Cosmos DB Materiliazed Views include, but aren't limited to:
 
 - You can implement server-side denormalization by using materialized views. With server-side denormalization, you can avoid multiple independent tables and computationally complex denormalization in client applications.
 - Materialized views automatically update views to keep views consistent with the base container. This automatic update abstracts the responsibilities of your client applications that would otherwise typically implement custom logic to perform dual writes to the base container and the view.
@@ -38,6 +41,7 @@ The benefits of using materialized views include, but aren't limited to:
 - You can configure a materialized view builder layer to map to your requirements to hydrate a view.
 - Materialized views improve write performance (compared to a multi-container-write strategy) because write operations need to be written only to the base container.
 - The Azure Cosmos DB implementation of materialized views is based on a pull model. This implementation doesn't affect write performance.
+- Azure Cosmos DB materialized views for NoSQL API caters to the Global Secondary Index use cases as well. Global Secondary Indexes are also used to maintain secondary data views and help in reducing cross-partition queries.
 
 ## Prerequisites