Connect to Cosmos DB Data from PowerBuilder

The CData JDBC driver for Cosmos DB is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for Cosmos DB in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Cosmos DB to perform reads and writes.

Connect to Cosmos DB Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for Cosmos DB. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

   Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

2. Click Tools -> Database Painter.
3. Right-click the JDBC node and click New Profile.
4. In the Database Profile Setup dialog, enter the following:
   • Profile Name: Enter a user-friendly name for the profile.
   • Driver Name: Enter the class name of the driver, cdata.jdbc.cosmosdb.CosmosDBDriver
   • URL: Enter 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 below:

     jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;
5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Cosmos DB Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve Cosmos DB data into a DataWindow. You can add the following code to the open method: