Skip to content

Commit 5c1af98

Browse files
Merge pull request #78945 from SnehaGunda/minthroughput
Updating QuickStart doc to use db level throughput and latest screens…
2 parents 75b568c + 4037098 commit 5c1af98

16 files changed

+55
-65
lines changed

articles/cosmos-db/create-sql-api-dotnet-preview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ If you don’t already have Visual Studio 2019 installed, you can download and u
3838
[!INCLUDE [cosmos-db-emulator-docdb-api](../../includes/cosmos-db-emulator-docdb-api.md)]
3939

4040
<a id="create-account"></a>
41-
## Create a database account
41+
## Create an Azure Cosmos account
4242

4343
[!INCLUDE [cosmos-db-create-dbaccount-preview](../../includes/cosmos-db-create-dbaccount-preview.md)]
4444

4545
<a id="create-collection"></a>
46-
## Add a collection
46+
## Add a container
4747

4848
[!INCLUDE [cosmos-db-create-collection-preview](../../includes/cosmos-db-create-collection-preview.md)]
4949

articles/cosmos-db/create-sql-api-dotnet.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: cosmos-db
77
ms.subservice: cosmosdb-sql
88
ms.devlang: dotnet
99
ms.topic: quickstart
10-
ms.date: 05/20/2019
10+
ms.date: 06/06/2019
1111
---
1212
# Quickstart: Build a .NET web app using SQL API account in Azure Cosmos DB
1313

@@ -46,33 +46,32 @@ An Azure subscription or free Azure Cosmos DB trial account
4646

4747
You can use the Data Explorer in the Azure portal to create a database and collection.
4848

49-
1. Select **Data Explorer** from the left navigation on your Azure Cosmos DB account page, and then select **New Collection**.
49+
1. Select **Data Explorer** from the left navigation on your Azure Cosmos DB account page, and then select **New Container**.
5050

51-
You may need to scroll right to see the **Add Collection** area.
51+
You may need to scroll right to see the **Add Container** window.
5252

5353
![The Azure portal Data Explorer, Add Collection pane](./media/create-sql-api-dotnet/azure-cosmosdb-data-explorer-dotnet.png)
5454

55-
1. In the **Add collection** page, enter the settings for the new collection.
55+
1. In the **Add container** pane, enter the settings for the new collection.
5656

5757
|Setting|Suggested value|Description
5858
|---|---|---|
59-
|**Database ID**|ToDoList|Enter *ToDoList* as the name for the new database. Database names must contain from 1 through 255 characters, and they cannot contain `/, \\, #, ?`, or a trailing space.|
60-
|**Collection ID**|Items|Enter *Items* as the name for your new collection. Collection IDs have the same character requirements as database names.|
61-
|**Partition key**| /category| The sample described in this article uses */category* as the partition key.|
59+
|**Database ID**|ToDoList|Enter *ToDoList* as the name for the new database. Database names must contain from 1 through 255 characters, and they cannot contain `/, \\, #, ?`, or a trailing space. Check the **Provision database throughput** option, it allows you to share the throughput provisioned to the database across all the containers within the database. This option also helps with cost savings. |
6260
|**Throughput**|400|Leave the throughput at 400 request units per second (RU/s). If you want to reduce latency, you can scale up the throughput later.|
61+
|**Container ID**|Items|Enter *Items* as the name for your new collection. Collection IDs have the same character requirements as database names.|
62+
|**Partition key**| /category| The sample described in this article uses */category* as the partition key.|
63+
6364

6465
Don't add **Unique keys** for this example. Unique keys let you add a layer of data integrity to the database by ensuring the uniqueness of one or more values per partition key. For more information, see [Unique keys in Azure Cosmos DB](unique-keys.md).
6566

66-
1. Select **OK**.
67-
Data Explorer displays the new database and collection.
67+
1. Select **OK**. The Data Explorer displays the new database and the container that you created.
6868

69-
![The Azure portal Data Explorer, showing the new database and collection](./media/create-sql-api-dotnet/azure-cosmos-db-new-collection.png)
7069

7170
## Add data to your database
7271

