Connect to Cosmos DB Data in NetBeans

The CData JDBC Driver for Cosmos DB integrates connectivity to live Cosmos DB data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Cosmos DB data in NetBeans. You will create a connection and edit and save Cosmos DB data in the Table Editor.

Create a JDBC Data Source for Cosmos DB in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

• Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.cosmosdb.jar file. The driver JAR is located in the lib subfolder of the installation directory.
• Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.cosmosdb.CosmosDBDriver from the menu.
• Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

1. In the Service window, right-click the Database node and click New Connection.

2. In the New Connection Wizard, enter the following connection properties:

   • Driver Name: In the menu, select the CData JDBC Driver for Cosmos DB.
   • User Name: Enter the username. This can also be defined in the JDBC URL.
   • Password: Enter the password. This can also be defined in the JDBC URL.

   • JDBC URL: Specify 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.

     A typical JDBC URL is the following:

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

Query Cosmos DB Data

To connect to Cosmos DB data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data. You can also insert, update, or delete records in the Data Views window.