Collection::add
(No version information available, might only be in Git)
Collection::add — Add collection document
Description
Triggers the insertion of the given document(s) into the collection, and multiple variants of this method are supported. Options include:
-
Add a single document as a JSON string.
-
Add a single document as an array as:
[ 'field' => 'value', 'field2' => 'value2' ... ] -
A mix of both, and multiple documents can be added in the same operation.
Parameters
-
document -
One or multiple documents, and this can be either JSON or an array of fields with their associated values. This cannot be an empty array.
The MySQL server automatically generates unique
_idvalues for each document (recommended), although this can be manually added as well. This value must be unique as otherwise the add operation will fail.
Return Values
A CollectionAdd object. Use execute() to return a Result that can be used to query the number of affected items, the number warnings generated by the operation, or to fetch a list of generated IDs for the inserted documents.
Examples
Example #1 mysql_xdevapi\Collection::add() 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");
// Add two documents
$collection->add('{"name": "Fred", "age": 21, "job": "Construction"}')->execute();
$collection->add('{"name": "Wilma", "age": 23, "job": "Teacher"}')->execute();
// Add two documents using a single JSON object
$result = $collection->add(
'{"name": "Bernie",
"jobs": [{"title":"Cat Herder","Salary":42000}, {"title":"Father","Salary":0}],
"hobbies": ["Sports","Making cupcakes"]}',
'{"name": "Jane",
"jobs": [{"title":"Scientist","Salary":18000}, {"title":"Mother","Salary":0}],
"hobbies": ["Walking","Making pies"]}')->execute();
// Fetch a list of generated ID's from the last add()
$ids = $result->getGeneratedIds();
print_r($ids);
?>
The above example will output something similar to:
Array
(
[0] => 00005b6b53610000000000000056
[1] => 00005b6b53610000000000000057
)
Notes
Note:
A unique _id is generated by MySQL Server 8.0 or higher, as demonstrated in the example. The _id field must be manually defined if using MySQL Server 5.7.
