Replicate Nuclia Data from PowerShell

The CData ODBC Driver for Nuclia enables out-of-the-box integration with Microsoft's built-in support for ODBC. The ODBC driver instantly integrates connectivity to the real Nuclia data with PowerShell.

You can use the .NET Framework Provider for ODBC built into PowerShell to quickly automate integration tasks like replicating Nuclia data to other databases. This article shows how to replicate Nuclia data to SQL Server in 5 lines of code.

You can also write PowerShell code to download Nuclia data. See the examples below.

Create an ODBC Data Source for Nuclia

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:

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.

Connect to Nuclia

The code below shows how to use the DSN to initialize the connection to Nuclia data in PowerShell:

$conn = New-Object System.Data.Odbc.OdbcConnection
$conn.ConnectionString = "DSN=CData API Source x64"

Back Up Nuclia Data to SQL Server

After you enable caching, you can use the code below to replicate data to SQL Server.

Set the following connection properties to configure the caching database:

• CacheProvider: The name of the ADO.NET provider. This can be found in the Machine.config for your version of .NET. For example, to configure SQL Server, enter System.Data.SqlClient.

• CacheConnection: The connection string of properties required to connect to the database. Below is an example for SQL Server:

  Server=localhost;Database=RSB;User Id=sqltest;Password=sqltest;

The SQL query in the example can be used to refresh the entire cached table, including its schema. Any already existing cache is deleted.

$conn.Open()
# Create and execute the SQL Query
$SQL = "CACHE DROP EXISTING SELECT * FROM " + $KnowledgeBox
$cmd = New-Object System.Data.Odbc.OdbcCommand($sql,$conn)
$count = $cmd.ExecuteNonQuery()
$conn.Close()

The driver gives you complete control over the caching functionality. See the help documentation for more caching commands and usage examples. See the help documentation for steps to replicate to other databases.

Other Operations

To retrieve Nuclia data in PowerShell, call the Fill method of the OdbcDataAdapter method. To execute data manipulation commands, initialize the OdbcCommand object and then call ExecuteNonQuery. Below are some more examples commands to Nuclia through the .NET Framework Provider for ODBC:

Retrieve Nuclia Data

$sql="SELECT ,  from KnowledgeBox"
 
$da= New-Object System.Data.Odbc.OdbcDataAdapter($sql, $conn)
$dt= New-Object System.Data.DataTable
$da.Fill($dt) 
 
$dt.Rows | foreach {
  $dt.Columns | foreach ($col in dt{
    Write-Host $1[$_]
  }
}