LINQ to Nuclia Data

This article illustrates using LINQ to access tables within the Nuclia via the CData ADO.NET Data Provider for Nuclia. To achieve this, we will use LINQ to Entity Framework, which facilitates the generation of connections and can be seamlessly employed with any CData ADO.NET Data Providers to access data through LINQ.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

1. In a new project in Visual Studio, right-click on the project and choose to add a new item. Add an ADO.NET Entity Data Model.
2. Choose EF Designer from Database and click Next.
3. Add a new Data Connection, and change your data source type to "CData Nuclia Data Source".

4. Enter your data source connection information.

   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.

   Below is a typical connection string:

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


5. If saving your entity connection to App.Config, set an entity name. In this example we are setting APIEntities as our entity connection in App.Config.
6. Enter a model name and select any tables or views you would like to include in the model.

Using the entity you created, you can now perform select commands. For example:

APIEntities context = new APIEntities();

var knowledgeboxQuery = from knowledgebox in context.KnowledgeBox
  select knowledgebox;

foreach (var result in knowledgeboxQuery) {
  Console.WriteLine("{0} {1} ", result.Id, result.);
}

See "LINQ and Entity Framework" chapter in the help documentation for example queries of the supported LINQ.