ODBC を介してNode.js からConfluence のデータをクエリ

node-odbc を使用して、Node.js からConfluence のデータへのSQL クエリを実行します。

古川えりか
コンテンツスペシャリスト

最終更新日:2022-01-09

この記事で実現できるConfluence 連携のシナリオ

こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。

Node.js はブラウザ上以外でJavaScript コードを使用できるJavaScript ランタイム環境です。CData ODBC Driver for Confluence を使用すれば、Node.js アプリとスクリプトから、リアルタイムConfluence のデータにアクセスできます。この記事ではnode-odbc のインストールと、リアルタイムConfluence のデータへのアクセスが可能な、シンプルなNode.js アプリケーションを作成するために必要なツールについて説明します。

ビルトインの最適化されたデータ処理により、CData ODBC Driver は比類のないパフォーマンスで、Node.js のリアルタイムConfluence のデータとやりとりできます。Node.js からConfluence に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をConfluence に直接プッシュし、組み込まれたSQL エンジンを利用してサポートされていない操作(主にSQL 関数とJOIN 操作)をクライアント側で処理します。

CData ODBC ドライバとは?

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

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

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

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

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

必要な接続プロパティの値が未入力の場合には、データソース名(DSN)で入力します。組み込みのMicrosoft ODBC Data Source Administrator を使用し、DSN を構成できます。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定する方法は、ヘルプドキュメントの「はじめに」を参照してください。

Confluence 接続プロパティの取得・設定方法

任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。

Confluence への認証

Confluence は、次の認証メソッドをサポートしています:API トークン、Basic 認証、OAuth 2.0、SSO。

API トークン - Confluence Cloud アカウント

トークンの取得

アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。

トークンを使用する認証

Cloud アカウントへの認証を行うには、以下を入力します。

  • AuthScheme:APIToken に設定。
  • User:Confluence サーバーに認証する際に使用されるユーザー。
  • APIToken:現在認証されているユーザーに紐づくAPI トークン。
  • Url:Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

Basic 認証 - Confluence Server インスタンス

Server インスタンスへの認証を行うには、以下のように指定します。

  • AuthSchemeBasic に設定。
  • User:Confluence インスタンスに認証する際に使用されるユーザー。
  • Password:Confluence サーバーに認証する際に使われるパスワード。
  • Url:Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
その他の認証方法と詳細については、ヘルプドキュメントの「はじめに」セクションを参照してください。

node-odbc を構築する

CData ODBC Driver を介してConfluence に接続するには、必要なツールをインストールした後に、node-odbc を手動で構築する必要があります。

必要なツールをインストールする

以下のコマンドでは、node-odbc の構築に必要なツールをインストールします。(ツールをグローバルにインストールする-g パラメータに注意してください。)

npm i -g windows-build-tools
npm i -g node-gyp

node-odbc を構築する

必要なツールをインストールしたらNode.js アプリケーションのディレクトリを作成し、Node.js スクリプトで使用するバイナリを構築するodbc をインストールします。

mkdir nodeodbc
cd nodeodbc
npm i -g node

Node.js からConfluence をクエリ

ODBC Driver がインストールされ、DSN が構成されて、node-odbc が構築されたら、Node.js アプリケーションからリアルタイムConfluence のデータをクエリすることができるようになります。以下のサンプルコードは、特定のDSN に接続してPages テーブルをクエリします。

myscript.js

const odbc = require('odbc');

async function queryConfluence() {
    const connection = await odbc.connect(`DSN=CData Confluence Source`);
    const data = await connection.query('SELECT Key, Name FROM Pages');
    console.log(data);
}

queryConfluence();

アプリケーションを作成したら、node を使用してスクリプトを実行します。

node myscript.js
Sample program results (Salesforce is shown.

おわりに

CData ODBC Driver for Confluence の30日の無償評価版 をダウンロードすればNode.js でリアルタイムConfluence のデータを使用できます。ご不明な点があれば、サポートチームにお問い合わせください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。