Active Query Builder を使用してNuclia 駆動型アプリを素早く開発

SQL インターフェースを介してNuclia を公開する標準.NET を記述します。Active Query Builder は、開発者がSQL インターフェースを作成するのに役立ちます。CData ODBC Driver for API は、Nuclia への標準ベースのアクセスを可能にします。この統合では、ODBC ドライバーとActive Query Builder オブジェクト間のブリッジとして、Microsoft ADO.NET Provider for ODBC を使用してビジュアルSQL コンポーザーを構築します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持った製品です。

1. Nuclia をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. 多様なアプリケーション、ツールにNuclia のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてNuclia の接続を設定、2.Active Query Builder 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとNuclia への接続設定

まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

未指定の場合は、初めに ODBC DSN（データソース名）で接続プロパティを指定します。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターを使用して、ODBC DSN を作成および設定できます。

API キー認証の設定

Nuclia は、Knowledge Box のデータにアクセスするために API キー認証を使用します。API キーを取得するには、以下のステップで進めます：

1. https://nuclia.cloud で Nuclia Cloud Dashboard にログインします
2. Knowledge Box の設定に移動します
3. Service Accounts セクションに移動します
4. 新しいサービスアカウントを作成するか、既存の API キーをコピーします

API キーを取得したら、以下の接続プロパティを設定します：

• AuthScheme：APIKey に設定します。
• APIKey：Nuclia サービスアカウントの API キーに設定します。
• KbId：Knowledge Box の UUID に設定します。
• Zone：Nuclia のデプロイゾーンに設定します（例：aws-us-east-2-1）。

接続文字列の例

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

Nuclia への接続

認証を設定すると、Nuclia に接続して、Resources、KnowledgeBox、LabelSets、ProcessingStatus などの利用可能なテーブルからデータをクエリできます。

SQL を使用してNuclia と対話

以下のステップに従ってWinForms ビジュアルクエリビルダーを作成します。

1. 新しいWindows Forms プロジェクトで、QueryBuilder を［Toolbox］からフォームにドラッグします。
2. ActiveQueryBuilder.ODBCMetadataProvider への参照を追加します。
3. OdbcConnection を追加し、最初のセクションで作成したDSN に接続文字列を設定します。

   OdbcConnection connection = new OdbcConnection();
   connection.ConnectionString = "DSN=API"
   

4. ODBCMetadataProvider インスタンスとGeneralSyntaxProvider インスタンスを初期化し、ODBCMetadataProvider オブジェクトのConnection プロパティをOdbcConnection に設定します。

   GenericSyntaxProvider syntaxProvider = new GenericSyntaxProvider();
   ODBCMetadataProvider metadataProvider = new ODBCMetadataProvider();
   metadataProvider.Connection = connection;
   

5. QueryBuilder オブジェクトの、対応するMetadataProvider プロパティとSyntaxProvider プロパティを設定します。

     queryBuilder1.MetadataProvider = metadataProvider;
     queryBuilder1.SyntaxProvider = syntaxProvider;
   

6. QueryBuilder クラスのInitiatelizeDatabaseSchemaTree メソッドを呼び出してNuclia メタデータを取得し、Nuclia テーブルのツリーデビューを生成します。

   queryBuilder1.InitializeDatabaseSchemaTree();

7. QueryBuilder を作成したら、それをTextBox に接続するか、使用する場合は、ActiveQueryBuilder SQLTextEditor に接続しますSQLTextEditor をデザイナにドラッグし、ドロップします。

8. 以下のコードをSQLTextEditor のValidating イベントに追加します。

   private void sqlTextEditor1_Validating(object sender, CancelEventArgs e) {
     try {
   
       // Update the query builder with manually edited query text:
       queryBuilder1.SQL = sqlTextEditor1.Text;
     }
     catch (SQLParsingException ex) {
       e.Cancel = true;
   
       // Set caret to error position
       sqlTextEditor1.SelectionStart = ex.ErrorPos.pos;
   
       // Report error
       MessageBox.Show(ex.Message, "Parsing error");
     }
   }
   

9. SQLUpdated イベントに以下を追加します。

   private void queryBuilder1_SQLUpdated(object sender, EventArgs e) {
     sqlTextEditor1.Text = queryBuilder1.FormattedSQL;
   }
   

10. これで、クエリをビジュアルに作成できます。［Columns Pane Area］のテーブルをダブルクリックすると、［entity/relationship］ダイアグラムが［Query Building Area］に表示されます。ダイアグラムで選択したカラムがクエリに追加されます。