Linux/Unix 上でPHP からRabbitMQ のデータに接続・連携

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

CData ODBC ドライバを使って、Linux/Unix マシン上でRabbitMQ のデータに連携可能なPHP アプリケーションを作成。PHP でのODBC ネイティブサポートを活用します。

CData ODBC Driver for API をLAMP またはWAMP スタックにドロップし、RabbitMQ に接続されたWeb アプリケーションを構築します。本記事では、PHP のビルトインODBC 機能でRabbitMQ のデータに接続し、クエリを実行して、結果を出力する手順を説明します。

CData ODBC ドライバとは？

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

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

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

UNIX/Linux マシンでCData ODBC Drivers を使用する

CData ODBC Drivers は、Ubuntu、Debian、RHEL、CentOS、Fedora など、Red Hat およびDebian ベースのさまざまなシステムでサポートされています。また、いくつかライブラリやパッケージが要求されることがありますが、それらの多くはシステムにデフォルトでインストールされています。サポートされているLinux オペレーティングシステムのバージョンと必要なライブラリの詳細については、インストール済みのもの、またはWeb 上にあるヘルプドキュメントの「はじめに」の章を参照してください。

ドライバーマネージャーをインストールする

ドライバーをインストールする前に、システムにドライバーマネージャーがあることを確認してください。この記事では、広くサポートされている無料のオープンソースODBC ドライバーマネージャーであるunixODBC を使用します。

Ubuntu のようなDebian ベースのシステムでは、APT パッケージマネージャーを使用してunixODBC をインストールできます。

$ sudo apt-get install unixODBC unixODBC-dev

Red Hat Linux ベースのシステムの場合は、yum またはdnf を使用してunixODBC をインストールできます。

$ sudo yum install unixODBC unixODBC-devel

unixODBC ドライバーマネージャーは、ドライバーの情報をodbcinst.ini ファイルから、データソースの情報をodbc.ini ファイルから読み取ります。次のコマンドをターミナルに入力することで、システムの設定ファイルの場所を指定できます。

$ odbcinst -j

コマンドの出力は、登録されたODBC ドライバーおよびODBC データソースの設定ファイルの場所を表示します。ユーザーデータソースにアクセスできるのは、odbc.ini ファイルがホームフォルダに格納されているユーザーアカウントだけです。システムデータソースには、すべてのユーザーがアクセスできます。以下に、このコマンドの出力例を示します。

DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......:8
SQLLEN Size........:8
SQLSETPOSIROW Size.:8

ドライバーをインストールする

標準パッケージ形式（Debian .deb パッケージ形式または.rpm ファイル形式）でドライバーをダウンロードすることができます。ファイルをダウンロードしたら、ターミナルからドライバーをインストールできます。

ドライバーインストーラーはドライバーをunixODBC に登録し、システムDSN を作成します。これは、後にODBC 接続をサポートするツールやアプリケーションで使用できます。

Ubuntu のようなDebian ベースのシステムでは、sudo またはroot で以下のコマンドを実行します。

$ dpkg -i /path/to/package.deb

Red Hat システムまたは.rpms をサポートするその他のシステムの場合は、sudo またはroot で以下のコマンドを実行します。

$ rpm -i /path/to/package.rpm

ドライバーがインストールされたら、unixODBC ドライバーマネージャーを使用し、登録されたドライバーと定義されたデータソースを一覧表示できます。

登録されているドライバーを一覧表示する

$ odbcinst -q -d
CData ODBC Driver for API
...

定義されたデータソースを一覧表示する

$ odbcinst -q -s
CData API Source
...

CData ODBC Driver for API をunixODBC で使用するには、ドライバーがUTF-16 を使用するように設定されていることを確認します。そのために、インストール場所（通常はcdata.odbc.api.ini）のlib フォルダにある、ドライバー（cdata.odbc.api.ini）のINI ファイルを以下のように編集します。

cdata.odbc.api.ini

...

[Driver]
DriverManagerEncoding = UTF-16

DSN を変更する

ドライバーのインストールにより、システムDSN が事前定義されます。DSN を変更するには、システムデータソースファイル（/etc/odbc.ini）を編集し、必要な接続プロパティを定義します。さらに、$HOME/.odbc.ini での変更にルートアクセスを必要としない、ユーザー固有のDSN を作成することができます。

RabbitMQ Management HTTP API について

RabbitMQ は、複数のメッセージングプロトコルをサポートするオープンソースのメッセージブローカーです。RabbitMQ Management HTTP API は、RabbitMQ サーバーの管理データと監視データに HTTP 経由でアクセスする手段を提供します。この API では、仮想ホスト、エクスチェンジ、キュー、バインディング、コネクション、チャネル、コンシューマー、ユーザー、権限、ポリシー、クラスター全体の統計情報を取得できます。

HTTP API を利用するには、RabbitMQ サーバーで Management プラグインを有効化する必要があります。デフォルトでは、管理インターフェースはポート 15672 でリッスンします。

Basic 認証の設定

RabbitMQ Management HTTP API は HTTP Basic 認証を使用します。RabbitMQ 管理ユーザーのユーザー名とパスワードを指定する必要があります。

管理 API へのアクセスを有効にするには、以下のステップで進めます：

サーバーで RabbitMQ Management プラグインが有効になっていることを確認します（rabbitmq-plugins enable rabbitmq_management）。
既存の管理ユーザーを使用するか、適切な管理タグ（management、policymaker、monitoring、または administrator）を持つユーザーを作成します。
RabbitMQ Management HTTP API の完全なベース URL を控えておきます（例：http://localhost:15672）。

