Collection::addOrReplaceOne
(No version information available, might only be in Git)
Collection::addOrReplaceOne — Add or replace collection document
Description
Add a new document, or replace a document if it already exists.
Here are several scenarios for this method:
-
If neither the id or any unique key values conflict with any document in the collection, then the document is added.
-
If the id does not match any document but one or more unique key values conflict with a document in the collection, then an error is raised.
-
If id matches an existing document and no unique keys are defined for the collection, then the document is replaced.
-
If id matches an existing document, and either all unique keys in the replacement document match that same document or they don't conflict with any other documents in the collection, then the document is replaced.
-
If id matches an existing document and one or more unique keys match a different document from the collection, then an error is raised.
Parameters
-
id -
This is the filter id. If this id or any other field that has a unique index already exists in the collection, then it will update the matching document instead.
By default, this id is automatically generated by MySQL Server when the record was added, and is referenced as a field named '_id'.
-
doc -
This is the document to add or replace, which is a JSON string.
Return Values
A Result object.
Examples
Example #1 mysql_xdevapi\Collection::addOrReplaceOne() example
<?php
$session = mysql_xdevapi\getSession("mysqlx://user:password@localhost");
$session->sql("DROP DATABASE IF EXISTS addressbook")->execute();
$session->sql("CREATE DATABASE addressbook")->execute();
$schema = $session->getSchema("addressbook");
$create = $schema->createCollection("people");
$collection = $schema->getCollection("people");
// Using add()
$result = $collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute();
// Using addOrReplaceOne()
// Note: we're passing in a known _id value here
$result = $collection->addOrReplaceOne('00005b6b53610000000000000056', '{"name": "Fred", "age": 21, "job": "Construction"}');
?>
