Cosmos DB Connector for Tableau Connect to your Azure Cosmos DB databases to read, query, create, update, and delete documents and more! In this article you will learn how to quickly and efficiently integrate Cosmos DB data in Tableau without coding. We will use high-performance Cosmos DB Connector to easily connect to Cosmos DB and then access the data inside Tableau. Let's follow the steps below to see how we can accomplish that! Download Documentation Cosmos DB Connector for Tableau is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.

Connect to Cosmos DB in other apps Connect to Cosmos DB in SSIS Connect to Cosmos DB in SQL Server Connect to Cosmos DB in Power BI Connect to Cosmos DB in SSRS Connect to Cosmos DB in Informatica Connect to Cosmos DB in MS Access Connect to Cosmos DB in MS Excel Connect to Cosmos DB in SSAS Connect to Cosmos DB in C# Connect to Cosmos DB in Python Connect to Cosmos DB in JAVA Connect to Cosmos DB in SAP Crystal Reports Connect to Cosmos DB in Azure Data Factory (Pipeline) Connect to Cosmos DB in Azure Data Factory (SSIS) Connect to Cosmos DB in Talend Studio Connect to Cosmos DB in UiPath Connect to Cosmos DB in PowerShell Connect to Cosmos DB in ODBC

Create Data Source in ZappySys Data Gateway based on API Driver

1. Download and install ODBC PowerPack.

2. Search for gateway in start menu and Open ZappySys Data Gateway:
   

3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
   

4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

   CosmosDbDSN

   
   

5. 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:

   CosmosDbDSN

   Cosmos DB

   

6. 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.

    API Key [Http]

   Steps how to get and use Cosmos DB credentials : API Key [Http]
   Connecting to your Azure Cosmos DB data requires you to authenticate your REST API access. Follow the instructions below:

   1. Go to your Azure portal homepage: https://portal.azure.com/.
   2. In the search bar at the top of the homepage, enter Azure Cosmos DB. In the dropdown that appears, select Azure Cosmos DB.
   3. 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).
   4. On the next page where you can see all of the database account information, look along the left side and select Keys:
   5. 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.
   6. 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 used).
   7. Now go to SSIS package or ODBC data source and use this PRIMARY KEY in API Key authentication configuration.
   8. Enter the primary or secondary key you recorded in step 6 into the Primary or Secondary Key field.
   9. Then enter the database account you recorded in step 3 into the Database Account field.
   10. Next, enter or select the default database you want to connect to using the Defualt Database field.
   11. Continue by entering or selecting the default table (i.e. container/collection) you want to connect to using the Default Table (Container/Collection) field.
   12. Select the Test Connection button at the bottom of the window to verify proper connectivity with your Azure Devops account.
   13. If the connection test succeeds, select OK.
   14. Done! Now you are ready to use Asana Connector!

   Fill in all required parameters and set optional parameters if needed:

   CosmosDbDSN

   Cosmos DB

   API Key [Http]

   https://[$Account$].documents.azure.com

   Required 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)

   

7. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   ZappySys API Driver - Cosmos DB

   Connect to your Azure Cosmos DB databases to read, query, create, update, and delete documents and more!

   CosmosDbDSN

   

8. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Tableau to retrieve data from Cosmos DB. Hit OK button to use this query in the next step.

   #DirectSQL SELECT * FROM root where root.id !=null order by root._ts desc

   
   Some parameters configured in this window will be passed to the Cosmos DB API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

9. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Tableau:

   

   ZappySys API Driver - Cosmos DB

   Connect to your Azure Cosmos DB databases to read, query, create, update, and delete documents and more!

   CosmosDbDSN

   #DirectSQL SELECT * FROM root where root.id !=null order by root._ts desc

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Cosmos DB API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Cosmos DB servers).

10. Click OK to finish creating the data source.

Read data in SQL Server using ZappySys Data Gateway

To read the data in SQL Server, the first thing you have to do is create a Linked Server:

1. First, let's open SQL Server Management Studio, create a new Linked Server, and start configuring it:

   LS_TO_COSMOS_DB_IN_GATEWAY

   Microsoft OLE DB Driver for SQL Server

   localhost,5000

   CosmosDbDSN

   CosmosDbDSN

   
   Choose SQL Server Native Client 11.0 as Provider if you don't see the option shown above.

2. Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:

   

3. Optional step. Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).

   

   You need to enable RPC Out if you plan to use EXEC(...) AT [LS_TO_COSMOS_DB_IN_GATEWAY] rather than OPENQUERY.
   If don't enabled it, you will encounter the Server 'LS_TO_COSMOS_DB_IN_GATEWAY' is not configured for RPC error.

   Query Example:

   EXEC('#DirectSQL SELECT * FROM root where root.id !=null order by root._ts desc') AT [LS_TO_COSMOS_DB_IN_GATEWAY]

   ---

   If you plan to use 'INSERT INTO <TABLE> EXEC(...) AT [LS_TO_COSMOS_DB_IN_GATEWAY]' in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
   If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction. error.

   Query Example:

   INSERT INTO dbo.Products
   EXEC('#DirectSQL SELECT * FROM root where root.id !=null order by root._ts desc') AT [LS_TO_COSMOS_DB_IN_GATEWAY]
   

4. Finally, open a new query and execute a query we saved in one of the previous steps:
   

   SELECT * FROM OPENQUERY([LS_TO_COSMOS_DB_IN_GATEWAY], '#DirectSQL SELECT * FROM root where root.id !=null order by root._ts desc')

   

   SELECT * FROM OPENQUERY([LS_TO_COSMOS_DB_IN_GATEWAY], '#DirectSQL SELECT * FROM root where root.id !=null order by root._ts desc')

Create Linked Server using Code

In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'CosmosDbDSN'

USE [master]
GO
--///////////////////////////////////////////////////////////////////////////////////////
--Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server
--///////////////////////////////////////////////////////////////////////////////////////

-- Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
-- Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
-- Replace Port 5000 if you configured gateway on a different port


--1. Configure your gateway service as per this article https://zappysys.com/links?id=10036

--2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express

--Uncomment below if you like to drop linked server if it already exists
--EXEC master.dbo.sp_dropserver @server=N'LS_TO_COSMOS_DB_IN_GATEWAY', @droplogins='droplogins'

--3. Create new linked server

EXEC master.dbo.sp_addlinkedserver
    @server = N'LS_TO_COSMOS_DB_IN_GATEWAY'  --Linked server name (this will be used in OPENQUERY sql
, @srvproduct=N''
---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)---
, @provider=N'SQLNCLI11'
---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)---
--, @provider=N'MSOLEDBSQL'
, @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
, @provstr=N'Network Library=DBMSSOCN;'
, @catalog=N'CosmosDbDSN' --Data source name you gave on Gateway service settings

--4. Attach gateway login with linked server

EXEC master.dbo.sp_addlinkedsrvlogin
@rmtsrvname=N'LS_TO_COSMOS_DB_IN_GATEWAY'  --linked server name
, @useself=N'False'
, @locallogin=NULL
, @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
, @rmtpassword='YOUR_GATEWAY_PASSWORD'  --enter your Gateway user's password
GO

--5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
EXEC sp_serveroption 'LS_TO_COSMOS_DB_IN_GATEWAY', 'rpc', true;
EXEC sp_serveroption 'LS_TO_COSMOS_DB_IN_GATEWAY', 'rpc out', true;

--Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
EXEC sp_serveroption 'LS_TO_COSMOS_DB_IN_GATEWAY', 'remote proc transaction promotion', false;

--Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
--EXEC sp_serveroption 'LS_TO_COSMOS_DB_IN_GATEWAY', 'query timeout', 1200;
GO

Create View in SQL Server

Finally, use this or similar query in a view or stored procedure, which you will be able to use in Tableau. We will create a view to return invoices:

1. CREATE VIEW vwApiInvoices AS
    SELECT * FROM OPENQUERY([LS_TO_COSMOS_DB_IN_GATEWAY], 'SELECT * FROM Invoices')

Read data in Tableau from SQL Server

Actually, we will be getting data from SQL Server which in turn will be getting data from ZappySys Data Gateway data source. Let's begin and see how to accomplish that:

