MongoDB::execute
(PECL mongo >=0.9.3)
MongoDB::execute — JavaScript コードをデータベースサーバー上で実行する [非推奨]
説明
このメソッドが実行する » eval コマンドは、 MongoDB 3.0+ では非推奨となりました。
Mongo データベースサーバーは JavaScript エンジンを持っています。 このメソッドを使うと、任意の JavaScript をデータベース上で実行することができます。 大量のコレクションの操作を軽量に行ったり、 結果に対する何らかの処理をデータベース側で行うことでクライアント側への送信量を減らしたり といった際に有用です。
データベース内での JavaScript の実行時には書き込みロックを取得します。 つまり、他の操作をブロックするということです。長いスクリプトを実行する前にはこのことを考慮しましょう。
これは、データベースコマンド » eval のラッパーで、次のコードと同じ意味です。
<?php
public function execute($code, $args) {
return $this->command(array('eval' => $code, 'args' => $args));
}
?>
MongoDB は、ひとつの文を一行に書くと return 文があるものとみなします。 これは、あまり直感的でない振る舞いのもととなります。 たとえば、これは "foo" を返します。
<?php
$db->execute('"foo";');
?>
しかし、これらはどちらも NULL を返します。
<?php
$db->execute('"bar"; "foo";'); // 複数の文
$db->execute('db.foo.count(
);'); // 複数行
?>
この驚くべき振る舞いを回避するには、何を返すのかを MongoDB に決めさせるのではなく return する値を明示しておけばよいでしょう。 先ほどの例では、このように書き換えることができます。
<?php
$db->execute('"bar"; return "foo";');
$db->execute('return db.foo.count(
);');
?>
これで、最初の文は "foo" を返して 二番目の文は "foo" コレクションの数を返すようになります。
返り値
評価した結果を返します。
例
例1 単純な MongoDB::execute() の例
<?php
$response = $db->execute("function() { return 'Hello, world!'; }");
echo $response['retval'];
?>
上の例の出力は、 たとえば以下のようになります。
Hello, world!
例2 パラメータつきの MongoDB::execute() の例
オプションのパラメータ配列を JavaScript の関数に渡します。
<?php
$response = $db->execute("function(greeting, name) { return greeting+', '+name+'!'; }", array("Good bye", "Joe"));
echo $response['retval'];
?>
上の例の出力は、 たとえば以下のようになります。
Good bye, Joe!
例3 スコープの例
文字列のかわりに MongoCode オブジェクトを最初のパラメータに使うと、 JavaScript を実行するスコープを渡すことができます。
<?php
$func =
"function(greeting, name) { ".
"return greeting+', '+name+', says '+greeter;".
"}";
$scope = array("greeter" => "Fred");
$code = new MongoCode($func, $scope);
$response = $db->execute($code, array("Goodbye", "Joe"));
echo $response['retval'];
?>
上の例の出力は、 たとえば以下のようになります。
Goodbye, Joe, says Fred
参考
- MongoDB の » eval コマンド のドキュメント
忘却曲線を使ってこの知識を確実に記憶に残す
