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

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

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

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

CData ODBC ドライバとは？

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

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

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

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

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

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

Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

API キー認証

ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

1. Backlog の個人設定ページを開きます。
2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
3. ApiKey にAPI キーを指定します。
4. URL はBacklog のテナントURL から取得できます。

OAuth 認証

node-odbc を構築する

CData ODBC Driver を介してBacklog に接続するには、必要なツールをインストールした後に、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 からBacklog をクエリ

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

myscript.js

const odbc = require('odbc');

async function queryBacklog() {
    const connection = await odbc.connect(`DSN=CData Backlog Source`);
    const data = await connection.query('SELECT Id, ProjectID FROM Issues');
    console.log(data);
}

queryBacklog();

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

node myscript.js

おわりに

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