Validate Nuclia Data with QuerySurge

QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData API Driver for JDBC, QuerySurge can work with live Nuclia data. This article explains how to connect to Nuclia data from QuerySurge.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Nuclia data. When you issue complex SQL queries to Nuclia, the driver pushes supported SQL operations, like filters and aggregations, directly to Nuclia and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Nuclia data using native data types.

Connecting to Nuclia Data in QuerySurge

To connect to live Nuclia data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.

Deploy the JDBC Driver

1. Download the CData API Driver for JDBC installer, unzip the package, and run the JAR file to install the driver.
2. Once the driver is installed, stop the Agent Service.
3. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData API Driver for JDBC\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
4. Restart the Agent Service.

For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.

Configure a New Connection to Nuclia

1. Log into QuerySurge and navigate to the Admin view.
2. Click Configuration -> Connections in the Administration Tree.
3. Click Add to create a new connection.
4. In the QuerySurge Connection Wizard, click Next.
5. Name the connection (e.g. CData JDBC Connection to Nuclia).
6. Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
7. Set the Driver Class to cdata.jdbc.api.APIDriver and click Next.

8. Set the Connection URL using the necessary connection properties to authenticate with Nuclia. Your Connection URL will look something like the following:

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

   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.

   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.

   
9. Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM KnowledgeBox LIMIT 1) and click Next.
10. Click Test Connection to ensure the connection is configured properly and click Save to add the connection.

Once the connection is added, you can write SQL queries against your Nuclia data in QuerySurge.

Compare Nuclia Data Queries with a QueryPair

With the connection configured, you can follow the steps below to compare querying Nuclia data with a QueryPair.

1. Select "Design Library" from the Design Menu
2. Click QueryPairs under QuerySurge Design
3. Click "Create New QueryPair"
4. Name the QueryPair and click Save
5. In either the Source or Target panes, select the connection created above (select the same connection to query Nuclia twice or another connection to perform a comparison)
6. Write queries in the Editor for each pane, e.g. SELECT * FROM KnowledgeBox
7. Click the "Design-Time Run" tab to execute the queries
8. When the query execution is finished, click "View Query Results" to see the Nuclia data returned by the query

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Nuclia data in QuerySurge. Reach out to our Support Team if you have any questions.