|
| 1 | +--- |
| 2 | +title: Connect to Synapse Link for Cosmos DB |
| 3 | +description: How to connect a 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 which bring 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 | +## Connect an Azure Cosmos DB database to a Synapse workspace |
| 30 | + |
| 31 | +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. |
| 32 | + |
| 33 | +From the Data Object Explorer, you can directly connect an Azure 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 containers. We recommend using a friendly name. |
| 39 | +6. Select the **Cosmos DB account name** and **database name** |
| 40 | +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) |
| 41 | +8. Select ***Create*** |
| 42 | + |
| 43 | +Azure Cosmos DB database 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: |
| 44 | + |
| 45 | +**Synapse container**: |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | +**OLTP only container**: |
| 50 | + |
| 51 | + |
| 52 | + |
| 53 | +## Quickly interact with code-generated actions |
| 54 | + |
| 55 | +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. |
| 56 | + |
| 57 | +## Next steps |
| 58 | + |
| 59 | +* [Learn what is supported between Synapse and Azure Cosmos DB](./synapse-link/concept-synapse-link-cosmos-db-support.md) |
0 commit comments