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

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

CData ODBC ドライバとは？

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

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

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

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

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

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

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

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

   それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

   ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

   Apache CouchDB への認証

   続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。

   • Basic：基本的なユーザー名 / パスワード認証
   • JWT：JWT 認証
   • None：パブリックなデータベースへの匿名アクセス

   Basic 認証

   データに接続するには、以下のプロパティを設定してください。

   • AuthScheme：Basic
   • User：認証に使用されるApache CouchDB ユーザーアカウント
   • Password：認証するユーザーに関連付けられたApache CouchDB パスワード

   その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。

CouchDB への接続の確立

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

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

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

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

エレメントの作成

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

$query = odbc_prepare($conn, "SELECT * FROM Movies WHERE MovieRating = ?");

クエリの実行

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

$conn = odbc_connect("CData ApacheCouchDB Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Movies WHERE MovieRating = ?");
$success = odbc_execute($query, array('R'));
  

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

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

結果の処理

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

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

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

$conn = odbc_connect("CData ApacheCouchDB Sourcee","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Movies WHERE MovieRating = ?");
$success = odbc_execute($query, array('R'));
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 のコミュニティドキュメントを参考に、CouchDB 向けに最適化したものです。

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

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

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