MongoDB\Driver\BulkWrite::delete

(mongodb >=1.0.0)

MongoDB\Driver\BulkWrite::delete向批处理添加删除操作

描述

public MongoDB\Driver\BulkWrite::delete(array|object $filter, ?array $deleteOptions = null): void

MongoDB\Driver\BulkWrite 添加删除操作。

参数

filter (array|object)

The » 查询谓词。空谓词将匹配集合中的所有文档。

注意: 在评估查询条件时,MongoDB 会根据其自己的 » BSON 类型比较规则 来比较类型和值,这与 PHP 的 比较类型转换 规则不同。在匹配特殊 BSON 类型时,查询条件应使用相应的 BSON 类(例如,使用 MongoDB\BSON\ObjectId 匹配 » ObjectId)。

deleteOptions

deleteOptions
选项 类型 描述 默认值
collation array|object

» 校对 允许用户为字符串比较指定特定于语言的规则,例如字母大小写和重音符号的规则。在指定校对时,"locale" 字段是必需的;所有其他校对字段都是可选的。有关字段的描述,请参见 » 校对文档

如果未指定校对,但集合具有默认校对,则操作将使用为集合指定的校对。如果未为集合或操作指定任何校对,则 MongoDB 将使用之前版本中用于字符串比较的简单二进制比较。

此选项在 MongoDB 3.4+ 中可用,如果为较旧的服务器版本指定,则会在执行时导致异常。

hint string|array|object

索引规范。指定索引名称作为字符串或索引键模式。如果指定,则查询系统将仅考虑使用提示索引的计划。

此选项在 MongoDB 4.4+ 中可用,如果为较旧的服务器版本指定,则会在执行时导致异常。

limit bool 删除所有匹配的文档 (false),或者仅删除第一个匹配的文档 (true) false

返回值

不返回任何值。

错误/异常

变更日志

版本 描述
PECL mongodb 1.8.0 添加了 "hint" 选项。
PECL mongodb 1.2.0 添加了 "collation" 选项。

示例

示例 #1 MongoDB\Driver\BulkWrite::delete() 示例

<?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);

?>

参见

添加笔记

用户贡献笔记

此页面没有用户贡献笔记。
To Top