How to Query Nuclia Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Nuclia to query Nuclia data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Nuclia data in MySQL Workbench.

Connect to Nuclia Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Nuclia data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Nuclia from MySQL Workbench

The steps below outline connecting to the virtual Nuclia database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Nuclia data.

Connect to Nuclia through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Nuclia).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Nuclia Data

1. Open the connection you just created (CData SQL Gateway for Nuclia).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Nuclia data, like SELECT * FROM `CData API Sys`.KnowledgeBox;

With access to live Nuclia data from MySQL Workbench, you can easily work with Nuclia, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.