7372
Add data to your new database using Data Explorer.
7473

75-
1. In **Data Explorer**, the new database appears in the **Collections** pane. Expand the **ToDoList** database, expand the **Items** collection, select **Documents**, and then select **New Document**.
74+
1. In **Data Explorer**, expand the **ToDoList** database, and expand the **Items** container. Next, select **Items**, and then select **New Item**.
7675

7776
![Create new documents in Data Explorer in the Azure portal](./media/create-sql-api-dotnet/azure-cosmosdb-new-document.png)
7877

@@ -102,7 +101,7 @@ Add data to your new database using Data Explorer.
102101

103102
To see how easy it is to work with your Azure Cosmos DB data programmatically, clone the sample SQL API .NET web app from GitHub, update the connection string, and run the app to update your data.
104103

105-
You could also create the database and collection by using the .NET sample code. To learn more, see [Review the .NET code](#review-the-net-code).
104+
You could also create the database and the container by using the .NET sample code. To learn more, see [Review the .NET code](#review-the-net-code).
106105

107106
### Clone the sample app
108107

@@ -142,7 +141,7 @@ First, clone a C# [SQL API app](https://github.com/Azure-Samples/documentdb-dotn
142141
`<add key="authKey" value="19ZDNJAiYL26tmnRvoez6hmtIfBGwjun50PWRjNYMC2ig8Ob9hYk7Fq1RYSv8FcIYnh1TdBISvCh7s6yyb0000==" />`
143142

144143
145-
1. Make sure the database and collection values in the *web.config* match the names you created earlier.
144+
1. Make sure the database and collection (also called container) values in the *web.config* match the names you created earlier.
146145

147146
```csharp
148147
<add key="database" value="ToDoList"/>
@@ -171,7 +170,7 @@ You can go back to Data Explorer in the Azure portal to see, query, modify, and
171170

172171
## Review the .NET code
173172

174-
This step is optional. In this quickstart, you created a database and a collection in the Azure portal and added sample data by using the .NET sample. However, you can also create the database and the collection by using the .NET sample. Review the following snippets if you're interested in how database resources are created in the code. The snippets are all taken from the *DocumentDBRepository.cs* file in the **todo** project.
173+
This step is optional. In this quickstart, you created a database and a container in the Azure portal and added sample data by using the .NET sample. However, you can also create the database and the container by using the .NET sample. Review the following snippets if you're interested in how database resources are created in the code. The snippets are all taken from the *DocumentDBRepository.cs* file in the **todo** project.
175174

176175
* This code initializes the `DocumentClient`:
177176

@@ -224,7 +223,7 @@ This step is optional. In this quickstart, you created a database and a collecti
224223

225224
## Next steps
226225

227-
In this quickstart, you learned how to create an Azure Cosmos DB account, create a database and collection using the Data Explorer, and run a .NET web app to update your data. You can now import additional data to your Azure Cosmos DB account.
226+
In this quickstart, you learned how to create an Azure Cosmos DB account, create a database and container using the Data Explorer, and run a .NET web app to update your data. You can now import additional data to your Azure Cosmos DB account.
228227

229228
> [!div class="nextstepaction"]
230229
> [Import data into Azure Cosmos DB](import-data.md)

articles/cosmos-db/create-sql-api-java.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ ms.author: sngun
2121
> * [Python](create-sql-api-python.md)
2222
> * [Xamarin](create-sql-api-xamarin-dotnet.md)
2323
24-
This quickstart shows how to create and manage resources of an Azure Cosmos DB [SQL API](sql-api-introduction.md) account by using a Java application. First, you create an Azure Cosmos DB SQL API account using the Azure portal, create a Java app using the [SQL Java SDK](sql-api-sdk-async-java.md), add resources to your Cosmos DB account by using the Java application. The instructions in this quickstart can be followed on any operating system that is capable of running Java. After completing this quickstart you'll be familiar with creating and modifying Cosmos DB databases, collections in either the UI or programmatically, whichever is your preference.
24+
This quickstart shows how to create and manage resources of an Azure Cosmos DB [SQL API](sql-api-introduction.md) account by using a Java application. First, you create an Azure Cosmos DB SQL API account using the Azure portal, create a Java app using the [SQL Java SDK](sql-api-sdk-async-java.md), add resources to your Cosmos DB account by using the Java application. The instructions in this quickstart can be followed on any operating system that is capable of running Java. After completing this quickstart you'll be familiar with creating and modifying Cosmos DB databases, containers in either the UI or programmatically, whichever is your preference.
2525

2626
## Prerequisites
2727

@@ -43,7 +43,7 @@ Before you can create a document database, you need to create a SQL API account
4343

4444
[!INCLUDE [cosmos-db-create-dbaccount](../../includes/cosmos-db-create-dbaccount.md)]
4545

46-
## Add a collection
46+
## Add a container
4747

4848
[!INCLUDE [cosmos-db-create-collection](../../includes/cosmos-db-create-collection.md)]
4949

@@ -71,7 +71,7 @@ Now let's switch to working with code. Let's clone a SQL API app from GitHub, se
7171
This step is optional. If you're interested in learning how the database resources are created in the code, you can review the following snippets. Otherwise, you can skip ahead to [Run the app
7272
](#run-the-app).
7373
74-
* `AsyncDocumentClient` initialization. The [AsyncDocumentClient](https://docs.microsoft.com/java/api/com.microsoft.azure.cosmosdb.rx.asyncdocumentclient) provides client-side logical representation for the Azure Cosmos DB database service. This client is used to configure and execute requests against the service.
74+
* `AsyncDocumentClient` initialization. The [AsyncDocumentClient](https://docs.microsoft.com/java/api/com.microsoft.azure.cosmosdb.rx.asyncdocumentclient) provides client-side logical representation for the Azure Cosmos database service. This client is used to configure and execute requests against the service.
7575
7676
```java
7777
client = new AsyncDocumentClient.Builder()
@@ -200,7 +200,7 @@ Now go back to the Azure portal to get your connection string information and la
200200

201201
## Next steps
202202

203-
In this quickstart, you've learned how to create an Azure Cosmos DB account, document database, and collection using the Data Explorer, and run an app to do the same thing programmatically. You can now import additional data into your Azure Cosmos DB collection.
203+
In this quickstart, you've learned how to create an Azure Cosmos account, document database, and container using the Data Explorer, and run an app to do the same thing programmatically. You can now import additional data into your Azure Cosmos container.
204204
205205
> [!div class="nextstepaction"]
206206
> [Import data into Azure Cosmos DB](import-data.md)

articles/cosmos-db/create-sql-api-nodejs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This quickstart demonstrates how to create an Azure Cosmos DB [SQL API](sql-api-
3838

3939
[!INCLUDE [cosmos-db-create-dbaccount](../../includes/cosmos-db-create-dbaccount.md)]
4040

41-
## Add a collection
41+
## Add a container
4242

4343
[!INCLUDE [cosmos-db-create-collection](../../includes/cosmos-db-create-collection.md)]
4444

@@ -128,7 +128,7 @@ The following snippets are all taken from the **app.js** file.
128128
129129
Now go back to the Azure portal to get your connection string information and copy it into the app.
130130
131-
1. In the [Azure portal](https://portal.azure.com/), in your Azure Cosmos DB account, in the left navigation click **Keys**, and then click **Read-write Keys**. You'll use the copy buttons on the right side of the screen to copy the URI and Primary Key into the `config.js` file in the next step.
131+
1. In the [Azure portal](https://portal.azure.com/), in your Azure Cosmos account, in the left navigation click **Keys**, and then click **Read-write Keys**. You'll use the copy buttons on the right side of the screen to copy the URI and Primary Key into the `config.js` file in the next step.
132132

133133
![View and copy an access key in the Azure portal, Keys blade](./media/create-sql-api-dotnet/keys.png)
134134

@@ -159,7 +159,7 @@ You can now go back to Data Explorer and see query, modify, and work with this n
159159
160160
## Next steps
161161
162-
In this quickstart, you've learned how to create an Azure Cosmos DB account, create a collection using the Data Explorer, and run an app. You can now import additional data to your Cosmos DB account.
162+
In this quickstart, you've learned how to create an Azure Cosmos account, create a container using the Data Explorer, and run an app. You can now import additional data to your Cosmos DB account.
163163

164164
> [!div class="nextstepaction"]
165165
> [Import data into Azure Cosmos DB](import-data.md)

articles/cosmos-db/create-sql-api-python.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This quickstart demonstrates how to create an Azure Cosmos DB [SQL API](sql-api-
3737

3838
[!INCLUDE [cosmos-db-create-dbaccount](../../includes/cosmos-db-create-dbaccount.md)]
3939

40-
## Add a collection
40+
## Add a container
4141

4242
[!INCLUDE [cosmos-db-create-collection](../../includes/cosmos-db-create-collection.md)]
4343

@@ -80,7 +80,7 @@ Now let's clone a SQL API app from GitHub, set the connection string, and run it
8080

8181
Now go back to the Azure portal to get your connection string information and copy it into the app.
8282

83-
1. In the [Azure portal](https://portal.azure.com/), in your Azure Cosmos DB account, in the left navigation click **Keys**. You'll use the copy buttons on the right side of the screen to copy the **URI** and **Primary Key** into the `CosmosGetStarted.py` file in the next step.
83+
1. In the [Azure portal](https://portal.azure.com/), in your Azure Cosmos account, in the left navigation click **Keys**. You'll use the copy buttons on the right side of the screen to copy the **URI** and **Primary Key** into the `CosmosGetStarted.py` file in the next step.
8484
8585
![View and copy an access key in the Azure portal, Keys blade](./media/create-sql-api-dotnet/keys.png)
8686
@@ -211,7 +211,7 @@ The following snippets are all taken from the `CosmosGetStarted.py` file.
211211
212212
## Next steps
213213
214-
In this quickstart, you've learned how to create an Azure Cosmos DB account, create a collection using the Data Explorer, and run an app. You can now import additional data to your Cosmos DB account.
214+
In this quickstart, you've learned how to create an Azure Cosmos account, create a container using the Data Explorer, and run an app. You can now import additional data to your Cosmos DB account.
215215
216216
> [!div class="nextstepaction"]
217217
> [Import data into Azure Cosmos DB for the SQL API](import-data.md)

articles/cosmos-db/create-sql-api-xamarin-dotnet.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ If you are using a Mac, you can download the **free** [Visual Studio for Mac](ht
4343

4444
[!INCLUDE [cosmos-db-create-dbaccount](../../includes/cosmos-db-create-dbaccount.md)]
4545

46-
## Add a collection
46+
## Add a container
4747

4848
[!INCLUDE [cosmos-db-create-collection](../../includes/cosmos-db-create-collection.md)]
4949

@@ -179,7 +179,7 @@ Now let's take a quick review of how the app communicates with Azure Cosmos DB.
179179
}
180180
```
181181
182-
Here a new URI is needed to uniquely identify the document to replace and is obtained by using `UriFactory.CreateDocumentUri` and passing it the database and collection names and the id of the document.
182+
Here a new URI is needed to uniquely identify the document to replace and is obtained by using `UriFactory.CreateDocumentUri` and passing it the database and collection names and the ID of the document.
183183
184184
The `DocumentClient.ReplaceDocumentAsync` replaces the document identified by the URI with the one specified as a parameter.
185185
@@ -240,7 +240,7 @@ The following steps will demonstrate how to run the app using the Visual Studio
240240
241241
## Next steps
242242
243-
In this quickstart, you've learned how to create an Azure Cosmos DB account, create a collection using the Data Explorer, and build and deploy a Xamarin app. You can now import additional data to your Azure Cosmos DB account.
243+
In this quickstart, you've learned how to create an Azure Cosmos account, create a container using the Data Explorer, and build and deploy a Xamarin app. You can now import additional data to your Azure Cosmos account.
244244
245245
> [!div class="nextstepaction"]
246246
> [Import data into Azure Cosmos DB](import-data.md)
Binary file not shown.
79.1 KB
Loading
-19.8 KB
Loading
-8.06 KB
Loading

0 commit comments

Comments
 (0)