MongoDB\Database::modifyCollection()

項目一覧

定義

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

バージョン 1.4 で追加。

定義

MongoDB\Database::modifyCollection()

指定された$collectionOptionsに従ってコレクションまたはビューを変更します。

function modifyCollection(
    string $collectionName,
    array $collectionOptions,
    array $options = []
): array|object

パラメーター

$collectionName : string

変更するコレクションまたはビューの名前。

$collectionOptions : 配列

割り当てるコレクションまたはビューのオプション。

$options : 配列

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

名前	タイプ	説明
comment	混合	ユーザーが任意のコメントを指定して、データベースプロファイラ、 currentOp出力、ログから操作を追跡できるようにします。このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバーバージョンで指定すると実行時に例外が発生します。バージョン 1.13 の新機能。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアントセッション。
typeMap	配列	型マップカーソルに適用される。これは、BSON ドキュメントが PHP 値に変換される方法を決定します。データベースのタイプマップがデフォルトで設定されます。これは返されたコマンドの結果ドキュメントに使用されます。
writeConcern	MongoDB\Driver\WriteConcern	操作に使用する書込み保証 ( write concern )。データベースの書込み保証 (write concern) のデフォルト。

Return Values

collModコマンドの結果ドキュメントを含む配列またはオブジェクト。

エラーと例外

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

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

例

次の例では、 testデータベース内の TTL コレクションの有効期限を変更します。

<?php
$db = (new MongoDB\Client)->test;
$result = $db->modifyCollection('users', [
    'keyPattern' => ['lastAccess' => 1],
    'expireAfterSeconds' => 1000
]);
var_dump($result);

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

object(stdClass)#2779 {
  ["expireAfterSeconds_old"]=>
  int(3)
  ["expireAfterSeconds_new"]=>
  int(1000)
  ["ok"]=>
  float(1)
}

その他の参照

MongoDB マニュアルのcollModコマンドに関する参考資料

戻る

listCollections()

renameCollection()