Collection::modify
(No version information available, might only be in Git)
Collection::modify — Modify collection documents
Description
$search_condition
) : mysql_xdevapi\CollectionModifyModify collections that meet specific search conditions. Multiple operations are allowed, and parameter binding is supported.
Parameters
-
search_condition
-
Must be a valid SQL expression used to match the documents to modify. This expression might be as simple as
TRUE
, which matches all documents, or it might use functions and operators such as'CAST(_id AS SIGNED) >= 10'
,'age MOD 2 = 0 OR age MOD 3 = 0'
, or'_id IN ["2","5","7","10"]'
.
Return Values
If the operation is not executed, then the function will return a Modify object that can be used to add additional modify operations.
If the modify operation is executed, then the returned object will contain the result of the operation.
Examples
Example #1 mysql_xdevapi\Collection::modify() 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");
$collection = $schema->createCollection("people");
$collection->add('{"name": "Alfred", "age": 18, "job": "Butler"}')->execute();
$collection->add('{"name": "Bob", "age": 19, "job": "Painter"}')->execute();
// Add two new jobs for all Painters: Artist and Crafter
$collection
->modify("job in ('Butler', 'Painter')")
->arrayAppend('job', 'Artist')
->arrayAppend('job', 'Crafter')
->execute();
// Remove the 'beer' field from all documents with the age 21
$collection
->modify('age < 21')
->unset(['beer'])
->execute();
?>
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-mysql-xdevapi-collection.modify.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.