PHP MongoDBコンテキストオプション徹底解説！コールバック関数とサーバー情報パラメータの一覧

はじめに

PHPは、データベース拡張モジュールを通じてMongoDBデータベースと連携することができます。旧バージョンのPHPでは、PECLからmongoドライバーをインストールして利用していましたが、現在はその後継となるmongodbドライバーが標準的な選択肢です。

どちらのドライバーも、Linux・Windows・MacOS向けにコンパイル済みバイナリとして提供されているため、手軽にインストールできます。また、GitHubで公開されているソースtarballから手動でビルド・インストールすることも可能です。いずれの場合も、php.iniの設定でmongoまたはmongodb拡張を有効化する必要がある点に注意してください。

PHPのMongoDB拡張は、mongodbコンテキストによるストリームコンテキストサポートを提供しています。これにより、クエリのログ取得やデバッグなどに役立つ各種コールバック関数を登録できます。主なコンテキストオプションは以下の通りです。

コンテキストオプション一覧

log_cmd_insert(array $server, array $document, array $writeOptions, array $protocolOptions)

ドキュメントを挿入する際に、log_cmd_insertコンテキストオプションによって呼び出されるコールバック関数です。

log_cmd_delete(array $server, array $writeOptions, array $deleteOptions, array $protocolOptions)

ドキュメントを削除する際に、log_cmd_deleteコンテキストオプションによって呼び出されるコールバック関数です。

log_cmd_update(array $server, array $writeOptions, array $updateOptions, array $protocolOptions)

ドキュメントを更新する際に、log_cmd_updateコンテキストオプションによって呼び出される関数です。

log_write_batch(array $server, array $writeOptions, array $batch, array $protocolOptions)

バッチ操作を実行する際に、log_write_batchコンテキストオプションによって呼び出される関数です。

log_reply(array $server, array $messageHeaders, array $operationHeaders)

MongoDBからの応答を読み取る際に使用されるコールバック関数です。

log_getmore(array $server, array $info)

GET_MORE操作を実行する際に、log_getmoreコンテキストオプションによって呼び出されるコールバック関数です。

log_killcursor(array $server, array $info)

KILLCURSOR操作を実行する際に呼び出されるコールバック関数です。

$server配列に含まれる基本情報

これらのコールバック関数に渡される$server配列には、接続先ノードに関する以下の基本的な情報が格納されています。

• hash − サーバーハッシュ。例：localhost:27017;-;X;56052
• type − ノードタイプ（primary／secondary／mongos／arbiter）。例：2
• max_bson_size − このノードがネットワーク経由で受け付けられる最大BSONサイズ。例：16777216
• max_message_size − このノードがネットワーク経由で受け付けられる最大メッセージサイズ。例：48000000
• request_id − このメッセージのリクエスト識別子。例：42

これらのコンテキストオプションを活用することで、MongoDBへの操作を細かく監視し、アプリケーションのデバッグやパフォーマンスチューニングに役立てることができます。