PHP: 問い合わせ

[edit] Last updated: Fri, 25 May 2012

問い合わせ

問い合わせのスレーブへの分散

注意: 1.1.0+

» レプリカセットとバージョン 1.1.0 以降のドライバを使っている場合、ドライバは読み込みを自動的にスレーブにまわします。これは以前のバージョンのドライバにはなかった挙動で、"通常の" マスタ-スレーブでは 使えません。

デフォルトでは、ドライバはすべての問い合わせをマスタに送信します。 "slaveOkay" オプションを設定すると、ドライバはすべての問い合わせを (もし可能なら) プライマリ以外のサーバーに送信します。 "slaveOkay" オプションは、接続、データベース、コレクションおよびカーソルのすべてのレベルで設定できます。各クラスは上位の "slaveOkay" 設定を継承するので、たとえば


<?php

$db->setSlaveOkay(true);
$c = $db->myCollection;

$cursor = $c->find();

?>

のようにすると、この問い合わせはスレーブに対して実行されます (コレクションがデータベースから "slaveOkay" の設定を継承し、カーソルはコレクションからその設定を継承します)。

スレーブはどのように選ばれるか

各 Mongo インスタンスは、利用可能なスレーブの中から、ping の所要時間が最も短いものを自分のスレーブとして選択します。つまり、PHP クライアントがヨーロッパとオーストラリアにあってそれぞれのデータセンターにひとつずつセカンダリがあるとすると、このようにすることができます。


<?php

// P はプライマリです

// オーストラリアのクライアント
$m1 = new Mongo("mongodb://P", array("replicaSet" => true));
$m1->foo->bar->find()->slaveOkay()->getNext();
echo "m1 のスレーブは ".$m1->getSlave()."\n";

// ヨーロッパのクライアント
$m2 = new Mongo("mongodb://P", array("replicaSet" => true));
$m2->foo->bar->find()->slaveOkay()->getNext();
echo "m2 のスレーブは ".$m2->getSlave()."\n";

?>

を試すと、おそらくこのような結果となります。

m1 のスレーブは australianHost
m2 のスレーブは europeanHost

クエリを実行してからでないとスレーブの選択が行われないことに注意しましょう。スレーブの選択は、必要になった時点でドライバが行います。まだスレーブを使っていない場合、Mongo::getSlave() は NULL を返します。

セットのメンバーの現在の状態がどうなっているかを知るには、 Mongo::getHosts() を実行します。

読み込み可能な非プライマリサーバーがない場合は、 (たとえ "slaveOkay" が設定されていても) ドライバはプライマリから読み込みを行います。あるサーバーが読み込み可能であると判定される条件は、その state が 2 (SECONDARY) かつ health が 1 であることです。これらをチェックするには Mongo::getHosts() を使います。

あまり関わるべきではないところに首を突っ込んで楽しみたいのなら、 Mongo::switchSlave() をコールして別のスレーブを使わせることもできます。これは、ランダムに新しいスレーブを選んでそれを使います。自分が何をしているのかをしっかり把握しているのでない限り、これを使ってはいけません。

その他の注意点

書き込みは、常にプライマリに送られます。データベースコマンドについても、たとえ読み込み専用のコマンドであっても常にプライマリに送られます。

スレーブの health と state は、5 秒おきあるいは次の操作の 5 秒前にチェックされます。ドライバがサーバーに到達できずに何か問題が発生したときは、同時に設定の再チェックも行います。

非プライマリサーバーは、操作時はプライマリの背後に隠れています。そのため、最新でないデータを受け取っても大丈夫なようにアプリケーション側で対応しなければなりません (あるいは、すべての書き込みで w を使わなければなりません)。

_id による問い合わせ

追加されたすべてのオブジェクトには、一意な _id フィールドが自動的に付加されます。これは、問い合わせで使うフィールドとして便利です。

今追加したばかりのドキュメントを探すことを考えてみましょう。追加するとドキュメントに _id フィールドができるので、それを問い合わせればいいのです。


<?php

$person = array("name" => "joe");

$people->insert($person);

// $joe には _id フィールドがあります
$joe = $people->findOne(array("_id" => $person['_id']));

?>

ユーザーが別途指定しない限り、_id フィールドは MongoId となります。ありがちな間違いは、文字列を MongoId とマッチさせようとすることです。文字列とは別の型であり、そのままではマッチしないことを覚えておきましょう。これは、文字列 "array()" と空の配列が別のものであるというのと同じことです。次の例を参照ください。


