SSAS Cosmos DB Connector
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 SSAS. Follow the steps below to see how we would accomplish that. Driver mentioned in this article 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. |
See also
|
Create Data Source in ZappySys Data Gateway based on ZappySys API Driver
-
Download and install ZappySys ODBC PowerPack.
-
Search for gateway in start menu and Open ZappySys Data Gateway:
-
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:
-
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
-
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 to get 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:
CosmosDbDSNApiKey [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) Fill in the parameter... -
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.
Read data in SQL Server from the ZappySys Data Gateway
-
To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way:
-
Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
-
Optional: 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 [MY_LINKED_SERVER_NAME]
rather than OPENQUERY.
If don't enabled it, you will encounter theServer 'MY_LINKED_SERVER_NAME' is not configured for RPC
error.Query Example:
EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
If you plan to use
'INSERT INTO...EXEC(....) AT [MY_LINKED_SERVER_NAME]'
in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
If don't disabled it, you will encounter theThe 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('Select * from Products') AT [MY_LINKED_SERVER_NAME]
-
Finally, open a new query and execute a query we saved in one of the previous steps:
SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');
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_CosmosDbDSN', @droplogins='droplogins'
--3. Create new linked server
EXEC master.dbo.sp_addlinkedserver
@server = N'LS_CosmosDbDSN' --Linked server name (this will be used in OPENQUERY sql
, @srvproduct=N''
, @provider=N'SQLNCLI11'
, @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_CosmosDbDSN' --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_CosmosDbDSN', 'rpc', true;
EXEC sp_serveroption 'LS_CosmosDbDSN', 'rpc out', true;
--Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
EXEC sp_serveroption 'LS_CosmosDbDSN', '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_CosmosDbDSN', 'query timeout', 1200;
GO
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.
- Search for gateway in start menu and open ZappySys Data Gateway.
- 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).
- Search for Windows Firewall Advanced Security in start menu.
- Under Inbound Rules > Right click and click [New Rule] >> Click Next
- Select Port on Rule Type >> Click Next
- Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
- Select Profile (i.e. Private, Public) >> Click Next
- Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
- Click OK to save the rule
Create Custom Store 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 Store 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 Store Procedure and write the your desired store procedure and Save it and it will create the custom store 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 Store 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 store 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 store 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 store 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 store procedure and provide you the response.
Conclusion
In this article we discussed how to connect to Cosmos DB in SSAS and integrate data without any coding. Click here to Download Cosmos DB Connector for SSAS 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 SSAS
Documentation
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 |
|
Cosmos DB Connector Examples for SSAS 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
Other App Integration scenarios for Cosmos DB
Other Connectors for SSAS
Download Cosmos DB Connector for SSAS
Documentation
How to connect Cosmos DB in SSAS?
How to get Cosmos DB data in SSAS?
How to read Cosmos DB data in SSAS?
How to load Cosmos DB data in SSAS?
How to import Cosmos DB data in SSAS?
How to pull Cosmos DB data in SSAS?
How to push data to Cosmos DB in SSAS?
How to write data to Cosmos DB in SSAS?
How to POST data to Cosmos DB in SSAS?
Call Cosmos DB API in SSAS
Consume Cosmos DB API in SSAS
Cosmos DB SSAS Automate
Cosmos DB SSAS Integration
Integration Cosmos DB in SSAS
Consume real-time Cosmos DB data in SSAS
Consume realtime Cosmos DB API data in SSAS
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 SSAS
Load Cosmos DB in SSAS
Load Cosmos DB data in SSAS
Read Cosmos DB data in SSAS
Cosmos DB API Call in SSAS