PHP からConfluence のデータに接続する方法

CData ODBC Driver for Confluence は、PHP アプリケーションからConfluence のデータへの連携を実現します。本記事では、Confluence のデータをPHP のビルトインODBC 機能でクエリする手順を説明します。

CData ODBC ドライバとは？

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

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

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

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

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

Confluence に接続するDSN を作成します。

1. まずODBC DSN に必要な接続プロパティの値を入力します。インストールが終わると、自動的にODBC DSN 設定画面が起動します。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 インスタンスへの認証を行うには、以下のように指定します。

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

Confluence への接続の確立

odbc_connect を呼び出して、Confluence への接続を開きます。 odbc_pconnect メソッドでも可能です。コネクションを閉じるには、odbc_close もしくはodbc_close_all を使います。

$conn = odbc_connect("CData Confluence Source","user","password");

コネクションはodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いたコネクションは、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトでコネクションを共有することが可能です:

$conn = odbc_pconnect("CData Confluence Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

エレメントの作成

odbc_prepare を使って、Prepared ステートメントおよびパラメータライズドクエリを作成します。

$query = odbc_prepare($conn, "SELECT * FROM Pages WHERE Id = ?");

クエリの実行

Prepared ステートメントをodbc_execute を使って実行します。

$conn = odbc_connect("CData Confluence Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Pages WHERE Id = ?");
$success = odbc_execute($query, array('10000'));
  

Non-Parameterized クエリは、odbc_exec を使います。

$conn = odbc_connect("CData Confluence Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Pages");
  

結果の処理

odbc_fetch_array ファンクションの結果セット配列としてアクセスします。

$conn = odbc_connect("CData Confluence Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Pages");
while($row = odbc_fetch_array($query)){
 echo $row["Key"] . "\n";
}

odbc_result_all ファンクションで、結果セットをHTML テーブルとして表示します。

$conn = odbc_connect("CData Confluence Sourcee","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Pages WHERE Id = ?");
$success = odbc_execute($query, array('10000'));
if($success)
  odbc_result_all($query);

サンプルクエリのテスト

スタンドアロンのテスト環境をたちあげる簡単な方法はPHP のビルトインテストサーバーを使うことです。やっていきましょう。

1. PHP の最新版のバイナリのダウンロード。

2. フォルダにファイルを入れる。

3. フォルダを開く。

4. php.ini-development をphp.ini に変更。

5. ブラウザからテストスクリプトにアクセスするためのコマンドを実行。

   php -S localhost:8000 -t C:\path-to-your-scripts -c C:\path-to-php\php.ini
   

他のサンプルクエリ

サポートされているSQL の詳細は、ヘルプドキュメントを参照してください。上記のサンプルは、PHP のコミュニティドキュメントを参考に、Confluence 向けに最適化したものです。

Confluence からPHP へのデータ連携には、ぜひCData ODBC ドライバをご利用ください

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。