Connect to Nuclia Data in DBArtisan
The CData ODBC 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 an data source for Nuclia in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate Nuclia Data into DBArtisan Projects
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.
Using API Key Authentication
Nuclia uses API key authentication for accessing Knowledge Box data. To obtain an API key:
- Log in to the Nuclia Cloud Dashboard at https://nuclia.cloud
- Navigate to your Knowledge Box settings
- Go to the Service Accounts section
- 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.
You can then follow the steps below to register Nuclia data as a database instance in your project:
- In DBArtisan, click Data Source -> Register Datasource.
- Select Generic ODBC.
- Enter a name for the data source and select the DSN.
- 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.
