Connect to Cosmos DB Data in the Denodo Platform

Denodo Platform is a data virtualization product providing a single point of contact for enterprise database data. When paired with the CData JDBC Driver for Cosmos DB, Denodo users can work with live Cosmos DB data alongside other enterprise data sources. This article walks through creating a virtual data source for Cosmos DB in the Denodo Virtual DataPort Administrator.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Cosmos DB data. When you 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 allows you to work with and analyze Cosmos DB data using native data types.

Create the Cosmos DB Virtual Port

To connect to live Cosmos DB data from Denodo, you need to copy the JDBC Driver JAR file to the external library directory for Denodo and create a new JDBC Data Source from the Virtual DataPort Administrator tool.

1. Download the CData JDBC Driver for Cosmos DB installer, unzip the package, and run the JAR file to install the driver.
2. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for Cosmos DB\lib\) to the Denodo external library directory (C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-cosmosdb-19).
3. Open the Denodo Virtual DataPort Administrator tool and navigate to the Server Explorer tab.
4. Right-click "admin" and select New -> Data source -> JDBC.
5. Configure the JDBC Connection:
   • Name: your choice, e.g.: cosmosdb
   • Database adapter: Generic
   • Driver class path: C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-cosmosdb-19
   • Driver class: cdata.jdbc.cosmosdb.CosmosDBDriver

   • Database URI: Set this to a JDBC URL using the necessary connection properties. For example,

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

     Information on creating the Database URI follows:

     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.
6. Click the "Test connection" button to confirm the configuration and click Save.

View Cosmos DB Data in the VirtualPort Administrator Tool

After creating the data source, you can create a base view of Cosmos DB data for use in the Denodo Platform.

1. Click the "Create base view" button in the newly created VirtualPort (admin.CosmosDB).
2. Expand the object tree and select the objects (tables) you wish to import.
3. Click the "Create selected" button to create views of the Cosmos DB data.
   Optional: Click "Create associations from foreign keys" to define relationships between the objects.
4. With the view(s) created, navigate to a table (cdata_cosmosdb_customers) in the Server Explorer and double-click the selected table.
5. In the new tab, click "Execution panel" to open a query panel.
6. Customize the query in the "Execute" tab or use the default:

   SELECT * FROM cdata_cosmosdb_customers CONTEXT ('i18n'='us_est', 'cache_wait_for_load'='true')
   

7. Click Execute to view the data.

With the base view created, you can now work with live Cosmos DB data like you would any other data source in Denodo Platform, for example, querying Cosmos DB in the Denodo Data Catalog.

Download a free, 30-day trial of the CData JDBC Driver for Cosmos DB and start working with your live Cosmos DB data in Denodo Platform. Reach out to our Support Team if you have any questions.