Cosmos DB Connectors

ZappySys Cosmos DB Connector provide read / write capability inside your app (see list below), using these drag and drop , high performance connectors you can perform many Cosmos DB operations without any coding. You can use this connector to integrate Cosmos DB data inside apps like SSIS, SQL Server or popular ETL Platforms / BI Tools/ Reporting Apps / Programming languages (i.e. Informatica, Power BI, SSRS, Excel, C#, JAVA, Python)

Download for SSIS Download for Other Apps Documentation

Video Tutorial - Cosmos DB - Connectors REST API Integration

Click on your App below to get started with Cosmos DB Integration

Choose your App / Scenario for which you like to integrate Cosmos DB
Cosmos DB Connector for SSIS
SSIS
Cosmos DB Connector for SQL Server
SQL Server
Cosmos DB Connector for Power BI
Power BI
Cosmos DB Connector for SSRS
SSRS
Cosmos DB Connector for Informatica
Informatica
Cosmos DB Connector for MS Access
MS Access
Cosmos DB Connector for MS Excel
MS Excel
Cosmos DB Connector for SSAS
SSAS
Cosmos DB Connector for C#
C#
Cosmos DB Connector for Python
Python
Cosmos DB Connector for JAVA
JAVA
Cosmos DB Connector for Tableau
Tableau
Cosmos DB Connector for SAP Crystal Reports
SAP Crystal Reports
Cosmos DB Connector for Azure Data Factory (ADF)
Azure Data Factory (ADF)
Cosmos DB Connector for ODBC
ODBC

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.
 Get List of Databases
Gets a list of the databases in the current database account.
 Get Database Information by Id or Name
Gets a database by its Id.
Parameter Description
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
 Get List of Tables
Gets a list of the tables in the database. (Tables are also called 'containers' or 'collections')
Parameter Description
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
 Get table information by Id or Name
Gets a table by its Id. (Tables are also called 'containers' or 'collections')
Parameter Description
Table Name (Case-Sensitive)
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
 Get table partition key ranges
Gets Partition Key Ranges for a table. This is useful for query if you want to minimize scan to specific partition (Tables are also called 'containers' or 'collections')
Parameter Description
Table Name (Case-Sensitive)
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
 Query documents using Cosmos DB SQL query language
Gets data based on the specified SQL query.
Parameter Description
Table Name (Case-Sensitive)
SQL Query Query for Cosmos DB
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
Allow Query Scan
Option Value
true true
false false
Allow Cross Partition Query
Option Value
true true
false false
Cross Partition Key Range Id
 Get All Documents for a Table
Gets all documents for a Table.
Parameter Description
Table Name (Case-Sensitive)
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
 Get Document by Id
Gets Document by Id.
Parameter Description
Document Id
Table Name (Case-Sensitive)
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
EnableCrossPartition
Option Value
true true
false false
Partition Key Value (default is supplied Id) The partition key value for the document. Must be included if and only if the collection is created with a partitionKey definition
Option Value
Default .
SingleKeyValue ["someValue1"]
MultiKeyValue ["some_value1","some_value2" ]
ConsistencyLevel This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). The override must be the same or weaker than the account’s configured consistency level.
Option Value
Strong Strong
Bounded Bounded
Session Session
Eventual Eventual
 Delete a Document by Id
Deletes a Document by Id.
Parameter Description
Document Id
Table Name (Case-Sensitive)
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
EnableCrossPartition
Option Value
true true
false false
Partition Key Value (default is supplied Id) The partition key value for the document. Must be included if and only if the collection is created with a partitionKey definition
Option Value
Default .
SingleKeyValue ["someValue1"]
MultiKeyValue ["some_value1","some_value2" ]
 Get All Users for a Database
Gets all users for a Database.
Parameter Description
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
 Get User by Id or Name
Gets database user information for a specific Id
Parameter Description
User Name (Case-Sensitive)
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
 Create User for Database
Create a new user which you can later use to create permission set and obtain resource token.
Parameter Description
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
RequestBody
 Create a document in the container
Insert JSON document in Cosmos DB Container.
 Upsert a document in the container
Insert JSON document in Cosmos DB Container.
Parameter Description
Upsert
 Update Document in the Container
Update full or part of the document in Cosmos DB Container.
 Create Permission Token for a User (One Table)
Create a new user which you can later use to create permission set and obtain resource token.
Parameter Description
Permission Name (e.g. read_orders)
Database Name (keep blank to use default) Case-Sensitive Leave blank to use default DB set on connection screen
User Name (Case-Sensitive)
PermissionMode
Option Value
All All
Read Read
Write Write
Delete Delete
Table (Add Permission for this)
ExpiresInSecond The validity period of the resource token returned by the operation. By default, a resource token is valid for one hour. To override the default, set this header with the desired validity period in seconds. The max override value is 18000, which is five hours.
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Check this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair