Cosmos DB Connector for Power BI
In this article you will learn how to integrate Using Cosmos DB Connector you will be able to connect, read, and write data from within Power BI. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
Connect to Cosmos DB in other apps
|
Video Tutorial - Integrate Cosmos DB data in Power BI
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
Cosmos DB integration in Power BI - How to configure connection for
Cosmos DB - Features about
API Driver (Authentication / Query Language / Examples / Driver UI) - Using
Cosmos DB Connection in Power BI
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Cosmos DB using Power BI we first need to create a DSN (Data Source) which will access data from Cosmos DB. We will later be able to read data using Power BI. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API DriverYou should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
When the Configuration window appears give your data source a name if you haven't done that already, then select "Cosmos DB" from the list of Popular Connectors. If "Cosmos DB" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
CosmosDbDSNCosmos DB -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Steps how to get and use Cosmos DB credentials : ApiKey [Http]
Connecting to your Azure Cosmos DB data requires you to authenticate your REST API access. Follow the instructions below:- Go to your Azure portal homepage: https://portal.azure.com/
- In the search bar at the top of the homepage, enter Azure Cosmos DB. In the dropdown that appears, select Azure Cosmos DB.
- Click on the name of the database account you want to connect to. (Also copy and paste the name of the database account for later use.)
- On the next page where you can see all of the database account information, look along the left side and select Keys.
- On the Keys page, you will have two tabs: Read-write Keys and Read-only Keys. If you are going to write data to your database, you need to remain on the Read-write Keys tab. If you are only going to read data from your database, you should select the Read-only Keys tab.
- On the Keys page, copy the PRIMARY KEY value and paste it somewhere for later use. (The SECONDARY KEY value may also be copied and pasted instead of PRIMARY KEY.)
- Back at the connector screen, enter the primary or secondary key you recorded in step 6 into the Primary or Secondary Key field.
- Enter the database account you recorded in step 3 into the Database Account field.
- Enter or select the default database you want to connect to using the Defualt Database field.
- Enter or select the default table (i.e. container/collection) you want to connect to using the Default Table (Container/Collection) field.
- Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure Devops account.
- If the connection test succeeds, select OK.
Fill in all required parameters and set optional parameters if needed:
CosmosDbDSNCosmos DBApiKey [Http]https://[$Account$].documents.azure.comRequired Parameters Primary or Secondary Key Fill-in the parameter... Account Name (Case-Sensitive) Fill-in the parameter... Database Name (keep blank to use default) Case-Sensitive Fill-in the parameter... API Version Fill-in the parameter... Optional Parameters Default Table (needed to invoke #DirectSQL) -
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Video instructions
Read Cosmos DB data in Power BI using ODBC
Importing Cosmos DB data into Power BI from table or view
-
Once you open Power BI Desktop click Get Data to get data from ODBC:
-
A window opens, and then search for "odbc" to get data from ODBC data source:
-
Another window opens and asks to select a Data Source we already created. Choose CosmosDbDSN and continue:
CosmosDbDSN -
Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:
CosmosDbDSN -
Finally, you will be asked to select a table or view to get data from. Select one and load the data!
-
Finally, finally, use extracted data from Cosmos DB in a Power BI report:
Importing Cosmos DB data into Power BI using SQL query
If you wish to import Cosmos DB data from SQL query rather than a table then you can use advanced options during import steps (as below). After selecting DSN you can click on advanced options to see SQL Query editor.
SELECT ProductID, ProductName, SupplierID, CategoryID, QuantityPerUnit, UnitPrice FROM Products WHERE UnitPrice > 20
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - Cosmos DBConnect to your Azure Cosmos DB databases to read, query, create, update, and delete documents and more!CosmosDbDSN
- The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
CosmosDbDSNDRIVER={ZappySys API Driver};ServiceUrl=https://[$Account$].documents.azure.com;CredentialType=HashSignature;HashSignatureFormat=[$http-method$]-lc[$lf$][$url-part-regex-(/(?<resourcetype>dbs|colls|docs|users|permissions|sprocs|attachments|pkranges)(/([\w\d-\$\.=])+)?$){{0,resourcetype}}$]-lc[$lf$][$url-part-regex-(?<id>dbs/([\w \d-+=.]+)$)|((?<id>dbs/(.*?))/(colls|docs|users|attachments|permissions||pkranges)$)|(?<id>dbs/(.*)/(colls|docs|users|attachments|permissions)/[\w \d-+.=]+$){{0,id}}$][$lf$][$timestamp$]-lc[$lf$][$lf$];ExtraHeaders=x-ms-date: [$timestamp$]||x-ms-version: [$ApiVersion$]||Authorization:type%3dmaster%26ver%3d1.0%26sig%3d[$signature$]-enc;HashTimestampFormat=r;
- You are good to go! The script will execute the same way as using a DSN.
Have in mind that a full connection string has length limitations.
Proceed to the next step to find out the details.
Limitations of using a full connection string
Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:
"Connection string exceeds maximum allowed length of 1024"
But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:
- Open your ODBC data source.
- Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
- Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
- Continue by pasting the copied connection string into a newly created file and save it.
-
Finally, the last step! Just construct a shorter ODBC connection string using this format:
DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt
- Our troubles are over! Now you should be able to use this connection string in Power BI with no problems.
Editing query for table in Power BI
There will be a time you need to change the initial query after importing data into Power BI. Don't worry, just right-click on your table and click Edit query menu item:
Using parameters in Power BI (dynamic query)
In the real world, many values of your REST / SOAP API call may be coming from parameters. If that's the case for you can try to edit script manually as below. In below example its calling SQL Query with POST method and passing some parameters. Notice below where paraAPIKey is Power BI Parameter (string type). You can use parameters anywhere in your script just like the normal variable.
To use a parameter in Power BI report, follow these simple steps:
-
Firstly, you need to Edit query of your table (see previous section)
-
Then just create a new parameter by clicking Manage Parameters dropdown, click New Parameter option, and use it in the query:
= Odbc.Query("dsn=CosmosDbDSN", "SELECT ProductID, ProductName, UnitPrice, UnitsInStock FROM Products WHERE UnitPrice > " & Text.From(MyParameter) & " ORDER BY UnitPrice")
Refer to Power Query M reference for more information on how to use its advanced features in your queries.
Using DirectQuery Option rather than Import
So far we have seen how to Import Cosmos DB data into Power BI but what if you have too much data and you dont want to import but link it. Power BI Offers very useful feature for this scenario. Its called DirectQuery Option. In this section we will explore how to use DirectQuery along with ZappySys Drivers.
Out of the box ZappySys Drivers wont work in ODBC Connection Mode so you have to use SQL Server Connection rather than ODBC if you wish to use Live data using DirectQuery option. See below step by step instructions to enable DirectQuery mode in Power BI for Cosmos DB data.
Basically we will use ZappySys Data Gateway its part of ODBC PowerPack. We will then use Linked Server in SQL Server to Link API Service and then we will issue OPENROWSET queries from Power BI to SQL Server and it will then call Cosmos DB via ZappySys Data Gateway.
- First read this article carefully, How to query Cosmos DB API in SQL Server.
- Once linked server is configured we are ready to issue API query in Power BI.
- Click Get Data in Power BI, select SQL Server Database
- Enter your server name and any database name
- Select Mode as DirectQuery
-
Click on Advanced and enter query like below (we are assuming you have created Cosmos DB Data Source in Data Gateway and defined linked server (Change name below).
SELECT * FROM OPENQUERY([COSMOS_DB_LINKED_SERVER], 'SELECT * FROM Customers')
SELECT * FROM OPENQUERY([COSMOS_DB_LINKED_SERVER], 'SELECT * FROM Customers') - Click OK and Load data ... That's it. Now your Cosmos DB API data is linked rather than imported.
Publishing Power BI report to Power BI service
Here are the instructions on how to publish a Power BI report to Power BI service from Power BI Desktop application:
-
First of all, go to Power BI Desktop, open a Power BI report, and click Publish button:
-
Then select the Workspace you want to publish report to and hit Select button:
-
Finally, if everything went right, you will see a window indicating success:
If you need to periodically refresh Power BI semantic model (dataset) to ensure data accuracy and up-to-dateness, you can accomplish that by using Microsoft On-premises data gateway. Proceed to the next section - Refreshing Power BI semantic model (dataset) using On-premises data gateway - and learn how to do that.
Refreshing Power BI semantic model (dataset) using On-premises data gateway
Power BI allows to refresh semantic models which are based on data sources that reside on-premises. This can be achieved using Microsoft On-premises data gateway. There are two types of On-premises gateways:
- Standard Mode
- Personal Mode
Standard Mode supports Power BI and other Microsoft Data Fabric services. It fits perfectly for Enterprise solutions as it installs as a Windows Service and also supports Direct Query feature.
Personal Mode, on the other hand, can be configured faster, but is designed more for home users (you cannot install it as a Windows Service and it does not support DirectQuery). You will find a detailed comparison in the link above.
We recommend to go with Personal Mode for a quick POC solution, but use Standard Mode in production environment.
Below you will find instructions on how to refresh semantic model using both types of gateways.
Refresh using On-premises data gateway (standard mode)
Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (standard mode):
-
Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:
-
If you see this view, it means you have to install On-premises data gateway (standard mode):
-
Install On-premises data gateway (standard mode) and sign-in:
Use the same email address you use when logging in into Power BI account. -
Register a new gateway (or migrate an existing one):
-
If you are creating a new gateway, name your gateway, enter a Recovery key, and click Configure button:
-
Now, let's get back to your semantic model settings in Power BI portal. Refresh the page and you should see your newly created gateway. Click arrow icon and then click on Add to gateway link:
ODBC{"connectionstring":"dsn=CosmosDbDSN"} -
Once you do that, you will create a new gateway connection. Give it a name, set Authentication method, Privacy level, and click Create button:
dsn=CosmosDbDSNIn this example, we used the least restrictive Privacy level.If your connection uses a full connection string you may hit a length limitation when entering it into the field. To create the connection, you will need to shorten it manually. Check the section about the limitation of a full connection string on how to accomplish it.
On-premises data gateway (personal mode) does not have this limitation.
-
Proceed by choosing the newly created connection:
ODBC{"connectionstring":"dsn=CosmosDbDSN"} -
Finally, you are at the final step where you can refresh the semantic model:
Refresh using On-premises data gateway (personal mode)
Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (personal mode):
-
Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:
-
If you see this view, it means you have to install On-premises data gateway (personal mode):
-
Install On-premises data gateway (personal mode) and sign-in:
Use the same email address you use when logging in into Power BI account. -
Again, go to your semantic model Settings, expand Data source credentials, click Edit credentials, select Authentication method together with Privacy level, and then click Sign in button:
dsn=CosmosDbDSN -
Finally, you are ready to refresh your semantic model:
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by Cosmos DB Connector
Cosmos DB Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description |
---|---|
Database Name (keep blank to use default) Case-Sensitive |
|
Parameter | Description |
---|---|
Database Name (keep blank to use default) Case-Sensitive |
|
Parameter | Description |
---|---|
Table Name (Case-Sensitive) |
|
Database Name (keep blank to use default) Case-Sensitive |
|
Parameter | Description |
---|---|
Table Name (Case-Sensitive) |
|
Database Name (keep blank to use default) Case-Sensitive |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
Table Name (Case-Sensitive) |
|
||||||
SQL Query |
|
||||||
Database Name (keep blank to use default) Case-Sensitive |
|
||||||
Allow Query Scan |
|
||||||
Allow Cross Partition Query |
|
||||||
Cross Partition Key Range Id |
|
Parameter | Description |
---|---|
Table Name (Case-Sensitive) |
|
Database Name (keep blank to use default) Case-Sensitive |
|
Parameter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Document Id |
|
||||||||||
Table Name (Case-Sensitive) |
|
||||||||||
Database Name (keep blank to use default) Case-Sensitive |
|
||||||||||
EnableCrossPartition |
|
||||||||||
Partition Key Value (default is supplied Id) |
|
||||||||||
ConsistencyLevel |
|
Parameter | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Document Id |
|
||||||||
Table Name (Case-Sensitive) |
|
||||||||
Database Name (keep blank to use default) Case-Sensitive |
|
||||||||
EnableCrossPartition |
|
||||||||
Partition Key Value (default is supplied Id) |
|
Parameter | Description |
---|---|
Database Name (keep blank to use default) Case-Sensitive |
|
Parameter | Description |
---|---|
User Name (Case-Sensitive) |
|
Database Name (keep blank to use default) Case-Sensitive |
|
Parameter | Description |
---|---|
Database Name (keep blank to use default) Case-Sensitive |
|
RequestBody |
|
Parameter | Description |
---|---|
Upsert |
|
Parameter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Permission Name (e.g. read_orders) |
|
||||||||||
Database Name (keep blank to use default) Case-Sensitive |
|
||||||||||
User Name (Case-Sensitive) |
|
||||||||||
PermissionMode |
|
||||||||||
Table (Add Permission for this) |
|
||||||||||
ExpiresInSecond |
|
Parameter | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Url |
|
||||||||||||||||||||||||||
Body |
|
||||||||||||||||||||||||||
IsMultiPart |
|
||||||||||||||||||||||||||
Filter |
|
||||||||||||||||||||||||||
Headers |
|
Parameter | Description |
---|---|
Url |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Cosmos DB Connector Examples for Power BI Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Query using Cosmos DB (Using Default Table) [Read more...]
Lists all containers from the default database specified (Specified for the connection settings). Check this URL for more information on query syntax: https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/query/select
#DirectSQL SELECT * FROM root where root.id !=null order by root._ts desc
Read all documents for a collection in Cosmos DB [Read more...]
Read all documents for a collection in Cosmos DB.
SELECT * FROM TestContainer
Read a document by Id from a collection in Cosmos DB [Read more...]
Read a single document by Id from a collection in Cosmos DB.
SELECT * FROM TestContainer Where Id='user2'
Query Documents from Cosmos DB Table (Container) using SQL [Read more...]
Lists all users Cosmos DB Database
SELECT *
FROM query_documents
WITH(
-- Database='TestDB', --if you dont supply connection level Default Database name is used
Table='TestContainer',
Query='select * from root Where root.id!=null order by root._ts desc',
Meta='id:string(50);name:string(50);city;age'
--Meta='id; name; city; age' -- no types at all. Default is string(2000)
--Meta='id; name:string(50); city; age: int' --Mixed types. If type is missing default string(2000) used
--check below URL for more information on Qyery Language Syntax
--https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/query/select
)
Create a new document with Partition Key supplied [Read more...]
Loads a new document into specified container with partition key. If you created container with Partition Key requirement then must supply it. Partition Key must be valid value from Document Attribute used as Partition Key.
INSERT INTO TestContainer (PartitionKey, Document)
VALUES(
'["user2"]', --partition key value must match its attribute from document else it will throw error. In this example container PartitionKey is /id so we used its value. For multiple key use JSON array ["val1","val2"]
'{
"id": "user2",
"name": "John Doe",
"email": "jdoe@contoso.com",
"phone": ["12345"],
"level": "platinum"
}'
)
WITH(Upsert='true')
Create a new document from a file path (Upload from local disk file) [Read more...]
Loads a new document into specified container from local file path. File path must start with @ symbol
INSERT INTO TestContainer (PartitionKey, Document)
VALUES(
'["user2"]', --partition key value must match its attribute from document else it will throw error. In this example container PartitionKey is /id so we used its value. For multiple key use JSON array ["val1","val2"]
'@c:\data\order.json' --path must start with @ symbol
)
WITH(Upsert='true', IsMultiPart=1)
Upsert a document (Insert or Update if exists) [Read more...]
Upsert a document (Update if id exists else create new one).
INSERT INTO TestContainer (PartitionKey, Document)
VALUES(
'["user2"]', --partition key value must match its attribute from document else it will throw error. In this example container PartitionKey is /id so we used its value. For multiple key use JSON array ["val1","val2"]
'{
"id": "user2",
"name": "John Doe",
"email": "jdoe@contoso.com",
"phone": ["12345"],
"level": "platinum"
}')
WITH(Upsert='true')
Upsert a document (Insert or Update if exists) - Use UPSERT Keyword rather than WITH option [Read more...]
Upsert a document (Update if id exists else create new one). This one uses UPSERT KEY word slight simpler syntax becuase you dont need WITH clause like INSERT... WITH(UPSERT='true') example.
UPSERT INTO TestContainer (PartitionKey, Document)
VALUES(
'["user2"]', --partition key value must match its attribute from document else it will throw error. In this example container PartitionKey is /id so we used its value. For multiple key use JSON array ["val1","val2"]
'{
"id": "user2",
"name": "John Doe",
"email": "jdoe@contoso.com",
"phone": ["12345"],
"level": "platinum"
}')
Update (replace) a document (By default Full replace) [Read more...]
Update a document for a specified Document Id.
UPDATE TestContainer
SET
PartitionKey='["user2"]'
,Document=
'{
"id" : "user2",
"name": "John Doe at <<FUN_NOW>>",
"email": "jdoe@contoso.com",
"phone": ["<<FUN_TODAY>>"],
"level": "platinum"
}'
Where Id='user2'
Partial Update a document (Patch) [Read more...]
Update one or more attributes in a document using PATCH method for a specified Document Id.
UPDATE TestContainer
SET
PartitionKey='["user2"]'
,Document=
'{
"operations": [
{ "op": "set", "path": "/name", "value": "updated name" }
,{ "op": "set", "path": "/email", "value": "updated@email.com" }
]
}'
Where Id='user2'
WITH(
RequestMethod='PATCH' --Partial Replace (change name and email only)
)
/*
Example Document Operations
https://learn.microsoft.com/en-us/azure/cosmos-db/partial-document-update
https://learn.microsoft.com/en-us/rest/api/cosmos-db/patch-a-document
[
{ "op": "add", "path": "/color", "value": "silver" },
{ "op": "remove", "path": "/used" },
{ "op": "set", "path": "/price", "value": 355.45 }
{ "op": "incr", "path": "/inventory/quantity", "value": 10 },
{ "op": "add", "path": "/tags/-", "value": "featured-bikes" },
{ "op": "move", "from": "/color", "path": "/inventory/color" }
]
*/
Partial Update a document (Patch) from a file path (Upload from local disk file) [Read more...]
Update one or more attributes in a document using PATCH method for a specified Document Id read operations from local disk file.
UPDATE TestContainer
SET
PartitionKey='["user2"]'
,Document='@c:\temp\b.txt' --path must start with @ symbol
Where Id='user2'
WITH(
RequestMethod='PATCH' --Partial Replace (change name and email only)
,IsMultiPart=1 --this enables file upload
)
/*
Example Document Operations
https://learn.microsoft.com/en-us/azure/cosmos-db/partial-document-update
https://learn.microsoft.com/en-us/rest/api/cosmos-db/patch-a-document
[
{ "op": "add", "path": "/color", "value": "silver" },
{ "op": "remove", "path": "/used" },
{ "op": "set", "path": "/price", "value": 355.45 }
{ "op": "incr", "path": "/inventory/quantity", "value": 10 },
{ "op": "add", "path": "/tags/-", "value": "featured-bikes" },
{ "op": "move", "from": "/color", "path": "/inventory/color" }
]
*/
List Databases [Read more...]
Lists all databases for specified Cosmos DB Account
SELECT * FROM SysDatabases
List Tables (i.e. Containers) [Read more...]
Lists all containers from the default database specified (Specified for the connection settings)
SELECT * FROM SysTables
List Tables (i.e. Containers) for a specific database [Read more...]
Lists all containers from the specified Database
SELECT * FROM SysTables WITH (Database='MyCosmos DB')
List Users for the Database [Read more...]
Lists all users Cosmos DB Database
SELECT * FROM SysUsers
Conclusion
In this article we discussed how to connect to Cosmos DB in Power BI and integrate data without any coding. Click here to Download Cosmos DB Connector for Power BI and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Cosmos DB Connector for Power BI
Documentation
More integrations
Other application integration scenarios for Cosmos DB
Other connectors for Power BI
Download Cosmos DB Connector for Power BI
Documentation
How to connect Cosmos DB in Power BI?
How to get Cosmos DB data in Power BI?
How to read Cosmos DB data in Power BI?
How to load Cosmos DB data in Power BI?
How to import Cosmos DB data in Power BI?
How to pull Cosmos DB data in Power BI?
How to push data to Cosmos DB in Power BI?
How to write data to Cosmos DB in Power BI?
How to POST data to Cosmos DB in Power BI?
Call Cosmos DB API in Power BI
Consume Cosmos DB API in Power BI
Cosmos DB Power BI Automate
Cosmos DB Power BI Integration
Integration Cosmos DB in Power BI
Consume real-time Cosmos DB data in Power BI
Consume real-time Cosmos DB API data in Power BI
Cosmos DB ODBC Driver | ODBC Driver for Cosmos DB | ODBC Cosmos DB Driver | SSIS Cosmos DB Source | SSIS Cosmos DB Destination
Connect Cosmos DB in Power BI
Load Cosmos DB in Power BI
Load Cosmos DB data in Power BI
Read Cosmos DB data in Power BI
Cosmos DB API Call in Power BI