Integrate Cosmos DB with External Services using SnapLogic

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including Cosmos DB, in their SnapLogic workflows.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Cosmos DB data. When platforms issue complex SQL queries to Cosmos DB, the driver pushes supported SQL operations, like filters and aggregations, directly to Cosmos DB and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with Cosmos DB data using native data types.

Connect to Cosmos DB in SnapLogic

To connect to Cosmos DB data in SnapLogic, download and install the CData Cosmos DB JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData JDBC Driver for Cosmos DB/lib by default).

Upload the Cosmos DB JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to Cosmos DB.

1. Navigate to the Designer tab
2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer
3. Click Add Account (or select an existing one) and click "Continue"
4. In the next form, configure the JDBC connection properties:
   • Under JDBC JARs, add the JAR file we previously uploaded
   • Set JDBC Driver Class to cdata.jdbc.cosmosdb.CosmosDBDriver

   • Set JDBC URL to a JDBC connection string for the Cosmos DB JDBC Driver, for example:

     jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;RTK=XXXXXX;

     NOTE: RTK is a trial or full key. Contact our Support team for more information.

     Built-In Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Cosmos DB JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.cosmosdb.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

     • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
     • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
5. After entering the connection properties, click "Validate" and "Apply"

Read Cosmos DB Data

In the form that opens after validating and applying the connection, configure your query.

• Set Schema name to "CosmosDB"
• Set Table name to a table for Cosmos DB using the schema name, for example: "CosmosDB"."Customers" (use the drop-down to see the full list of available tables)
• Add Output fields for each item you wish to work with from the table

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

Once you confirm the results are what you expect, you can add additional snaps to funnel your Cosmos DB data to another endpoint.

Piping Cosmos DB Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
2. Add an account to connect to Google Sheets
3. Configure the Worksheet Writer snap to write your Cosmos DB data to a Google Spreadsheet

You can now execute the fully configured pipeline to extract data from Cosmos DB and push it into a Google Spreadsheet.

Piping External Data to Cosmos DB

As mentioned above, you can also use the JDBC Driver for Cosmos DB in SnapLogic to write data to Cosmos DB. Start by adding a Generic JDBC - Insert or Generic JDBC - Update snap to the dashboard.

1. Select the existing "Account" (connection) or create a new one
2. Configure the query:
   • Set Schema name to "CosmosDB"
   • Set Table name to a table for Cosmos DB using the schema name, for example: "CosmosDB"."Customers" (use the drop-down to see the full list of available tables)
3. Save the Generic JDBC - Insert/Update snap

At this point, you have configured a snap to write data to Cosmos DB, inserting new records or updating existing ones.

More Information & Free Trial

Using the CData JDBC Driver for Cosmos DB you can create a pipeline in SnapLogic for integrating Cosmos DB data with external services. For more information about connecting to Cosmos DB, check at our CData JDBC Driver for Cosmos DB page. Download a free, 30 day trial of the CData JDBC Driver for Cosmos DB and get started today.