Skip to content

Commit 9b5cef8

Browse files
authored
Merge pull request #114971 from julieMSFT/20200512_updatescosmosdb
updates for naming
2 parents fa30c9b + 53b45ec commit 9b5cef8

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

articles/synapse-analytics/synapse-link/concept-synapse-link-cosmos-db-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Azure Synapse Link for Azure Cosmos DB supported features
3-
description: Understand the current list of actions supported by Azure Synapse Link for Cosmos DB
3+
description: Understand the current list of actions supported by Azure Synapse Link for Azure Cosmos DB
44
services: synapse-analytics
55
author: ArnoMicrosoft
66
ms.service: synapse-analytics
@@ -26,7 +26,7 @@ You can connect to an Azure Cosmos DB container without enabling Synapse Link, i
2626
| Category | Description |[Spark](https://docs.microsoft.com/azure/synapse-analytics/sql/on-demand-workspace-overview) | [SQL serverless](https://docs.microsoft.com/azure/synapse-analytics/sql/on-demand-workspace-overview) |
2727
| -------------------- | ----------------------------------------------------------- |----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
2828
| **Run-time Support** |Support for read or write by Azure Synapse run-time|| [Contact Us](mailto:[email protected]?subject=[Enable%20Preview%20Feature]%20SQL%20serverless%20for%20Cosmos%20DB)|
29-
| **Cosmos DB API support** |API support as a Synapse Link| SQL / Mongo DB | SQL / Mongo DB |
29+
| **Azure Cosmos DB API support** |API support as a Synapse Link| SQL / MongoDB | SQL / MongoDB |
3030
| **Object** |Objects such as a table that can be created, pointing directly to Azure Cosmos DB container| View, Table | View |
3131
| **Read** |Read data from an Azure Cosmos DB container| OLTP / HTAP | HTAP |
3232
| **Write** |Write data from run-time into an Azure Cosmos DB container| OLTP | n/a |

articles/synapse-analytics/synapse-link/how-to-connect-synapse-link-cosmos-db.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Connect to Azure Synapse Link for Cosmos DB
3-
description: How to connect a Cosmos DB to a Synapse workspace with Azure Synapse Link
2+
title: Connect to Azure Synapse Link for Azure Cosmos DB
3+
description: How to connect an Azure Cosmos DB to a Synapse workspace with Azure Synapse Link
44
services: synapse-analytics
55
author: ArnoMicrosoft
66
ms.service: synapse-analytics
@@ -17,9 +17,9 @@ This article describes how to access an Azure Cosmos DB database from Azure Syna
1717

1818
## Prerequisites
1919

20-
Before you connect an Azure Cosmos DB account to your workspace, you'll need the following:
20+
Before you connect an Azure Cosmos DB database to your workspace, you'll need the following:
2121

22-
* Existing Azure Cosmos DB account or create a new account following this [quickstart](https://docs.microsoft.com/azure/cosmos-db/how-to-manage-database-account)
22+
* Existing Azure Cosmos DB database or create a new account following this [quickstart](https://docs.microsoft.com/azure/cosmos-db/how-to-manage-database-account)
2323
* Existing Synapse workspace or create a new workspace following this [quickstart](https://docs.microsoft.com/azure/synapse-analytics/quickstart-create-workspace)
2424

2525
## Enable Azure Cosmos DB analytical store
@@ -32,16 +32,16 @@ From your Synapse workspace, select **Launch Synapse Studio**. On the Synapse St
3232

3333
## Connect an Azure Cosmos DB database to a Synapse workspace
3434

35-
Connecting an Azure Cosmos DB database is done as a linked service. A Cosmos DB linked service enables users to browse and explore data, read, and write from Synapse Spark or SQL into Azure Cosmos DB.
35+
Connecting an Azure Cosmos DB database is done as a linked service. An Azure Cosmos DB linked service enables users to browse and explore data, read, and write from Synapse Spark or SQL into Azure Cosmos DB.
3636

3737
From the Data Object Explorer, you can directly connect to an Azure Cosmos DB database by doing the following steps:
3838
1. Select ***+*** icon near Data
3939
2. Select **Connect to external data**
40-
3. Select the API that you want to connect to: SQL API or MongoDB API
40+
3. Select the API that you want to connect to: SQL API or API for MongoDB
4141
4. Select ***Continue***
4242
5. Name the linked service. The name will be displayed in the Object Explorer and used by Synapse run-times to connect to the database and containers. We recommend using a friendly name.
43-
6. Select the **Cosmos DB account name** and **database name**
44-
7. (Optional) If no region is specified, Synapse run-time operations will be routed toward the nearest region where the analytical store is enabled. However, you can set manually which region you want your users to access Cosmos DB analytical store. Select **Additional connection properties** and then **New**. Under **Property Name**, write ***PreferredRegions*** and set the **Value** to the region you want (example: WestUS2, there is no space between words and number)
43+
6. Select the **Azure Cosmos DB account name** and **database name**
44+
7. (Optional) If no region is specified, Synapse run-time operations will be routed toward the nearest region where the analytical store is enabled. However, you can set manually which region you want your users to access Azure Cosmos DB Analytical Store. Select **Additional connection properties** and then **New**. Under **Property Name**, write ***PreferredRegions*** and set the **Value** to the region you want (example: WestUS2, there is no space between words and number)
4545
8. Select ***Create***
4646

4747
Azure Cosmos DB databases are visible under the tab **Linked** in the Azure Cosmos DB section. With Azure Cosmos DB, you can differentiate an HTAP enabled container from an OLTP only container through the following icons:

articles/synapse-analytics/synapse-link/how-to-query-analytical-store-spark.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Query Azure Cosmos DB Analytical Store with Synapse Spark
3-
description: How to query Cosmos DB analytical with Synapse Spark
3+
description: How to query Azure Cosmos DB analytical with Synapse Spark
44
services: synapse-analytics
55
author: ArnoMicrosoft
66
ms.service: synapse-analytics
@@ -22,7 +22,7 @@ In this step, you'll read data from Azure Cosmos DB analytical store in a Spark
2222
This operation doesn't impact the transactional store.
2323

2424
```python
25-
# To select a preferred list of regions in a multi-region Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
25+
# To select a preferred list of regions in a multi-region Azure Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
2626

2727
df = spark.read.format("cosmos.olap")\
2828
.option("spark.synapse.linkedService", "INFERRED")\
@@ -34,7 +34,7 @@ df = spark.read.format("cosmos.olap")\
3434

3535
The equivalent code gesture in **Scala** would be the following code:
3636
```java
37-
// To select a preferred list of regions in a multi-region Cosmos DB account, add option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
37+
// To select a preferred list of regions in a multi-region Azure Cosmos DB account, add option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
3838

3939
val df_olap = spark.read.format("cosmos.olap").
4040
option("spark.synapse.linkedService", "pySparkSamplesDb").
@@ -50,7 +50,7 @@ This scenario is convenient to reuse tables through third-party tools and provid
5050

5151
```sql
5252
%%sql
53-
-- To select a preferred list of regions in a multi-region Cosmos DB account, add spark.cosmos.preferredRegions '<Region1>,<Region2>' in the config options
53+
-- To select a preferred list of regions in a multi-region Azure Cosmos DB account, add spark.cosmos.preferredRegions '<Region1>,<Region2>' in the config options
5454

5555
create table call_center using cosmos.olap options (
5656
spark.synapse.linkedService 'INFERRED',
@@ -63,8 +63,8 @@ create table call_center using cosmos.olap options (
6363
In this gesture, you'll write a dataframe into a container. This operation will impact the transactional performance and consume Request Units. Using Azure Cosmos DB transactional performance is ideal for write transactions. Make sure that you replace **YOURDATAFRAME** by the dataframe that you want to write back to.
6464

6565
```python
66-
# Write a Spark DataFrame into a Cosmos DB container
67-
# To select a preferred list of regions in a multi-region Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
66+
# Write a Spark DataFrame into an Azure Cosmos DB container
67+
# To select a preferred list of regions in a multi-region Azure Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
6868

6969

7070
YOURDATAFRAME.write.format("cosmos.oltp")\
@@ -77,7 +77,7 @@ YOURDATAFRAME.write.format("cosmos.oltp")\
7777

7878
The equivalent code gesture in **Scala** would be the following code:
7979
```java
80-
// To select a preferred list of regions in a multi-region Cosmos DB account, add option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
80+
// To select a preferred list of regions in a multi-region Azure Cosmos DB account, add option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
8181

8282
import org.apache.spark.sql.SaveMode
8383

@@ -92,10 +92,10 @@ df.write.format("cosmos.oltp").
9292
## Load streaming DataFrame from container
9393
In this gesture, you'll use Spark Streaming capability to load data from a container into a dataframe. The data will be stored in the primary data lake account (and file system) that you connected to the workspace.
9494

95-
If the folder */localReadCheckpointFolder* isn't created, it will be automatically created. This operation will impact the transactional performance of Cosmos DB.
95+
If the folder */localReadCheckpointFolder* isn't created, it will be automatically created. This operation will impact the transactional performance of Azure Cosmos DB.
9696

9797
```python
98-
# To select a preferred list of regions in a multi-region Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
98+
# To select a preferred list of regions in a multi-region Azure Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
9999

100100
dfStream = spark.readStream\
101101
.format("cosmos.oltp")\
@@ -110,7 +110,7 @@ dfStream = spark.readStream\
110110

111111
The equivalent code gesture in **Scala** would be the following code:
112112
```java
113-
// To select a preferred list of regions in a multi-region Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
113+
// To select a preferred list of regions in a multi-region Azure Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
114114

115115
val dfStream = spark.readStream.
116116
format("cosmos.oltp").
@@ -124,10 +124,10 @@ val dfStream = spark.readStream.
124124
```
125125

126126
## Write streaming DataFrame to container
127-
In this gesture, you'll write a streaming dataframe into the Cosmos DB container you selected. If the folder */localReadCheckpointFolder* isn't created, it will be automatically created. This operation will impact the transactional performance of Cosmos DB.
127+
In this gesture, you'll write a streaming dataframe into the Azure Cosmos DB container you selected. If the folder */localReadCheckpointFolder* isn't created, it will be automatically created. This operation will impact the transactional performance of Azure Cosmos DB.
128128

129129
```python
130-
# To select a preferred list of regions in a multi-region Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
130+
# To select a preferred list of regions in a multi-region Azure Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
131131

132132
streamQuery = dfStream\
133133
.writeStream\
@@ -144,7 +144,7 @@ streamQuery.awaitTermination()
144144

145145
The equivalent code gesture in **Scala** would be the following code:
146146
```java
147-
// To select a preferred list of regions in a multi-region Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
147+
// To select a preferred list of regions in a multi-region Azure Cosmos DB account, add .option("spark.cosmos.preferredRegions", "<Region1>,<Region2>")
148148

149149
val query = dfStream.
150150
writeStream.
@@ -161,4 +161,4 @@ query.awaitTermination()
161161
## Next steps
162162

163163
* [Learn what is supported between Synapse and Azure Cosmos DB](./concept-synapse-link-cosmos-db-support.md)
164-
* [Connect to Synapse Link for Cosmos DB](../quickstart-connect-synapse-link-cosmos-db.md)
164+
* [Connect to Synapse Link for Azure Cosmos DB](../quickstart-connect-synapse-link-cosmos-db.md)

0 commit comments

Comments
 (0)