エンタープライズサーチのNeuron にVercel のデータを取り込んで検索利用

杉本和也
杉本和也
リードエンジニア
企業内検索エンジンサービスの Neuron にVercel のデータを取り込んで検索する方法:CData JDBC Driver。



ブレインズテクノロジー社のNeuron は、先端OSS 技術(Apache Solr)を活用したエンタープライズサーチ(企業内検索エンジン)サービスです。Apache Solr は、エンタープライズサーチ機能をAPI として提供してくれますが、Neuron はApache Solr に企業ユーザーがデータを探索するためのシンプルかつ使いやすいユーザーインターフェースと管理画面・運用機能を提供してくれます。これによりエンドユーザーが簡単にエンタープライズサーチを利用することができます。管理画面では、ファイルやデータのクローリング設定がUI で行えるようになっています。この記事では、Neuron に備わっているJDBC インターフェース経由で、CData JDBC Driver for API を利用することでNeuron にVercel のデータを取り込んで検索で利用できるようにします。

Neuron にCData JDBC Driver for API データをロード

CData JDBC Driver for API のインストールと.jar ファイルの配置

  • CData JDBC Driver for API をNeuron と同じマシンにインストールします。
  • 以下のパスにJDBC Driver がインストールされます。
    C:\Program Files\CData\CData JDBC Driver for API 20xxJ\lib\cdata.jdbc.api.jar
  • このcdata.jdbc.api.jar とcdata.jdbc.api.lic ファイルをコピーして、Neuron のC:\APP cf\lib フォルダに配置します。

Neuron CF でのVercel のデータを扱うリポジトリの作成

  • Neuron CF でクローラーの設定をGUI で行います。JDBC を読み取るためのリポジトリを作成します。Neuron の管理画面にログインし、[リポジトリ]→[リポジトリコレクション一覧]→[新規]をクリックします。
  • 任意のリポジトリ名を入力します。タイプは[JDBC]を選択します。
  • 次に、ドライバーのクラス名とJDBC 接続文字列でVercel への接続を行います。

    API キー認証の設定

    Vercel は Bearer トークン認証を使用します。API キーとして、パーソナルアクセストークンまたは OAuth アクセストークンのいずれかを使用できます。

    パーソナルアクセストークンを取得するには、以下のステップで進めます:

    1. https://vercel.com/ で Vercel アカウントにログインします
    2. Account Settings > Tokens に移動します。
    3. Create Token をクリックし、名前と有効期限を入力して Create をクリックします。
    4. 生成されたトークンをコピーします(一度しか表示されません)。

    トークンを取得したら、以下の接続プロパティを設定します:

    • AuthScheme:APIKey に設定します。
    • APIKey:Vercel のパーソナルアクセストークンまたは OAuth アクセストークンに設定します。

    接続文字列の例

    Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
    

    チームの利用

    Vercel のリソースの多くは、チームにスコープされています。すべてのリクエストを特定のチームにスコープするには、TeamId 接続プロパティにチームの ID を設定します。チーム ID は、Teams テーブルをクエリするか、Vercel ダッシュボードで確認できます。あるいは、サポートされている場合は SQL クエリの WHERE 句で TeamId を指定することもできます。

    Vercel への接続

    認証を設定すると、Vercel に接続して、Projects、Deployments、Teams、Domains などの利用可能なテーブルからデータをクエリできます。


    ドライバクラス名:cdata.jdbc.api.APIDriver
    接続文字列:jdbc:api:Profile=C:\profiles\Vercel.apip;AuthScheme=APIKey;APIKey=your_access_token;
  • [更新]をクリックして、Vercel に接続するリポジトリコレクションができました。

Neuron でVercel のデータをクローリングするジョブを作成

続いて、Vercel のどのデータをどのようにクローリングするのかをジョブで定義していきます。

  • 管理画面で[ジョブ]→[ジョブ一覧]→[新規]とクリックします。
  • 任意のジョブ名を入力します。出力先にはSolr を選択します。リポジトリは先ほど作成したVercel に接続するリポジトリコレクションを選びます。
  • 次に基本タブからジョブ実行を手動にするか、定期実行するかを自由に設定します。
  • SQL タブでは、どんなデータを取得するのか、テーブル名やカラム、フィルタリング条件などを設定できます。CData JDBC ドライバがVercel のデータをテーブルにモデル化しているので、標準SQL でVercel をクエリすることができます。
    • SQL文:SELECT , FROM User
    • キーカラム:Id など取得テーブルのキーとなるカラム
    • 検索対象カラム:検索の対象とするカラム
    • タイトルカラム:検索結果のタイトルとするカラム
    • タイムスタンプカラム:タイムスタンプとなるカラムがあれば、ここで指定します
  • リクエストパラメータでは、検索結果レコードのURL (があれば)を設定することもできます。URL を表示できると表示された検索結果からレコードに簡単に移動できます。
  • 取得元では、ラベルを設定しておきます。[更新]をクリックして、クローラージョブの設定を完了します。

Neuron でVercel のデータをクロールするジョブを実行

実際にNeuron で作成したジョブを実行します。[ジョブ]→[状態とジョブ管理]をクリックし、作成したジョブの[Start]をクリックします。

ジョブが正常完了すると、[Done]がステータスとして表示されます。

Neuron 上でのVercel のデータの検索の実施

実際にNeuron 上で検索ができるか確認してみます。取得元を絞り込むこと、内容やファイル名での検索、ファイルサイズやファイル更新日の絞り込み、部分一致や全部一致で検索が可能です。 検索をかけてみると、以下のようにデータを取得できました。

CData JDBC Driver for API をNeuron で使うことで、Vercel コネクタとして機能し、簡単にデータを取得して同期することができました。ぜひ、30日の無償評価版をお試しください。

はじめる準備はできましたか?

API Driver で Vercel のライブデータに接続

Vercel に接続