Connect to Nuclia Data from PowerBuilder via JDBC

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

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

Connect to Nuclia Data from PowerBuilder

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

     Nuclia uses API key authentication for accessing Knowledge Box data. To obtain an API key:

     1. Log in to the Nuclia Cloud Dashboard at https://nuclia.cloud
     2. Navigate to your Knowledge Box settings
     3. Go to the Service Accounts section
     4. Create a new service account or copy an existing API key

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

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Nuclia service account API key.
     • KbId: Set this to your Knowledge Box UUID.
     • Zone: Set this to your Nuclia deployment zone (e.g., aws-us-east-2-1).

     Example Connection String

     Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;
     

     Connecting to Nuclia

     Once the authentication is configured, you can connect to Nuclia and query data from any of the available tables such as Resources, KnowledgeBox, LabelSets, and ProcessingStatus.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Nuclia 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\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;

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

Using Nuclia 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 Nuclia 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\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;";
CONNECT USING SQLCA;
dw_knowledgebox.SetTransObject(SQLCA);
dw_knowledgebox.Retrieve();