PHP中Collection::addOrReplaceOne 什么意思？如何使用？

摘要

Collection::addOrReplaceOne 方法在 PHP 的 MongoDB 库中用于向集合中添加或替换单个文档。当文档的唯一标识字段（主键）与集合中已存在的文档匹配时，此方法将替换该现有文档；如果不存在匹配的文档，则插入新文档。

详细说明

语法

public function addOrReplaceOne(array|object $document, ?array $options = []): WriteResult

参数

• $document: 要添加或替换的文档。可以是关联数组或对象。

• $options: 可选。一个数组，包含以下选项：

  • upsert: 布尔值，指示在不存在匹配文档的情况下是否插入文档。默认为 false。
  • writeConcern: 写入关注选项，用于控制写入操作的确认策略。
  • bypassDocumentValidation: 布尔值，指示是否绕过文档验证。默认为 false。
  • session: 会话对象，用于在事务中执行操作。

返回值

addOrReplaceOne 方法返回一个 WriteResult 对象，其中包含有关写入操作的结果信息，包括插入或替换的文档数、修改的文档数以及 Upsert 操作是否成功。

用法

要使用 addOrReplaceOne 方法，首先需要创建一个集合对象：

$collection = $client->selectCollection("database", "collection");

然后，可以传递要添加或替换的文档及可选选项：

$document = ["name" => "Alice", "age" => 30];

$result = $collection->addOrReplaceOne($document);

如果不存在具有相同唯一标识符的文档，则会插入文档。如果存在匹配的文档，则会替换它：

$document = ["_id" => "123", "name" => "Bob", "age" => 35];

$result = $collection->addOrReplaceOne($document);

示例：使用 upsert 选项

如果要确保文档存在，即使它不存在于集合中，也可以使用 upsert 选项：

$document = ["name" => "Carol", "age" => 40];

$result = $collection->addOrReplaceOne($document, ["upsert" => true]);

示例：使用 writeConcern

要控制写入操作的确认策略，可以传递一个 writeConcern 选项：

$writeConcern = new WriteConcern(WriteConcern::MAJORITY, 10000);

$result = $collection->addOrReplaceOne($document, ["writeConcern" => $writeConcern]);

注意

• 文档的唯一标识字段（主键）必须是 BSON 数据类型之一（例如 ObjectId 或 string）。
• 如果文档的唯一标识符已经存在，则整个文档将被替换，包括任何嵌套的文档或数组。
• addOrReplaceOne 方法是一个底层方法，通常与 MongoDB 的集合管道操作结合使用，而不是直接调用。

以上就是PHP中Collection::addOrReplaceOne 什么意思？如何使用？的详细内容，更多请关注编程网其它相关文章！