Connect to Carbone Data from PowerBuilder via ODBC

The CData ODBC Driver for Carbone can be used from any platform or development technology that supports ODBC, including PowerBuilder. This article shows how to connect to Carbone data and execute queries from the Database Painter and controls such as the DataWindow.

Connect to Carbone as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Start by setting the Profile connection property to the location of the Carbone Profile on disk (e.g. C:\profiles\Carbone.apip). Next, set the ProfileSettings connection property to the connection string for Carbone (see below).

Carbone API Profile Settings

Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

1. Log in to your Carbone account at https://account.carbone.io
2. Copy the API key shown on the account home page

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Carbone API key (Bearer token).
• CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.

Create a Profile for the ODBC Driver for Carbone

Follow the steps below to use the Database Painter tool to create a database profile based on an ODBC DSN (data source name) for Carbone. In the Database Painter, you can use wizards and the UI to work with Carbone data.

1. In PowerBuilder, click Tools -> Database Painter.
2. In the Objects window in the Database Painter, right-click the ODBC node and click New Profile.
3. On the Connection tab, enter a name for the profile and select the Carbone DSN in the Data Source menu.
4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Carbone Data with PowerBuilder Controls

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

SQLCA.DBMS = "ODBC"
SQLCA.DBParm = "ConnectString='DSN=CData API Source'"
CONNECT USING SQLCA;
dw_templates.SetTransObject(SQLCA);
dw_templates.Retrieve();