Skip to content

Commit 54f19fe

Browse files
Merge pull request #113102 from julieMSFT/ArnoMicrosoft_20200428_3
new articles from Arnaud
2 parents ce9e73a + 121ce5b commit 54f19fe

File tree

5 files changed

+113
-0
lines changed

5 files changed

+113
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Supported features for Cosmos DB
3+
description: Understand the current list of actions supported between Azure Synapse Analytics and Cosmos DB
4+
services: synapse-analytics
5+
author: acomet
6+
ms.service: synapse-analytics
7+
ms.topic: quickstart
8+
ms.subservice:
9+
ms.date: 04/21/2020
10+
ms.author: acomet
11+
ms.reviewer: jrasnick
12+
---
13+
14+
# Supported features between Azure Synapse Analytics and Cosmos DB
15+
16+
This article describes what functionalities are currently supported (and not supported) between Azure Synapse and Cosmos DB analytical store.
17+
18+
## Azure Synapse support
19+
20+
Here is list of the currently supported features between Azure Synapse and Cosmos DB.
21+
22+
| Category | Description |Spark | SQL serverless | SQL provisioned |
23+
| :-------------------- | :----------------------------------------------------------- |:----------------------------------------------------------- | :----------------------------------------------------------- | :----------------------------------------------------------- |
24+
| **Azure Synapse 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)| n/a|
25+
| **Cosmos DB API support** |API support as a Synapse Link| SQL / Mongo DB | SQL / Mongo DB | n/a|
26+
| **Object** |Objects such as table that can be created, pointing directly to Cosmos DB collection| View, Table | View | n/a|
27+
| **Read** |Read data from a Cosmos DB collection| OLTP / HTAP | HTAP | n/a|
28+
| **Write** |Write data from Azure Synapse run-time into a Cosmos DB collection| OLTP | n/a | n/a|
29+
30+
Writing back into a Cosmos DB collection from Spark only happens through the transactional side of Cosmos DB and will impact the transactional performance of Cosmos DB. Data will be automatically replicated into the analytical store if analytical store is enabled at the database level.
31+
32+
## Supported code-generated actions for Spark
33+
34+
| Gesture | Description |OLTP only collection |HTAP collection |
35+
| :-------------------- | :----------------------------------------------------------- |:----------------------------------------------------------- |:----------------------------------------------------------- |
36+
| **Stream data** |Stream data using Cosmos DB change feed|||
37+
| **Ingest into a collection** |Write back data into a collection with Spark|||
38+
| **Load to data frame** |Load and read data into a Spark dataframe |||
39+
40+
## Supported code-generated actions for SQL serverless
41+
42+
| Gesture | Description |OLTP only collection |HTAP collection |
43+
| :-------------------- | :----------------------------------------------------------- |:----------------------------------------------------------- |:----------------------------------------------------------- |
44+
| **Select top 100** |Preview top 100 items from a collection|X||
45+
| **Create view** |Create a view to directly access data in the collection through Synapse and BI tool|X||
46+
47+
## Next steps
48+
49+
See the [Connect to Cosmos DB quickstart](../quickstart-connect-cosmos-db.md)
773 Bytes
Loading
641 Bytes
Loading
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Connect Cosmos DB to Synapse workspace
3+
description: How to connect a Cosmos DB to a Synapse workspace
4+
services: synapse-analytics
5+
author: acomet
6+
ms.service: synapse-analytics
7+
ms.topic: quickstart
8+
ms.subservice:
9+
ms.date: 04/21/2020
10+
ms.author: acomet
11+
ms.reviewer: jrasnick
12+
---
13+
14+
# Connect and access an Azure Cosmos DB database (preview) in Azure Synapse Analytics
15+
16+
This article describes how to access an Azure Cosmos database from Azure Synapse Analytics studio.
17+
18+
## Prerequisites
19+
20+
Before you connect a Cosmos DB account to your workspace, there are a few things that you need.
21+
22+
* Existing Cosmos DB account or create a new account following this [quickstart](https://docs.microsoft.com/azure/cosmos-db/how-to-manage-database-account)
23+
* Existing Synapse workspace or create a new workspace following this [quickstart](https://docs.microsoft.com/azure/synapse-analytics/quickstart-create-workspace)
24+
25+
## Enable Cosmos DB analytical store
26+
27+
To run large-scale analytics into Cosmos DB without impacting your operational performance, we recommend using HTAP collections. HTAP collections can be enabled through the analytical store. Follow this quickstart to enable HTAP containers.
28+
29+
## Connect a Cosmos DB database to a Synapse workspace
30+
31+
Connecting a Cosmos DB database is done as linked service. A Cosmos DB linked service enables users to browse and explore data, read, and write from Synapse Spark or SQL into Cosmos DB.
32+
33+
From the Data Object Explorer, you can directly connect a Cosmos DB database by doing the following steps:
34+
1. Select ***+*** icon near Data
35+
2. Select **Connect to external data**
36+
3. Select the API that you want to connect to: SQL or MongoDB
37+
4. Select ***Continue***
38+
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 collections. We recommend using a friendly name.
39+
6. Select the **Cosmos DB account name** and **database name**
40+
7. Select ***Create***
41+
42+
The Cosmos DB database, should be visible under the tab **Linked** in the Cosmos DB section. You can differentiate an HTAP enabled Cosmos DB collection from an OLTP only collection with the following icons:
43+
44+
**HTAP collection**:
45+
46+
![HTAP collection](./media/quickstart-connect-cosmos-db/htap-collection.png)
47+
48+
**OLTP only collection**:
49+
50+
![OLTP collection](./media/quickstart-connect-cosmos-db/oltp-collection.png)
51+
52+
## Quickly interact with code-generated actions
53+
54+
By right-clicking into a collection, you can use the following gesture that will trigger a Spark or SQL run-time.
55+
56+
## Next steps
57+
58+
* [Learn what is supported between Synapse and Cosmos DB](./cosmos-db-integration/concept-cosmos-db-support.md)

articles/synapse-analytics/toc.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
href: quickstart-create-sql-pool.md
2929
- name: Use SQL on-demand
3030
href: quickstart-sql-on-demand.md
31+
- name: Connect to Cosmos DB
32+
href: quickstart-connect-cosmos-db.md
3133
- name: Tutorials
3234
items:
3335
- name: Run Apache Spark applications for Spark pools
@@ -316,6 +318,10 @@
316318
href: ./sql-data-warehouse/memory-concurrency-limits.md?toc=/azure/synapse-analytics/toc.json&bc=/azure/synapse-analytics/breadcrumb/toc.json
317319
- name: Resource classes
318320
href: ./sql-data-warehouse/resource-classes-for-workload-management.md?toc=/azure/synapse-analytics/toc.json&bc=/azure/synapse-analytics/breadcrumb/toc.json
321+
- name: Synapse Link
322+
items:
323+
- name: Synapse Link supported features
324+
href: ./cosmos-db-integration/concept-cosmos-db-support.md
319325
- name: Tools integration (AI, ETL, BI)
320326
items:
321327
- name: Troubleshoot Synapse Analytics Studio

0 commit comments

Comments
 (0)