Skip to content

Commit a8edb67

Browse files
authored
Merge pull request #115278 from julieMSFT/release-build-synapse
Build 2020 release-build-synapse
2 parents 34ce7e0 + 9b5cef8 commit a8edb67

File tree

9 files changed

+370
-11
lines changed

9 files changed

+370
-11
lines changed

articles/synapse-analytics/includes/note-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ ms.author: jrasnick
1010
> This preview version is provided without a service level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
1111
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
1212
>
13-
> To access the preview features of Azure Synapse, request access [here](https://aka.ms/synapsepreview). Microsoft will triage all requests and respond as soon as possible.
13+
773 Bytes
Loading
641 Bytes
Loading
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Connect to Synapse Link for Azure Cosmos DB
3+
description: How to connect an Azure Cosmos DB to a Synapse workspace with Synapse Link
4+
services: synapse-analytics
5+
author: ArnoMicrosoft
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 to Synapse Link for Azure Cosmos DB
15+
16+
This article describes how to access an Azure Cosmos DB database from Azure Synapse Analytics studio with Synapse Link.
17+
18+
## Prerequisites
19+
20+
Before you connect an Azure Cosmos DB account to your workspace, there are a few things that you need.
21+
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)
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 Azure Cosmos DB analytical store
26+
27+
To run large-scale analytics into Azure Cosmos DB without impacting your operational performance, we recommend enabling Synapse Link for Azure Cosmos DB. This function brings HTAP capability to a container and built-in support in Azure Synapse. Follow this quickstart to enable Synapse Link for Cosmos DB containers.
28+
29+
## Navigate to Synapse Studio
30+
31+
From your Synapse workspace, select **Launch Synapse Studio**. On the Synapse Studio home page, select **Data, which will take you to the **Data Object Explorer**.
32+
33+
## Connect an Azure Cosmos DB database to a Synapse workspace
34+
35+
Connecting an Azure 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 Azure Cosmos DB.
36+
37+
From the Data Object Explorer, you can directly connect an Azure Cosmos DB database by doing the following steps:
38+
1. Select ***+*** icon near Data
39+
2. Select **Connect to external data**
40+
3. Select the API that you want to connect to: SQL or MongoDB
41+
4. Select ***Continue***
42+
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 numbers)
45+
8. Select ***Create***
46+
47+
Azure Cosmos DB databases are visible under the tab **Linked** in the Azure Cosmos DB section. You can differentiate an HTAP enabled Azure Cosmos DB container from an OLTP only container with the following icons:
48+
49+
**Synapse container**:
50+
51+
![HTAP container](./media/quickstart-connect-synapse-link-cosmosdb/htap-container.png)
52+
53+
**OLTP only container**:
54+
55+
![OLTP container](./media/quickstart-connect-synapse-link-cosmosdb/oltp-container.png)
56+
57+
## Quickly interact with code-generated actions
58+
59+
When you right-click into a container, you'll have a list of gestures that will trigger a Spark or SQL run-time. Writing into a container will happen through the Transactional Store of Azure Cosmos DB and will consume Request Units.
60+
61+
## Next steps
62+
63+
* [Learn what is supported between Synapse and Azure Cosmos DB](./synapse-link/concept-synapse-link-cosmos-db-support.md)
64+
* [Learn how to query an analytical store with Synapse Spark](synapse-link/how-to-query-analytical-store-spark.md)

articles/synapse-analytics/sql-data-warehouse/sql-data-warehouse-overview-what-is.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,19 @@ ms.reviewer: igorstan
1515
# What is Azure Synapse Analytics (formerly SQL DW)?
1616