RabbitMQ サーバーを設定したら、以下の接続プロパティを設定して接続します：

AuthScheme：Basic に設定します。
URL：RabbitMQ Management HTTP API のベース URL に設定します（例：http://localhost:15672）。
User：RabbitMQ の管理ユーザー名に設定します（例：guest）。
Password：RabbitMQ の管理パスワードに設定します。

接続文字列の例：

Profile=C:\profiles\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;

利用可能なテーブル

RabbitMQ プロファイルでは、以下のテーブルにアクセスできます：

Overview - クラスター全体の統計情報と RabbitMQ ノードに関する情報
Nodes - RabbitMQ クラスター内の個々のノードに関する情報
NodeMemory - 特定のクラスターノードの詳細なメモリ使用状況の内訳
Connections - ブローカーへのすべてのオープンな AMQP コネクションの一覧
Channels - すべてのコネクションにわたるオープンな AMQP チャネルの一覧
Consumers - すべてのキューに登録されたコンシューマーの一覧
Exchanges - すべての仮想ホストで宣言されたエクスチェンジの一覧
Queues - すべての仮想ホストで宣言されたキューの一覧
Bindings - エクスチェンジとキュー間のすべてのバインディングの一覧
VirtualHosts - ブローカーに設定された仮想ホストの一覧
VhostPermissions - 特定の仮想ホスト内のユーザー権限
Users - すべての RabbitMQ ユーザーの一覧
Permissions - すべての仮想ホストにわたる全ユーザーの権限レコード
TopicPermissions - 全ユーザーのトピックレベルの権限レコード
Policies - 仮想ホスト内のキューおよびエクスチェンジに適用されたポリシーの一覧
OperatorPolicies - 仮想ホスト内のキューに適用されたオペレーターポリシーの一覧
Parameters - 仮想ホストごとのコンポーネントパラメータ（例：federation、shovel）の一覧
GlobalParameters - すべての仮想ホストに適用されるグローバルパラメータの一覧
VhostLimits - 特定の仮想ホストに設定されたリソース制限
UserLimits - 特定のユーザーに設定されたリソース制限
FeatureFlags - フィーチャーフラグの一覧と、ノード上での有効／無効の状態
DeprecatedFeatures - 非推奨機能の一覧と、その使用状態
AuthAttempts - ノードの認証試行統計
ClusterName - RabbitMQ クラスターの名前
WhoAmI - 現在認証されている管理ユーザーに関する情報
ExchangeBindingsSource - 特定のエクスチェンジがソースとなっているバインディング
ExchangeBindingsDestination - 特定のエクスチェンジが宛先となっているバインディング
QueueBindings - 仮想ホスト内の特定のキューのバインディング

/etc/odbc.ini または$HOME/.odbc.ini

[CData API Source]
Driver = CData ODBC Driver for API
Description = My Description
Profile = C:\profiles\\RabbitMQ.apip
AuthScheme = Basic
URL = http://localhost:15672
User = guest
Password = guest

これらの構成ファイルの使用方法については、オンラインのヘルプドキュメントを参照してください。

接続を確立する

odbc_connect またはodbc_pconnect を呼び出して、RabbitMQ への接続を開きます。接続を閉じるには、odbc_close もしくはodbc_close_all を使います。

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

接続はodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いた接続は、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトで接続を共有することが可能です。スクリプト間で接続を共有することにより、システムリソースを節約し、クエリの実行を高速化できます。

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

プリペアドステートメントを作成する

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

$query = odbc_prepare($conn, "SELECT * FROM AuthAttempts WHERE NodeName = ?");

クエリを実行する

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

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM AuthAttempts WHERE NodeName = ?");
$success = odbc_execute($query, array('rabbit@hostname'));

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

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT ,  FROM AuthAttempts WHERE NodeName = 'rabbit@hostname'");

結果の処理

odbc_fetch_array 関数の結果セット配列としてアクセスします。

$conn = odbc_connect("CData ODBCRabbitMQ のデータSource","user","password");
$query = odbc_exec($conn, "SELECT ,  FROM AuthAttempts WHERE NodeName = 'rabbit@hostname'");
while($row = odbc_fetch_array($query)){
 echo $row[""] . "\n";
}

odbc_result_all 関数で、結果セットをHTML テーブルとして表示します。

$conn = odbc_connect("CData ODBCRabbitMQ のデータSource","user","password");
$query = odbc_prepare($conn, "SELECT * FROM AuthAttempts WHERE NodeName = ?");
$success = odbc_execute($query, array('rabbit@hostname'));
if($success)
  odbc_result_all($query);

他のサンプルクエリ

ドライバーがサポートしているSQL の詳細は、ヘルプドキュメントを参照してください。上のサンプルは、PHP community documentation for all ODBC functions をRabbitMQ 向けに変更したものです。

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

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

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

はじめる準備はできましたか？

API Driver で RabbitMQ のライブデータに接続

RabbitMQ に接続

CData は、AI を本番環境で機能させるデータレイヤーです。数百の主要エンタープライズソースへのライブコネクティビティとレプリケーション、セマンティックコンテキスト、組み込みガバナンスを提供。Databricks、Microsoft、Google、Palantir をはじめ、世界中の 10,000 以上のお客様の AI を支えています。

お問い合わせ