How to connect to Cosmos DB Data with Squirrel SQL client

The CData JDBC Driver for Cosmos DB enables you to execute queries to Cosmos DB data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Cosmos DB data and execute queries.

Add the JDBC Driver for Cosmos DB

Follow the steps below to add the driver JAR.

1. In Squirrel SQL, click Windows -> View Drivers.
2. Click the plus icon to open the Add Driver wizard.
3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Cosmos DB.
4. In the Example URL box, enter jdbc:cosmosdb:
5. In the Extra Class Path tab, click Add.
6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.cosmosdb.CosmosDBDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

1. Click Windows -> View Aliases.
2. In the pane that lists the aliases, click the plus icon.

3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

   • Name: Enter a name for the alias; for example, CData Cosmos DB Source.
   • Driver: Select the CData JDBC Driver for Cosmos DB.
   • URL: Enter jdbc:cosmosdb:
4. If you want to define any additional properties, click Properties.
5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
6. In the Specify column, select the checkboxes for the required 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.

   Below is a typical connection string:

   jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;
7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Cosmos DB Data

After the metadata has loaded, a new tab for the Cosmos DB data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example: