How to Build an ETL App for Nuclia Data in Python with CData

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData API Driver for Python and the petl framework, you can build Nuclia-connected applications and pipelines for extracting, transforming, and loading Nuclia data. This article shows how to connect to Nuclia with the CData Python Connector and use petl and pandas to extract, transform, and load Nuclia data.

With built-in, optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Nuclia data in Python. When you issue complex SQL queries from 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).

Connecting to Nuclia Data

Connecting to Nuclia data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

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.

After installing the CData Nuclia Connector, follow the procedure below to install the other required modules and start accessing Nuclia through Python objects.

Install Required Modules

Use the pip utility to install the required modules and frameworks:

pip install petl
pip install pandas

Build an ETL App for Nuclia Data in Python

Once the required modules and frameworks are installed, we are ready to build our ETL app. Code snippets follow, but the full source code is available at the end of the article.

First, be sure to import the modules (including the CData Connector) with the following:

import petl as etl
import pandas as pd
import cdata.api as mod

You can now connect with a connection string. Use the connect function for the CData Nuclia Connector to create a connection for working with Nuclia data.

cnxn = mod.connect("Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;")

Create a SQL Statement to Query Nuclia

Use SQL to create a statement for querying Nuclia. In this article, we read data from the KnowledgeBox entity.

sql = "SELECT ,  FROM KnowledgeBox WHERE  = ''"

Extract, Transform, and Load the Nuclia Data

With the query results stored in a DataFrame, we can use petl to extract, transform, and load the Nuclia data. In this example, we extract Nuclia data, sort the data by the column, and load the data into a CSV file.

Loading Nuclia Data into a CSV File

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

etl.tocsv(table2,'knowledgebox_data.csv')

With the CData API Driver for Python, you can work with Nuclia data just like you would with any database, including direct access to data in ETL packages like petl.

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to Nuclia data. Reach out to our Support Team if you have any questions.

Full Source Code

import petl as etl
import pandas as pd
import cdata.api as mod

cnxn = mod.connect("Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;")

sql = "SELECT ,  FROM KnowledgeBox WHERE  = ''"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'')

etl.tocsv(table2,'knowledgebox_data.csv')