<?php

$person = array("name" => "joe");

$people->insert($person);

// _id を文字列に変換します
$pid = $person['_id'] . "";

// 失敗 - $pid は文字列であり、MongoId ではありません
$joe = $people->findOne(array("_id" => $pid));

?>

配列

配列には特殊な点がいくつかあります。まず、MongoDB が扱う配列には二種類あります。 "普通の" 配列と連想配列です。連想配列には、任意の型のキーと値を組み合わせることができます。 "普通の" 配列は、0 から始まってひとつずつ増えていく数値のインデックスにそれぞれ要素を関連づけます。これらは、ほぼ PHP の配列や連想配列と同じようなものです。

たとえば、受賞の一覧をドキュメントに保存するときには次のようにできます。


<?php

$collection->save(array("awards" => array("gold", "silver", "bronze")));

?>

問い合わせでは、配列の要素も探すことができます。指定した値が配列の要素に含まれるすべてのドキュメントを探すことを考えましょう。たとえば、受賞 (awards) に金賞 (gold) が含まれる次のようなドキュメントです。

{ "_id" : ObjectId("4b06c282edb87a281e09dad9"), "awards" : ["gold", "silver", "bronze"]}

これは、単純なクエリで問い合わせることができます。"awards" が配列であるということを気にせず、次のようにすればいいのです。


<?php

  $cursor = $collection->find(array("awards" => "gold"));

?>

もう少し複雑なオブジェクトを考えてみましょう。配列の各要素のオブジェクトになっている、次のような例だとどうでしょう。

{ 
     "_id" : ObjectId("4b06c282edb87a281e09dad9"), 
     "awards" : 
     [
        {
            "first place" : "gold"
        },
        {
            "second place" : "silver" 
        },
        {
            "third place" :  "bronze"
        }
     ]
}

このような場合でも、配列であることを特別視する必要はありません。内部のオブジェクトへの問い合わせには、ドット記法が使えます。


<?php

$cursor = $collection->find(array("awards.first place" => "gold"));

?>

フィールド名にスペースが含まれていてもかまわないことに注目しましょう (スペースを使わないにこしたことはありませんが、可読性を考慮しました)。

配列を使って、取り得る値を複数指定した問い合わせを行うこともできます。 "gold" あるいは "copper" を含むドキュメントを探すには、このようにします。


<?php

$cursor = $collection->find(array("awards" => array('$in' => array("gold", "copper"))));

?>

更新

書き込み

[edit] Last updated: Fri, 25 May 2012

add a note User Contributed Notes 問い合わせ

patrick at hexane dot org 15-Nov-2011 07:08


Note that $db->collection->find()->count() will always run on the PRIMARY, since underneath the hood ->count() is a dbcommand.

Charle Demers 12-Jul-2010 10:00


Do not forget to call rewind on your resulting MongoCursor, I just learned the hard way that it might not be rewind when you receive it.





For example, assuming that you have some results to the query:





<?php


  // Assuming that $mongo is a valid mongo object.


  $collection = $mongo->selectDB("foo")->selectCollection("bar");


  $cursor = $collection->find();


  echo "Is it valid? " . $cursor->valid()?"VALID":"INVALID";





  $cursor->rewind();


  echo "Is it valid now? " . $cursor->valid()?"VALID":"INVALID";


?>





Will possibly result in:





Is it valid? INVALID


Is it valid now? VALID

Charle Demers 13-May-2010 09:14


Watch for types casting in your queries, make sure ints are typed as ints and strings as strings. 



Ex:

<?php



$friendId = $_SESSION['friendId'];

$request = array( 'friends.friendId' => (int)$friendId );

$friend = $this->_mongo->friends->findOne( $request );



?>



This example would not work without casting the $friendId to int in the request array (unless the friendId column in Mongo is actually really a string).

jhuntwork at lightcubesolutions dot com 17-Feb-2010 02:25


If you have already converted the MongoID into a string elsewhere and need to query for an _id based on the string, you can do so by creating a new MongoID object:



<?php



$m = new Mongo();

$collection = $collection = $m->selectDB('foo')->selectCollection('bar');



$id_string = '4b7c29908ead0e2e1d000000';



// The string is converted to a MongoID object

$mongo_id = new MongoID($id_string);



// $obj will be an array of data if the _id exists in the collection

$obj = $collection->findOne(array('_id'=>$mongo_id));



?>

add a note