Connect to Placid Data from PowerBuilder via JDBC

The CData JDBC driver for Placid 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 Placid in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Placid to retrieve data.

Connect to Placid Data from PowerBuilder

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

     Placid uses API Key authentication to control access to the API. API tokens are project-specific and can be obtained from your project settings on placid.app.

     Using API Key Authentication

     To obtain your API key, log in to placid.app, navigate to your project, open the project settings, and generate an API token from the API section. Note that each API token is scoped to a specific project.

     After setting the following connection properties, you are ready to connect:

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Placid project API token.

     Example connection string:

     Profile=C:\profiles\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';
     

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.api.jar
     

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

     jdbc:api:Profile=C:\profiles\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';

   
5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

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

SQLCA.DBMS = "JDBC"
SQLCA.AutoCommit = False
SQLCA.DBParm = "Driver='cdata.jdbc.api.APIDriver',URL='jdbc:api:Profile=C:\profiles\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';";
CONNECT USING SQLCA;
dw_collections.SetTransObject(SQLCA);
dw_collections.Retrieve();