1. Open Tableau Desktop and click File > New
2. To create new Connection click More > Microsoft SQL Server > Enter your credentials to connect to SQL Server (in our example before we used tdsuser):
3. Once connection is created for SQL Server we can read Cosmos DB data 3 different ways:
   1. Query View which contains OPENQUERY to Linked Server for Cosmos DB data
   2. Use direct SQL Query using OPENQUERY
   3. Use Stored Procedure (Mostly useful to parameterize calls
4. See below example to pull data from Cosmos DB in Tableau using SQL View approach:
5. Once your data sources are created you can click on Sheet1 and drag fields to create visualizations for Tableau Dashboard:

Passing Parameters to Cosmos DB calls in Tableau (Dynamic SQL)

Now let's look at scenario where you have to pass parameters to build Dynamic Dashboard. You can try to insert Parameters in your Direct SQL when you build Dynamic SQL but we found some issues with that so we are going to suggest Stored Procedure approach. For more information on Known issue on Dynamic Metadata Check this post.

1. First lets create a stored procedure in SQL Server for Parameter Example. Notice how we added WITH RESULT SETS in the code to describe metadata.

   --DROP PROC dbo.usp_GetInvoicesByCountry
   --GO
   /*
   Purpose: Parameterize Cosmos DB call via SQL. Call ZappySys Drivers inside SQL Server.
   */
   CREATE PROC dbo.usp_GetInvoicesByCountry
   	@country varchar(100) 
   AS 
   
   DECLARE @sql varchar(max)
   --//Escape single ticks carefully
   SET @sql =  'SELECT OrderID,CustomerID,Country,Quantity FROM $
   WITH (Src=''https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json@filter=Country eq '+ @country +'''
   	 ,Filter=''$.value[*]''
   	 ,DataFormat=''OData''
   )'
   
   DECLARE @sqlFull varchar(max)
   SET @sqlFull='SELECT * FROM OPENQUERY([LS_TO_COSMOS_DB_IN_GATEWAY], ''' + REPLACE( @sql, '''', '''''' ) + ''' )'
   PRINT @sqlFull --//For DEBUG purpose
   
   EXECUTE (@sqlFull) 
   WITH RESULT SETS ( 
    (OrderID int,CustomerID varchar(100),Country varchar(100),Quantity int) --//describe first result. If you don't do this then wont work in Tableau 
   )
   GO
   -- Example call
   EXEC dbo.usp_GetInvoicesByCountry @country='Germany'

2. Once you create a stored procedure go to Tableau datasource and select Database which contains the stored procedure we just created.
3. Now find your stored proc and drag it on the datasource pane. You will see parameters UI as below. You can create new parameter - Select New Parameter under Value Column.
4. Thats it now you can reuse your parameterized datasource anywhere in Dashboard.
5. If you have need to select Parameters from predefined values rather than free text then edit your parameter and select List option. Define values you like to select from as below.
6. When you create Tableau Dashboard you will see Parameter dropdown (If you selected List) elase you may see Textbox to enter custom value.

Firewall settings

So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.

Method-1 (Preferred)

If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.

1. Search for gateway in start menu and open ZappySys Data Gateway.
2. Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it).

Method-2 Here is another way to add / edit Inbound Traffic rule in windows firewall. Use below method if you choose to customize your rule (for advanced users).

1. Search for Windows Firewall Advanced Security in start menu.
2. Under Inbound Rules > Right click and click [New Rule] >> Click Next
3. Select Port on Rule Type >> Click Next
4. Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
5. Select Profile (i.e. Private, Public) >> Click Next
6. Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
7. Click OK to save the rule

Actions supported by Cosmos DB Connector

Learn how to perform common Cosmos DB actions directly in Tableau with these how-to guides:

• Create a document in the container
• Create Permission Token for a User (One Table)
• Create User for Database
• Delete a Document by Id
• Get All Documents for a Table
• Get All Users for a Database
• Get Database Information by Id or Name
• Get Document by Id
• Get List of Databases
• Get List of Tables
• Get table information by Id or Name
• Get table partition key ranges
• Get User by Id or Name
• Query documents using Cosmos DB SQL query language
• Update Document in the Container
• Upsert a document in the container
• Generic Request
• Generic Request (Bulk Write)

Conclusion

In this article we showed you how to connect to Cosmos DB in Tableau and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Cosmos DB, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).

We encourage you to download Cosmos DB Connector for Tableau and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Cosmos DB Connector for Tableau Documentation

More integrations

Other connectors for Tableau

Other application integration scenarios for Cosmos DB

Common Searches: