MongoDB\Driver\BulkWrite::delete
(mongodb >=1.0.0)
MongoDB\Driver\BulkWrite::delete — Add a delete operation to the bulk
Descrierea
$filter
, array $deleteOptions = ?
) : voidAdds a delete operation to the MongoDB\Driver\BulkWrite.
Parametri
-
filter(array|object) -
» predicatul interpelării. Un predicat vid se va potrivi cu toate documentele din colecție.
Notă: La evaluarea criteriilor interpelării MongoDB compară tipurile și valorile conform propriilor » reguli de comparație pentru tipuri BSON, care diferă de regulile PHP de comparare și substituirea tipurilor. La potrivirea unui tip special BSON criteriile interpelării trebuie să utilizeze clasa BSON respectivă (de ex. trebuie utilizat MongoDB\BSON\ObjectId pentru a potrivi un » ObjectId).
-
deleteOptions -
deleteOptions Option Type Description Default collation array|object » Collation permite utilizatorilor să indice reguli specifice limbii pentru comparații ale șirurilor de caractere cum ar fi reguli pentru caractere minuscule, majuscule, cu accente. La specificarea collation câmpul
"locale"este obligatoriu; restul câmpurilor collation sunt opționale. Pentru descrierile câmpurilor a se vedea » Collation Document.Dacă collation nu este specificat, dar colecția are un collation implicit, atunci operațiunea folosește collation specificat pentru colecție. Dacă nu este specificat un collation pentru colecție sau pentru operație, MongoDB folosește comparația binară simplă, ca în versiunile anterioare, pentru compararea șirurilor de caractere.
Această opțiune este disponibilă în MongoDB 3.4+ și va rezulta într-o excepție în timpul execuției dacă este specificată pentru o versiune mai veche a serverului.
hint string|array|object Index specification. Specify either the index name as a string or the index key pattern. If specified, then the query system will only consider plans using the hinted index.
This option is available in MongoDB 4.4+ and will result in an exception at execution time if specified for an older server version.
limit bool Delete all matching documents ( false), or only the first matching document (true)false
Valorile întoarse
Nu este întoarsă nici o valoare.
Erori/Excepții
- Emite MongoDB\Driver\Exception\InvalidArgumentException în cazul erorilor la interpretarea argumentelor.
Istoricul schimbărilor
| Versiune | Descriere |
|---|---|
| PECL mongodb 1.8.0 |
Added the "hint" option.
|
| PECL mongodb 1.2.0 |
Added the "collation" option.
|
Exemple
Example #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');
$result = $manager->executeBulkWrite('db.collection', $bulk);
?>
A se vedea și
- MongoDB\Driver\Manager::executeBulkWrite() - Execute one or more write operations
- MongoDB\Driver\WriteResult
add a note
