Merge pull request #57712 from SnehaGunda/partitioningdocs

Indexing, change feed, optimistic concurrency, container and items docs

Author: TrishaMc

.openpublishing.redirection.json

@@ -361,6 +361,16 @@
             "redirect_url": "/azure/cosmos-db/conflict-resolution-policies",
             "redirect_document_id": true
         },
+        {
+            "source_path": "articles/cosmos-db/manage-account.md",
+            "redirect_url": "/azure/cosmos-db/how-to-manage-database-account",
+            "redirect_document_id": false
+        },
+        {
+            "source_path": "articles/cosmos-db/indexing-policies.md",
+            "redirect_url": "/azure/cosmos-db/indexing-policy",
+            "redirect_document_id": true
+        },
         {
             "source_path": "articles/cosmos-db/distribute-data-globally-benefits.md",
             "redirect_url": "/azure/cosmos-db/distribute-data-globally",
@@ -9271,7 +9281,7 @@
         },
         {
             "source_path": "articles/documentdb/documentdb-indexing-policies.md",
-            "redirect_url": "https://docs.microsoft.com/azure/cosmos-db/indexing-policies",
+            "redirect_url": "/azure/cosmos-db/indexing-policy",
             "redirect_document_id": false
         },
         {

articles/cosmos-db/TOC.yml

@@ -69,6 +69,38 @@
         href: create-table-python.md
   - name: Concepts
     items:
+    - name: Working with Azure Cosmos account
+      href: account-overview.md
+    - name: Containers and items
+      items:
+      - name: Working with databases, containers, and items
+        href: databases-containers-items.md
+      - name: Indexing
+        items:
+        - name: Overview
+          href: index-overview.md
+        - name: Indexing policy
+          href: index-policy.md
+        - name: Index types
+          href: index-types.md
+        - name: Index paths
+          href: index-paths.md
+      - name: Change feed
+        items:
+        - name: Overview
+          href: change-feed.md
+        - name: Reading change feed
+          href: read-change-feed.md
+        - name: Change feed processor
+          href: change-feed-processor.md
+        - name: Change feed with Azure Functions 
+          href: change-feed-functions.md
+      - name: Time to live
+        href: time-to-live.md
+      - name: Unique key constraints
+        href: unique-keys.md
+      - name: Transactions and optimistic concurrency
+        href: database-transactions-optimistic-concurrency.md
     - name: Resource model
       href: sql-api-resources.md
     - name: Global distribution
@@ -85,7 +117,7 @@
         href: consistency-levels-tradeoffs.md
       - name: High availability
         href: high-availability.md
-      - name: Scale throughput globally
+      - name: Globally scaling provisioned throughput
         href: scaling-throughput.md
       - name: Conflict resolution policies
         href: conflict-resolution-policies.md
@@ -105,14 +137,6 @@
         href: request-units.md
       - name: Provision throughput on containers and databases
         href: set-throughput.md
-    - name: Indexing
-      href: indexing-policies.md
-    - name: Change feed
-      href: change-feed.md
-    - name: Time to live
-      href: time-to-live.md
-    - name: Unique keys
-      href: unique-keys.md
     - name: Security
       items:
         - name: Overview
@@ -392,6 +416,32 @@
             href: /rest/api/storageservices/Table-Service-Concepts
   - name: How-to guides
     items:
+    - name: Manage database account
+      href: how-to-manage-database-account.md
+    - name: Configure time to live
+      href: how-to-time-to-live.md
+    - name: Global distribution
+      items:
+      - name: Manage consistency
+        href: how-to-manage-consistency.md
+      - name: Manage conflicts
+        href: how-to-manage-conflicts.md
+    - name: Provisioned throughput
+      items:
+      - name: Provision container throughput
+        href: how-to-provision-container-throughput.md
+      - name: Provision database throughput
+        href: how-to-provision-database-throughput.md
+    - name: Working with containers and items
+      items:
+      - name: Create a container
+        href: how-to-create-container.md
+      - name: Query a container
+        href: how-to-query-container.md
+    - name: Indexing
+      items:
+      - name: Configure indexing
+        href: how-to-manage-indexing-policy.md
     - name : Manage
       items:
       - name: Manage using PowerShell
@@ -402,8 +452,6 @@
         href: storage-explorer.md
       - name: Manage using data explorer
         href: data-explorer.md
-      - name: Manage your account
-        href: manage-account.md
     - name : Logging
       items:
       - name: Diagnostic logging
@@ -426,26 +474,6 @@
         href: https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-cosmosdb
     - name: Set up Azure DevOps CI/CD pipeline
       href: tutorial-setup-ci-cd.md
-    - name: Global distribution
-      items:
-      - name: Manage Database Account
-        href: how-to-manage-database-account.md
-      - name: Manage Consistency
-        href: how-to-manage-consistency.md
-      - name: Manage Conflicts
-        href: how-to-manage-conflicts.md
-    - name: Provisioned throughput
-      items:
-      - name: Provision container throughput
-        href: how-to-provision-container-throughput.md
-      - name: Provision database throughput
-        href: how-to-provision-database-throughput.md
-    - name: Working with containers and items
-      items:
-      - name: Create a container
-        href: how-to-create-container.md
-      - name: Query a container
-        href: how-to-query-container.md
     - name: Best practices
       items:
       - name: Performance tips

articles/cosmos-db/account-overview.md

@@ -0,0 +1,41 @@
+---
+title: Working with Azure Cosmos DB accounts 
+description: This article describes how create and use Azure Cosmos DB accounts
+author: dharmas
+
+ms.service: cosmos-db
+ms.topic: conceptual
+ms.date: 11/08/2018
+ms.author: dharmas
+ms.reviewer: sngun
+
+---
+
+# Working with Azure Cosmos DB accounts
+
+Azure Cosmos DB is a fully managed platform-as-a-service (PaaS). To begin using Azure Cosmos DB, you should initially create an Azure Cosmos DB account in your Azure subscription. Your Azure Cosmos account contains a unique DNS name and you can manage an account by using Azure portal, Azure CLI or by using different language-specific SDKs. For more information, see [how to manage your Azure Cosmos account](how-to-manage-database-account.md).
+
+The Azure Cosmos DB account is the fundamental unit of global distribution and high availability. For globally distributing your data and throughput across multiple Azure regions, you can add and remove Azure regions to your Azure Cosmos account at any time. You can configure your Azure Cosmos account to have either a single or multiple write regions. For more information, see [how to add and remove Azure regions to your Azure Cosmos account](how-to-manage-database-account.md). You can configure the [default consistency](consistency-levels.md) level on Azure Cosmos account. Azure Cosmos DB provides comprehensive SLAs encompassing throughput, latency at the 99th percentile, consistency, and high availability. For more information, see [Azure Cosmos DB SLAs](https://azure.microsoft.com/en-us/support/legal/sla/cosmos-db/v1_2/).
+
+To securely manage access to all the data within your Azure Cosmos account, you can use the master keys associated with your account. To further secure access to your data, you can configure a VNET service endpoint and IP-firewall on your Azure Cosmos account. 
+
+## Elements in an Azure Cosmos account
+
+Azure Cosmos DB container is the fundamental unit of scalability. You can virtually have an unlimited provisioned throughput (RU/s) and storage on a container. Azure Cosmos DB transparently partitions your container using the logical partition key that you specify in order to elastically scale your provisioned throughput and storage. For more information, see [working with Azure Cosmos containers and items](databases-containers-items.md).
+
+Currently, you can create a maximum of 100 Azure Cosmos accounts under an Azure subscription. A single Azure Cosmos account can virtually manage unlimited amount of data and provisioned throughput. To manage your data and provisioned throughput, you can create one or more Azure Cosmos databases under your account and within that database, you can create one or more containers. The following image shows the hierarchy of elements in an Azure Cosmos account:
+
+![Hierarchy of a Azure Cosmos account](./media/account-overview/hierarchy.png)
+
+## Next steps
+
+You can now proceed to learn how to manage your Azure Cosmos account or see other concepts associated with Azure Cosmos DB:
+
+* [How-to manage your Azure Cosmos account](how-to-manage-database-account.md)
+* [Global distribution](distribute-data-globally.md)
+* [Consistency levels](consistency-levels.md)
+* [Working with Azure Cosmos containers and items](databases-containers-items.md)
+* [VNET service endpoint for your Azure Cosmos account](firewall-support.md)
+* [IP-firewall for your Azure Cosmos account](vnet-service-endpoint.md)
+* [How-to add and remove Azure regions to your Azure Cosmos account](how-to-manage-database-account.md)
+* [Azure Cosmos DB SLAs](https://azure.microsoft.com/en-us/support/legal/sla/cosmos-db/v1_2/)

articles/cosmos-db/change-feed-functions.md

@@ -0,0 +1,66 @@
+---
+title: How to use  Azure Cosmos DB change feed with Azure Functions
+description: Use Azure Cosmos DB change feed with Azure Functions 
+author: rimman
+
+ms.service: cosmos-db
+ms.topic: conceptual
+ms.date: 11/06/2018
+ms.author: rimman
+
+---
+# How to use Azure Cosmos DB change feed with Azure Functions
+
+If you're using Azure Functions, the simplest way to connect to change feed is to add an [Azure Cosmos DB trigger](../azure-functions/functions-bindings-cosmosdb-v2.md#trigger) to your Azure Functions app. When you create a Cosmos DB trigger in an Azure Functions app, you select the Cosmos container to connect to and the function is triggered whenever you change something in the container.
+
+Triggers can be created in the Azure Functions portal or in the Azure Cosmos DB portal or programmatically. For more information, see [serverless database computing using Azure Cosmos DB and Azure Functions](serverless-computing-database.md).
+
+## Frequently asked questions
+
+### How can I configure Azure functions to read from a particular region?
+
+It is possible to define the [PreferredLocations](https://docs.microsoft.com/dotnet/api/microsoft.azure.documents.client.connectionpolicy.preferredlocations?view=azure-dotnet#Microsoft_Azure_Documents_Client_ConnectionPolicy_PreferredLocations) when using the Azure Cosmos DB trigger to specify a list of regions. It's same as you customize the ConnectionPolicy, to make the trigger read from your preferred regions. Ideally, you want to read from the closest region where your Azure Functions is deployed.
+
+### What is the default size of batches in Azure Functions?
+
+The default size is 100 items for every invocation of Azure Functions. However, this number is configurable within the function.json file. Here is complete [list of configuration options](../azure-functions/functions-bindings-cosmosdb-v2.md#trigger---configuration). If you are developing locally, update the application settings within the local.settings.json file.
+
+### I am monitoring a container and reading its change feed, however I don't get all the inserted documents, some items are missing?
+
+Make sure that there is no other Azure Function reading the same container with the same lease container. The missing documents are processed by the other Azure Functions that are also using the same lease.
+
+Therefore, if you are creating multiple Azure Functions to read the same change feed, they must use different lease containers or use the "leasePrefix" configuration to share the same container. However, when you use change feed processor library you can start multiple instances of your Azure Function and the SDK will divide the documents between different instances automatically for you.
+
+### Azure Cosmos item is updated every second, and I don't get all the changes in Azure Functions listening to change feed?
+
+Azure Functions polls the change feed for changes continuously, with a maximum default delay of 5 seconds. If there are no pending changes to be read, or if there are changes pending after the trigger is applied, the function will read them right away. However, if there are no pending changes, the function will wait 5 seconds and poll for more changes.
+
+If your document receives multiple changes in the same interval that took the Trigger to poll for new changes, you might receive the latest version of the document and not the intermediate one.
+
+If you want to to poll change feed for less than 5 seconds, for example, for every second, you can configure the polling time "feedPollDelay", see [the complete configuration](https://docs.microsoft.com/dotnet/api/microsoft.azure.documents.client.connectionpolicy.preferredlocations?view=azure-dotnet#Microsoft_Azure_Documents_Client_ConnectionPolicy_PreferredLocations). It is defined in milliseconds with a default of 5000. Polling for less than 1 second is possible but it's not advised because you will start using more CPU memory.
+
+### Can multiple Azure Functions read one container’s change feed?
+
+Yes. Multiple Azure Functions can read the same container’s change feed. However, the Azure Functions needs to have a separate “leaseCollectionPrefix” defined.
+
+### If I am processing change feed by using Azure Functions, in a batch of 10 documents, and I get an error at seventh Document. In that case the last three documents are not processed how can I start processing from the failed document (i.e, seventh document) in my next feed?
+
+To handle the error, the recommended pattern is to wrap your code with try-catch block and, if you are iterating over the list of documents, wrap each iteration in its own try-catch block. Catch the error and put that document on a queue (dead-letter) and then define logic to deal with the documents that produced the error. With this method if you have a 200-document batch, and just one document failed, you do not have to throw away the whole batch.
+
+In case of error, you should not rewind the check point back to beginning else you will can keep getting those documents from change feed. Remember, change feed keeps the last final snap shot of the documents, because of this you may lose the previous snapshot on the document. change feed keeps only one last version of the document, and in between other processes can come and change the document.
+
+As you keep fixing your code, you will soon find no documents on dead-letter queue. Azure Functions is automatically called by change feed system and check point is maintained internally by Azure Function. If you want to roll back the check point and control every aspect of it, you should consider using change feed Processor SDK.
+
+### Are there any extra costs for using the Azure Cosmos DB Trigger?
+
+The Azure Cosmos DB Trigger leverages the Change Feed Processor library internally. As such, it requires an extra collection, called Leases collection, to maintain state and partial checkpoints. This state management is needed to be able to dynamically scale and continue in case you want to stop your Azure Functions and continue processing at a later time. To learn more, see [how to work with change feed processor library](change-feed-processor.md).
+
+## Next steps
+
+You can now proceed to learn more about change feed in the following articles:
+
+* [Overview of change feed](change-feed.md)
+* [Ways to read change feed](read-change-feed.md)
+* [Using change feed processor library](change-feed-processor.md)
+* [How to work with change feed processor library](change-feed-processor.md)
+* [Serverless database computing using Azure Cosmos DB and Azure Functions](serverless-computing-database.md)