Ready to get started?

Download a free trial of the Cosmos DB Driver to get started:

 Download Now

Learn more:

Cosmos DB Icon Cosmos DB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Cosmos DB document databases.

Connect to Cosmos DB Data in RazorSQL



Connect to Cosmos DB from wizards and query Cosmos DB data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for Cosmos DB enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Cosmos DB using wizards in RazorSQL.

Create a JDBC Data Source for Cosmos DB Data

  1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
  2. In the Connection Wizard that appears, set the following properties:
    • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
    • Driver Class: Set the driver class to cdata.jdbc.cosmosdb.CosmosDBDriver.
    • Username: Enter the username. (This property can also be set in the JDBC URL.)
    • Password: Enter the password. (This property can also be set in the JDBC URL.)
    • JDBC URL: Enter connection parameters. 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.

      A typical JDBC URL is the following:

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

Query Cosmos DB Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.