Documentation Home
Download this Manual
PDF (US Ltr) - 2.4Mb
PDF (A4) - 2.4Mb

MySQL PHP API  /  ...  /  Collection::remove

5.8.14 Collection::remove

Copyright 1997-2022 the PHP Documentation Group.

  • Collection::remove

    Remove collection documents


public mysql_xdevapi\CollectionRemove mysql_xdevapi\Collection::remove(string search_condition);

Remove collections that meet specific search conditions. Multiple operations are allowed, and parameter binding is supported.



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 Remove object that can be used to add additional remove operations.

If the remove operation is executed, then the returned object will contain the result of the operation.


Example 5.24 mysql_xdevapi\Collection::remove example

$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();

// Remove all painters
  ->remove("job in ('Painter')")

// Remove the oldest butler
  ->remove("job in ('Butler')")
  ->sort('age desc')

// Remove record with lowest age
  ->sort('age desc')