Manage Nuclia Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Nuclia seamlessly integrates Nuclia data into database management tools like DBArtisan by enabling you to access Nuclia data as a database. This article shows how to create a JDBC source for Nuclia in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Nuclia Data into DBArtisan Projects

Follow the steps below to register Nuclia data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in 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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Nuclia data. Nuclia entities are displayed in the Datasource Explorer.

You can now work with Nuclia data as you work with any other database. See the driver help documentation for more information on the queries supported by the Nuclia API.