CollectionModify::replace

(No version information available, might only be in Git)

CollectionModify::replace — Replace document field

Description

public mysql_xdevapi\CollectionModify::replace(string $collection_field, string $expression_or_literal): mysql_xdevapi\CollectionModify

Replace (update) a given field value with a new one.

Parameters

collection_field: The document path of the item to set.
expression_or_literal: The value to set on the specified attribute.

Return Values

A CollectionModify object.

Examples

Example #1 mysql_xdevapi\CollectionModify::replace() 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");

$result = $collection
 ->add(
 '{"name": "Bernie",
 "traits": ["Friend", "Brother", "Human"]}') 
 ->execute();

$collection
 ->modify("name = :name")
 ->bind(['name' => 'Bernie'])
 ->replace("name", "Bern")
 ->execute();

$result = $collection
 ->find()
 ->execute();

print_r($result->fetchAll());
?>

The above example will output something similar to:

Array
(
 [0] => Array
 (
 [_id] => 00005b6b5361000000000000011b
 [name] => Bern
 [traits] => Array
 (
 [0] => Friend
 [1] => Brother
 [2] => Human
 )
 )
)

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

+add a note

User Contributed Notes

There are no user contributed notes for this page.