Connect to Cosmos DB Data in DBVisualizer

The CData JDBC Driver for Cosmos DB implements JDBC standards to provide connectivity to Cosmos DB data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Cosmos DB data in DBVisualizer and use the table editor to edit and save Cosmos DB data.

Create a New JDBC Data Source for Cosmos DB Data

Follow the steps below to use the Driver Manager to provide connectivity to Cosmos DB data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
2. Enter a name for the data source.
3. Enter the following in the URL Format box: jdbc:cosmosdb:
   The DBVisualizer Driver Manager.
4. In the User Specified tab, click the Open File button and select the cdata.jdbc.cosmosdb.jar file, located in the lib subfolder of the installation directory.
5. In the Driver Class menu, select the CosmosDBDriver class, cdata.jdbc.cosmosdb.CosmosDBDriver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.

2. In the Connection section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:cosmosdb: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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 connection string is below:

     jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;
   • Database UserId: The username to use to authenticate to Cosmos DB.
   • Database Password: The password to use to authenticate to Cosmos DB.

3. On the Connection tab, click Connect.

To browse through tables exposed by the Cosmos DB JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.