Connect to JSON Services from PowerBuilder

The CData JDBC Driver for JSON 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 JSON in PowerBuilder.

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

Connect to JSON Services from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for JSON. 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.json.JSONDriver
   • URL: Enter the JDBC URL.

     See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

     After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

     The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

     • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
     • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
     • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

     See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the JSON JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.json.jar

     Fill in the connection properties and copy the connection string to the clipboard. A typical JDBC URL is below:

     jdbc:json:URI=C:/people.json;DataModel=Relational;
5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using JSON Services 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 JSON services into a DataWindow. You can add the following code to the open method: