Manage Cosmos DB Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Cosmos DB seamlessly integrates Cosmos DB data into database management tools like DBArtisan by enabling you to access Cosmos DB data as a database. This article shows how to create a JDBC source for Cosmos DB in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Cosmos DB Data into DBArtisan Projects

Follow the steps below to register Cosmos DB data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in 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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Cosmos DB data. Cosmos DB entities are displayed in the Datasource Explorer.

You can now work with Cosmos DB data as you work with any other database. See the driver help documentation for more information on the queries supported by the Cosmos DB API.