How to create Nuclia federated tables in MySQL

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Nuclia data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Nuclia: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Nuclia data just as you would local MySQL tables.

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.

Create a FEDERATED Server and Tables for Nuclia Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the ODBC Driver for Nuclia. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedAPI
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData API Sys');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (KnowledgeBox). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_knowledgebox (
  ...,
    TYPE(LEN),
    TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedAPI/knowledgebox';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

Execute Queries

You can now execute queries to the Nuclia FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Nuclia. Refer to the following example:

SELECT 
  fed_knowledgebox., 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_knowledgebox 
ON 
  local_table.foreign_ = fed_knowledgebox.;