Connect to Mocean Data from PowerBuilder via JDBC

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

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

Connect to Mocean Data from PowerBuilder

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

     Using API Key Authentication

     Mocean uses API key authentication to control access to the API. To obtain an API Key:

     1. Log in to your Mocean account at https://dashboard.moceanapi.com
     2. Navigate to your account settings or API credentials section
     3. Copy your API Key

     After obtaining your API Key, set the following connection properties:

     • AuthScheme: Set this to APIKey.
     Set the following in the ProfileSettings connection property:
     • APIKey: Set this to your Mocean API Key. This is transmitted as a Bearer token in the Authorization header.

     Example Connection String

     Profile=C:\profiles\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
     

     Connecting to Mocean

     Once the authentication is configured, you can connect to Mocean and query data from any of the available tables such as AccountBalance, AccountPricing, MessageStatus, and NumberLookup.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Mocean 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\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

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

Using Mocean 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 Mocean 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\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';";
CONNECT USING SQLCA;
dw_accountbalance.SetTransObject(SQLCA);
dw_accountbalance.Retrieve();