Enable the Cosmos DB JDBC Driver in KNIME

One of the strengths of the CData JDBC Driver for Cosmos DB is its cross-platform support, enabling integration with major BI tools. Follow the procedure below to access Cosmos DB data in KNIME and to create a chart from Cosmos DB data using the report designer.

Define a New JDBC Connection to Cosmos DB Data

1. Install the Report Designer extension: Click File -> Install KNIME Extensions, and filter on "Report".
2. In a new workflow, click File -> Preferences and expand the KNIME -> Databases node to add cdata.jdbc.cosmosdb.jar. The driver JAR is located in the lib subfolder of the installation directory.
3. In the Node Repository view, expand the Database -> Read/Write node and drag a Database Reader onto the workflow editor.

4. Double-click the Database Reader and set the following properties:

   • Database Driver: In the menu, select the driver name, cdata.jdbc.cosmosdb.CosmosDBDriver

   • Database URL: Enter the connection properties. The JDBC URL begins with jdbc:cosmosdb: and is followed by a semicolon-separated list of connection properties.

     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.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     A typical JDBC URL is below.

     jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;
   • User Name: The username used to authenticate.
   • Password: The password used to authenticate.
   • SQL Statement: Enter an SQL query in the SQL Statement box or double-click a table. This article uses the query below to create a chart: SELECT City, CompanyName FROM Customers

5. Test the connection by clicking Fetch Metadata.

6. Connect the Database Reader to a Data to Report node to supply the dataset to a range of data visualization controls. Click Execute and then click Edit Report at the top of the workflow to open the report designer perspective.
7. You can now generate reports based on live data. To create a chart, drag the chart control from the palette to the report designer. In the resulting wizard, you can use the filtering and aggregation controls available in KNIME.

Troubleshooting

The following list shows how to resolve common errors:

• Encountered duplicate row Id "Row1": To resolve this error, add the following to the knime.ini file located in your KNIME installation directory:-Dknime.database.fetchsize=0