You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/cosmos-db/configure-synapse-link.md
+24-36Lines changed: 24 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Azure Synapse Link is available for Azure Cosmos DB SQL API or for Azure Cosmos
18
18
19
19
*[Enable Azure Synapse Link for your Azure Cosmos DB accounts](#enable-synapse-link)
20
20
*[Create an analytical store enabled container](#create-analytical-ttl)
21
-
*[Enable analytical store for an existing container](#update-analytical-ttl)
21
+
*[Enable analytical store on an existing container](#update-analytical-ttl)
22
22
*[Optional - Update analytical store ttl for an container](#update-analytical-ttl)
23
23
*[Connect your Azure Cosmos database to an Azure Synapse workspace](#connect-to-cosmos-database)
24
24
*[Query the analytical store using Azure Synapse Spark Pool](#query-analytical-store-spark)
@@ -97,7 +97,7 @@ You can turn on analytical store when creating an Azure Cosmos DB container by u
97
97
98
98
### Azure Cosmos DB SDKs
99
99
100
-
Set the `analytical TTL` property to the required value. For the list of allowed values, see the [analytical TTL supported values](analytical-store-introduction.md#analytical-ttl) article.
100
+
Set the `analytical TTL` property to the required value to create an analytical store enabled container. For the list of allowed values, see the [analytical TTL supported values](analytical-store-introduction.md#analytical-ttl) article.
The following code creates a container with analytical store by using the Python V4 SDK. Set the `analytical_storage_ttl` property to the required value in seconds or use `-1` for infinite retention. This setting can be changed later.
135
135
136
-
```python
137
-
import azure.cosmos as cosmos
138
-
139
-
print (cosmos.__version__)
140
-
```
141
-
The next step creates a container with analytical store by using the Azure Cosmos DB Python SDK:
142
-
143
136
```python
144
137
# Azure Cosmos DB Python SDK, for SQL API only.
145
138
# Creating an analytical store enabled container.
146
139
140
+
import azure.cosmos as cosmos
147
141
import azure.cosmos.cosmos_client as cosmos_client
148
142
import azure.cosmos.exceptions as exceptions
149
143
from azure.cosmos.partition_key import PartitionKey
Set the `analytical TTL` property to the required value. For the list of allowed values, see the [analytical TTL supported values](analytical-store-introduction.md#analytical-ttl) article.
175
+
Set the `analytical TTL` property to the required value to create an analytical store enabled container. For the list of allowed values, see the [analytical TTL supported values](analytical-store-introduction.md#analytical-ttl) article.
188
176
189
177
#### Azure CLI
190
178
@@ -201,42 +189,42 @@ The following options create a container with analytical store by using PowerShe
201
189
*[Create an Azure Cosmos DB SQL API container](/powershell/module/az.cosmosdb/new-azcosmosdbsqlcontainer)
202
190
203
191
204
-
## <aid="update-analytical-ttl"></a> Enable analytical store for an existing container
192
+
## <aid="update-analytical-ttl"></a> Enable analytical store on an existing container
205
193
206
-
You can turn on analytical store on an existing Azure Cosmos DB SQL API container by setting `analytical TTL` property. While Portal will implicitly set it to `-1`, that means infinite retention of the data, SDKs and command line tools allow you to also use positive integers, that represent the retention in seconds. For information on the various `analytical TTL` config options, see the [analytical TTL supported values](analytical-store-introduction.md#analytical-ttl) article. Please note that you can change `analytical TTL` to another value later.
194
+
Due to short-term capacity constraints, you need to register to enable Synapse Link on your existing containers. Depending on the pending requests, approving this request may take anywhere from a day to a week. Instructions to check the reuqest status are provided below. If you have any issues or questions, please reach out to [[email protected]](mailto:[email protected]). This step is required once per subscription, and all new database accounts will also have this capability enabled.
207
195
208
-
Please note the following about the process:
196
+
You can turn on analytical store on existing Azure Cosmos DB SQL API containers. This capability is general available and can be used for production workloads. Please note the following details about the initial sync process:
209
197
210
-
* The initial sync with analytical store total time will vary depending on your data volume and on the complexity of the documents.
211
-
* The throughput of your container or database account also influences the total sync time. Although RU/s are not used in this migration, the total RU/s available influences the performance of the sync process.
212
-
* You won't be able to query analytical store of an existing container until the end of the initial sync process.
213
-
214
-
> [!NOTE]
215
-
> Currently exiosting MongoDB API collections are not supported. The alternative is to migrate the data into a new collection, created with analytical store turned on.
198
+
* The same performance isolation of the analytical store auto-sync process applies to the initial sync and there is no performance impact on your OLTP workload.
216
199
217
-
> [!NOTE]
218
-
> Due to short-term capacity constraints, you need to register to enable Synapse Link on your existing containers. Depending on the pending requests, approving this request may take anywhere from a day to a week. Please come back here to check the status. If you have any issues or questions, please reach out to [[email protected]](mailto:[email protected]). This step is required once per subscription, and all new database accounts will also have this capability enabled.
200
+
* A container's initial sync with analytical store total time will vary depending on the data volume and on the documents complexity. This process can take anywhere from a few seconds to multiple days. Please use the Azure portal to monitor the migration progress.
219
201
202
+
* The throughput of your container, or database account, also influences the total initial sync time. Although RU/s are not used in this migration, the total RU/s available influences the performance of the process. You can temporarily increase your environment's throughput to speed up the process.
203
+
204
+
* You won't be able to query analytical store of an existing container until the end of the initial sync process. Your OLTP workload isn't impacted and you can keep on reading data normally. Data ingested after the start of the initial sync will me merged into analytical store by the regular auto-sync process after completition of the initial process.
205
+
206
+
* Currently existing MongoDB API collections are not supported. The alternative is to migrate the data into a new collection, created with analytical store turned on.
207
+
220
208
> [!NOTE]
221
209
> Currently it is not possible to turn off analytical store from a container. Click [here](analytical-store-introduction.md#analytical-store-pricing) for more information about analytical store pricing.
222
210
223
211
### Azure portal
224
212
225
213
1. Sign in to the [Azure portal](https://portal.azure.com/) or the [Azure Cosmos DB Explorer](https://cosmos.azure.com/).
226
214
2. Navigate to your Azure Cosmos DB account and open the **Synapse Link"** tab in the **Integrations** section. In this tab you can:
227
-
3. Click **Register** to request approval for your subscription. To see the status of request, please come back to this same portal pane.
215
+
3. Click **Register** to request approval for your subscription. To see the status of request, please come back to this same portal pane.
228
216
4. When approved, you will see your account’s containers list and you will be able to select those that will have analytical store enabled.
229
-
5. Optionally, you can go to the **Power BI** tab to create Power BI dashboards on your Synapse Link enabled containers.
217
+
5. Optionally, you can go to the **Power BI** tab, in the **Integrations** section, to create Power BI dashboards on your Synapse Link enabled containers.
230
218
231
219
232
220
### Command Line Tools
233
221
234
-
Analytical store is enabled by setting the `analytical TTL` property when you update your container. For information on the various Analytical TTL config options, see the [analytical TTL supported values](analytical-store-introduction.md#analytical-ttl) article.
222
+
Set the `analytical TTL` property to the required value to create an analytical store enabled container. For the list of allowed values, see the [analytical TTL supported values](analytical-store-introduction.md#analytical-ttl) article.
235
223
236
224
237
225
### Azure CLI
238
226
239
-
Use the options below using `--analytical-storage-ttl -1`to enable analytical store with infinite retention for SQL API containers.
227
+
Use the following steps to enable analytical store on an existing container by using Azure CLI. Set the `--analytical-storage-ttl` property to the required value in seconds or use `-1` for infinite retention. This setting can be changed later.
240
228
241
229
*[Register for approval](/cli/azure/feature/registration) by using `az feature registration create --namespace Microsoft.DocumentDB --name AnalyticalStoreMigration`.
242
230
*[Check the request status](/cli/azure/feature/registration) by using `az feature registration show --namespace Microsoft.DocumentDB --name AnalyticalStoreMigration`.
@@ -245,7 +233,7 @@ Use the options below using `--analytical-storage-ttl -1` to enable analytical s
245
233
246
234
### PowerShell
247
235
248
-
Use the options below using `-AnalyticalStorageTtl -1`to enable analytical store with infinite retention for both SQL API containers.
236
+
Use the following steps to enable analytical store on an existing container by using PowerShell. Set the `-AnalyticalStorageTtl` property to the required value in seconds or use `-1` for infinite retention. This setting can be changed later.
249
237
250
238
*[Register for approval](/powershell/module/az.resources/register-azproviderfeature) using `Register-AzProviderFeature -ProviderName "Microsoft.DocumentDB" -FeatureName "AnalyticalStoreMigration"`.
251
239
*[Check the request status](/powershell/module/az.resources/get-azproviderfeature).
0 commit comments