Connect to Cosmos DB Data in CloverDX (formerly CloverETL)

The CData JDBC Driver for Cosmos DB enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Cosmos DB as sources and destinations. In this article, you will use the JDBC Driver for Cosmos DB to set up a simple transfer into a flat file. The CData JDBC Driver for Cosmos DB enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Cosmos DB as sources and destinations. In this article, you will use the JDBC Driver for Cosmos DB to set up a simple transfer into a flat file.

Connect to Cosmos DB as a JDBC Data Source

1. Create the connection to Cosmos DB data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.cosmosdb.jar file.
3. Enter the JDBC URL.

   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.

   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.

   A typical JDBC URL is below:

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

Query Cosmos DB Data with the DBInputTable Component

1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
2. In the DB connection property, select the Cosmos DB JDBC data source from the drop-down menu.
3. Enter the SQL query. For example: SELECT City, CompanyName FROM Customers

Write the Output of the Query to a UniversalDataWriter

1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
3. Right-click the DBInputTable and then click Extract Metadata.
4. Connect the output port of the DBInputTable to the UniversalDataWriter.
5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Customers table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.