1717
> [!NOTE]
18-
> Try the latest Azure Synapse features such as workspaces, Spark, SQL on demand, and the integrated Synapse Studio experience
19-
> by [requesting access to Azure Synapse (workspaces preview)](https://aka.ms/synapsepreview).
20-
>
2118
>Explore the [Azure Synapse (workspaces preview) documentation](../overview-what-is.md).
19+
>
2220
2321
Azure Synapse is an analytics service that brings together enterprise data warehousing and Big Data analytics. It gives you the freedom to query data on your terms, using either serverless on-demand or provisioned resources—at scale. Azure Synapse brings these two worlds together with a unified experience to ingest, prepare, manage, and serve data for immediate BI and machine learning needs.
2422

2523
Azure Synapse has four components:
2624

2725
- Synapse SQL: Complete T-SQL based analytics – Generally Available
2826
- SQL pool (pay per DWU provisioned)
29-
- SQL on-demand (pay per TB processed) – (Preview)
30-
- Spark: Deeply integrated Apache Spark (Preview)
31-
- Synapse Pipelines: Hybrid data integration (Preview)
32-
- Studio: Unified user experience. (Preview)
33-
34-
27+
- SQL on-demand (pay per TB processed) (preview)
28+
- Spark: Deeply integrated Apache Spark (preview)
29+
- Synapse Pipelines: Hybrid data integration (preview)
30+
- Studio: Unified user experience. (preview)
3531

3632
## Synapse SQL pool in Azure Synapse
3733

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Azure Synapse Link for Azure Cosmos DB supported features
3+
description: Understand the current list of actions supported by Azure Synapse Link for Azure Cosmos DB
4+
services: synapse-analytics
5+
author: ArnoMicrosoft
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+
# Azure Synapse Link for Azure Cosmos DB supported features
15+
16+
This article describes the functionalities that are currently supported in Azure Synapse Link for Azure Cosmos DB.
17+
18+
## Azure Synapse support
19+
20+
There are two types of containers in Azure Cosmos DB:
21+
* HTAP container - A container with Synapse Link enabled. This container has both transactional store and analytical store.
22+
* OLTP container - A container with only transaction store; Synapse Link is not enabled.
23+
24+
You can connect to an Azure Cosmos DB container without enabling Synapse Link, in which case you can only read/write to the transactional store. What follows a is list of the currently supported features within Synapse Link for Azure Cosmos DB.
25+
26+
| 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) |
27+
| -------------------- | ----------------------------------------------------------- |----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
28+
| **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+
| **Azure Cosmos DB API support** |API support as a Synapse Link| SQL / MongoDB | SQL / MongoDB |
30+
| **Object** |Objects such as a table that can be created, pointing directly to Azure Cosmos DB container| View, Table | View |
31+
| **Read** |Read data from an Azure Cosmos DB container| OLTP / HTAP | HTAP |
32+
| **Write** |Write data from run-time into an Azure Cosmos DB container| OLTP | n/a |
33+
34+
* If you write data into an Azure Cosmos DB container from Spark, this process happens through the transactional store of Azure Cosmos DB and will impact the transactional performance of Azure Cosmos DB by consuming Request Units.
35+
* SQL pool integration through external tables is currently not supported.
36+
37+
## Supported code-generated actions for Spark
38+
39+
| Gesture | Description |OLTP |HTAP |
40+
| -------------------- | ----------------------------------------------------------- |----------------------------------------------------------- |----------------------------------------------------------- |
41+
| **Load to DataFrame** |Load and read data into a Spark DataFrame |X||
42+
| **Create Spark table** |Create a table pointing to an Azure Cosmos DB container|X||
43+
| **Write DataFrame to container** |Write data into a container|||
44+
| **Load streaming DataFrame from container** |Stream data using Azure Cosmos DB change feed|||
45+
| **Write streaming DataFrame to container** |Stream data using Azure Cosmos DB change feed|||
46+
47+
48+
49+
## Supported code-generated actions for SQL serverless
50+
51+
| Gesture | Description |OLTP |HTAP |
52+
| -------------------- | ----------------------------------------------------------- |----------------------------------------------------------- |----------------------------------------------------------- |
53+
| **Select top 100** |Preview top 100 items from a container|X||
54+
| **Create view** |Create a view to directly have BI access in a container through Synapse SQL|X||
55+
56+
## Next steps
57+
58+
* See how to [connect to Synapse Link for Azure Cosmos DB](../quickstart-connect-synapse-link-cosmos-db.md)
59+
* [Learn how to query the analytical store with Spark](how-to-query-analytical-store-spark.md)
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
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
4+
services: synapse-analytics
5+
author: ArnoMicrosoft
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 to Azure Synapse Link for Azure Cosmos DB
15+
16+
This article describes how to access an Azure Cosmos DB database from Azure Synapse Analytics Studio with Azure Synapse Link.
17+
18+
## Prerequisites
19+
20+
Before you connect an Azure Cosmos DB database to your workspace, you'll need the following:
21+
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)
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 Azure Cosmos DB analytical store
26+
27+
To run large-scale analytics into Azure Cosmos DB without impacting your operational performance, we recommend enabling Synapse Link for Azure Cosmos DB. Synapse Link brings HTAP capability to a container and built-in support in Azure Synapse.
28+
29+
## Navigate to Synapse Studio
30+
31+
From your Synapse workspace, select **Launch Synapse Studio**. On the Synapse Studio home page, select **Data, which will take you to the **Data Object Explorer**.
32+
33+
## Connect an Azure Cosmos DB database to a Synapse workspace
34+
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.
36+
37+
From the Data Object Explorer, you can directly connect to an Azure Cosmos DB database by doing the following steps:
38+
1. Select ***+*** icon near Data
39+
2. Select **Connect to external data**
40+
3. Select the API that you want to connect to: SQL API or API for MongoDB
41+
4. Select ***Continue***
42+
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 **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)
45+
8. Select ***Create***
46+
47+
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:
48+
49+
**OLTP only container**:
50+
51+
![OLTP container](../media/quickstart-connect-synapse-link-cosmosdb/oltp-container.png)
52+
53+
**HTAP enabled container**:
54+
55+
![HTAP container](../media/quickstart-connect-synapse-link-cosmosdb/htap-container.png)
56+
57+
## Quickly interact with code-generated actions
58+
59+
By right-clicking into a container, you have list of gestures that will trigger a Spark or SQL run-time. Writing into a container will happen through the Transactional Store of Azure Cosmos DB and will consume Request Units.
60+
61+
## Next steps
62+
63+
* [Learn what is supported between Synapse and Azure Cosmos DB](./concept-synapse-link-cosmos-db-support.md)
64+
* [Learn how to query the analytical store with Spark](./how-to-query-analytical-store-spark.md)

0 commit comments

Comments
 (0)