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

CData ODBC Driver for Confluence を使って、PHP アプリケーションからConfluence にデータ連携。PHP でのODBC ネイティブサポートを活用します。

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

最終更新日:2023-09-26
confluence ロゴ

CData

odbc ロゴ画像
PHP ロゴ

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

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

CData ODBC Drivers とは?

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

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

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

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

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

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

  1. まずODBC DSN に必要な接続プロパティの値を入力します。インストールが終わると、自動的にODBC DSN 設定画面が起動します。ODBC データソースアドミニストレータを使用してDSN を作成および設定する方法については、ヘルプドキュメントの「はじめに」の章を参照してください。

    API Token を取得する方法

    API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

    Confluence Cloud Account への接続

    Cloud アカウントへの接続には、以下のプロパティを設定します(Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。):

    • User: Confluence サーバーに認証するユーザー名。
    • APIToken: 認証するユーザーに紐付けられたAPI Token。
    • Url: JIRA エンドポイントのURL。例: https://yoursitename.atlassian.net

    Confluence Server Instance への接続

    Server instance への接続には以下を設定します:

    • User: Confluence Instance に接続するユーザー名。
    • Password: Confluence Instance に接続するユーザーのパスワード。
    • Url: JIRA エンドポイントの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 Driver をご利用ください

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

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

関連コンテンツ

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

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