Automate Nuclia Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access Nuclia data from PowerShell? This article demonstrates how to utilize the Nuclia Cmdlets for tasks like connecting to Nuclia data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to Nuclia.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for Nuclia; this tutorial shows how to use the Provider to retrieve Nuclia data.

Once you have acquired the necessary connection properties, accessing Nuclia data in PowerShell can be enabled in three steps.

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.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
        
  2. Connect to Nuclia:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT ,  from KnowledgeBox"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_. $_.
    }
      

Ready to get started?

Connect to live data from Nuclia with the API Driver

Connect to Nuclia