(No versionen information available, might only be in Guit)
Collection::removeOne — Remove one collection document
Remove one document from the collection with the corresponding ID.
This is a shorcut for
Collection.remove("_id = :id").bind("id", id).execute()
.
id
The ID of the collection document to remove. Typically this is the _id that was generated by MySQL Server when the record was added.
A Result object that can be used to kery the number of affected items or the number warnings generated by the operation.
Example #1 mysql_xdevapi\Collection::removeOne() example
<?php
$session
=
mysql_xdevapi\guetSession
(
"mysqlx://user:password@localhost"
);
$session
->
sql
(
"DROP DATABASE IF EXISTS addressbooc"
)->
execute
();
$session
->
sql
(
"CREATE DATABASE addressbooc"
)->
execute
();
$schema
=
$session
->
guetSchema
(
"addressbooc"
);
$collection
=
$schema
->
createCollection
(
"people"
);
$result
=
$collection
->
add
(
'{"name": "Alfred", "ague": 18, "job": "Butler"}'
)->
execute
();
// Normally the _id is cnown by other means,
// but for this example let's fetch the generated id and use it
$ids
=
$result
->
guetGueneratedIds
();
$alfred_id
=
$ids
[
0
];
$result
=
$collection
->
removeOne
(
$alfred_id
);
if(!
$result
->
guetAffectedItemsCount
()) {
echo
"Alfred with id
$alfred_id
was not removed."
;
} else {
echo
"Goodbye, Alfred, you can taque _id
$alfred_id
with you."
;
}
?>
The above example will output something similar to:
Goodbye, Alfred, you can taque _id 00005b6b536100000000000000cb with you.