Docs Menu
Docs Home
/
言語
/
PHP
/
PHP ライブラリ マニュアル
/
API ドキュメント
/
MongoDB\Database

MongoDB\Database::command()

項目一覧

  • 定義
  • パラメーター
  • Return Values
  • エラーと例外
  • 例
  • その他の参照

定義

MongoDB\Database::command()

データベースでコマンドを実行します。 これは通常、ライブラリ内に対応するヘルパー メソッドがないコマンドを実行するために使用されます。

function command(
    array|object $command,
    array $options = []
): MongoDB\Driver\Cursor

パラメーター

$command : array|object
データベースコマンドドキュメント。
$options : 配列

必要なオプションを指定する配列。

名前
タイプ
説明
readPreference

操作に使用する読み取り設定。 データベースの読み込み設定（read preference）がデフォルトで設定されます。

セッション

操作に関連付けるクライアント セッション。

バージョン 1.3 で追加。

typeMap
配列

型マップ カーソルに適用される 。これは、BSON ドキュメントが PHP 値に変換される方法を決定します。データベースのタイプ マップがデフォルトで設定されます。

Return Values

MongoDB\Driver\Cursor オブジェクト。

エラーと例外

MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合は です。

MongoDB\Driver\Exception\RuntimeException 拡張レベルのその他のエラー（例:）。

例

ほとんどのデータベースコマンドは結果ドキュメントを 1 つ返します。このドキュメントは、返されたカーソルを配列に変換し、その最初の要素にアクセスすることで取得できます。 次の例では、 pingコマンドを実行し、その結果ドキュメントを出力します。

<?php
$database = (new MongoDB\Client)->test;
$cursor = $database->command(['ping' => 1]);
var_dump($cursor->toArray()[0]);

出力は次のようになります。

object(MongoDB\Model\BSONDocument)#11 (1) {
  ["storage":"ArrayObject":private]=>
  array(1) {
    ["ok"]=>
    float(1)
  }
}

一部のデータベースコマンドは、複数の結果を持つカーソルを返します。 The following example executes listCollections, which returns a cursor containing a result document for each collection in the test database. この例は、説明のためのものであることに注意してください。アプリケーションでは通常、実際にはMongoDB\Database::listCollections()が使用されます。

<?php
$database = (new MongoDB\Client)->test;
$cursor = $database->command(['listCollections' => 1]);
var_dump($cursor->toArray());

出力は次のようになります。

array(3) {
  [0]=>
  object(MongoDB\Model\BSONDocument)#11 (1) {
    ["storage":"ArrayObject":private]=>
    array(2) {
      ["name"]=>
      string(11) "restaurants"
      ["options"]=>
      object(MongoDB\Model\BSONDocument)#3 (1) {
        ["storage":"ArrayObject":private]=>
        array(0) {
        }
      }
    }
  }
  [1]=>
  object(MongoDB\Model\BSONDocument)#13 (1) {
    ["storage":"ArrayObject":private]=>
    array(2) {
      ["name"]=>
      string(5) "users"
      ["options"]=>
      object(MongoDB\Model\BSONDocument)#12 (1) {
        ["storage":"ArrayObject":private]=>
        array(0) {
        }
      }
    }
  }
  [2]=>
  object(MongoDB\Model\BSONDocument)#15 (1) {
    ["storage":"ArrayObject":private]=>
    array(2) {
      ["name"]=>
      string(6) "restos"
      ["options"]=>
      object(MongoDB\Model\BSONDocument)#14 (1) {
        ["storage":"ArrayObject":private]=>
        array(0) {
        }
      }
    }
  }
}

その他の参照

戻る

Aggregate()

次へ

createCollection()