MongoDB\ClientBulkWrite::replaceOne()

2.1版本新增。

定义

MongoDB\ClientBulkWrite::replaceOne()

在批量写入命令中为第一个匹配文档指定替换操作。此方法返回调用该方法的MongoDB\ClientBulkWrite 实例。

function replaceOne(
    array|object $filter,
    array|object $replacement,
    array $options = []
): self

$filter : array|object

指定要替换的文档的筛选条件。

$replacement : array|object

替换文档。

$options : array

指定所需选项的数组。

名称	类型	说明
排序规则	数组\|对象	排序规则允许用户为string比较指定特定于语言的规则，例如字母大小写和重音符号规则。指定排序规则时， `locale`字段为必填字段；所有其他排序规则字段都是可选的。有关字段的说明，请参阅排序规则文档。如果未指定排序规则但集合具有默认排序规则，则操作将使用为集合指定的排序规则。如果没有为集合或操作指定排序规则，MongoDB 将使用先前版本中用于字符串比较的简单二进制比较。
提示	字符串\|数组\|对象	要使用的索引。将索引名称指定为字符串或将索引键模式指定为文档。如果指定，查询系统将只考虑使用提示索引的计划。
sort	数组\|对象	匹配文档排序的排序规范。设置此选项可在服务器执行替换操作之前对匹配的文档应用顺序。
更新插入	布尔	如果设置为 `true`，则在没有文档符合查询条件时创建一个新文档。默认值为 `false`，在未找到匹配项时不插入新文档。

MongoDB\Exception\UnsupportedException，如果所选服务器使用了选项但不支持选项（例如collation、readConcern、writeConcern）。

MongoDB\Exception\InvalidArgumentException 用于与参数或选项解析相关的错误。

MongoDB\ 驱动程序\Exception\BulkWriteCommandException 以了解与写入操作相关的错误。您可以检查 getWriteErrors() 返回的值，以确定错误的性质。

MongoDB\ 驱动程序\Exception\RuntimeException 对于扩展级别的其他错误（例如连接错误）。

在评估查询条件时，MongoDB 会根据自己的比较规则来BSON types 比较类型和值，这不同于的PHP 比较和类型杂技规则。匹配特殊BSON类型时，查询条件应使用相应的 BSON类在扩展（例如使用 MongoDB\ BSON\ObjectId 以匹配 ObjectId ）。

示例，写入操作可能已成功应用于主节点 (primary node in the replica set)服务器，但未能满足写关注（write concern）。或者，写入操作可能彻底失败，示例由于违反了唯一键约束。

后退

insertOne()

来年

updateMany()