MongoDB\Driver\BulkWrite
PHP Manual

MongoDB\Driver\BulkWrite::delete

(mongodb >=1.0.0)

MongoDB\Driver\BulkWrite::deleteAdd a delete operation to the bulk

説明

public void MongoDB\Driver\BulkWrite::delete ( array|object $filter [, array $deleteOptions ] )

Adds a delete operation to the MongoDB\Driver\BulkWrite.

パラメータ

filter (array|object)

» クエリ述語。 空の述語を指定すると、コレクション内のすべてのドキュメントにマッチします。

deleteOptions

deleteOptions
Option Type Description Default
collation array|object

» Collation は、文字列比較の際の言語固有のルールを指定するものです。たとえば、大文字小文字やアクセント記号の扱いを指定できます。 collation を指定するときには "locale" フィールドが必須となります。それ以外の collation フィールドはすべて任意指定です。 各フィールドについての説明は » Collation のドキュメント を参照ください。

collation が未指定で collection のデフォルトの collation が設定されている場合は、コレクションが持っている collation を用いて操作を実行します。 コレクションや操作にも collation が指定されていない場合は、MongoDB は単純にバイナリ比較を行います。 これは、今までのバージョンでの文字列比較と同じ方法です。

このオプションは MongoDB 3.4 以降で使用可能です。それより前のバージョンのサーバー上で指定すると、実行時に例外が発生します。

limit bool Delete all matching documents (FALSE), or only the first matching document (TRUE) FALSE

返り値

値を返しません。

エラー / 例外

変更履歴

バージョン 説明
1.2.0 Added the "collation" option.

例1 MongoDB\Driver\BulkWrite::delete() example

<?php

$bulk 
= new MongoDB\Driver\BulkWrite;
$bulk->delete(['x' => 1], ['limit' => 1]);
$bulk->delete(['x' => 2], ['limit' => 0]);

$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$writeConcern = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY1000);
$result $manager->executeBulkWrite('db.collection'$bulk$writeConcern);

?>

参考


MongoDB\Driver\BulkWrite
PHP Manual