PHP 7.4.3 released

Collection::removeOne

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

Collection::removeOneコレクションからドキュメントをひとつ削除する

説明

public mysql_xdevapi\Collection::removeOne ( string $id ) : mysql_xdevapi\Result

指定したIDに対応するドキュメントをコレクションから削除する。 これは、Collection.remove("_id = :id").bind("id", id).execute() のショートカットです。

パラメータ

id

削除するコレクションのドキュメントのID。 これは、通常はレコードが追加されたときに MySQLサーバ が生成した _id の値です。

返り値

影響を受けたアイテムの数、 または、操作によって発生した警告の数 を問い合わせるために使われる Resultオブジェクト。

例1 mysql_xdevapi\Collection::removeOne() の例

<?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": "Alfred", "age": 18, "job": "Butler"}')->execute();

// Normally the _id is known by other means, 
// but for this example let's fetch the generated id and use it
$ids       $result->getGeneratedIds();
$alfred_id $ids[0];

$result $collection->removeOne($alfred_id);

if(!
$result->getAffectedItemsCount()) {
    echo 
"Alfred with id $alfred_id was not removed.";
} else {
    echo 
"Goodbye, Alfred, you can take _id $alfred_id with you.";
}
?>

上の例の出力は、 たとえば以下のようになります。

Goodbye, Alfred, you can take _id 00005b6b536100000000000000cb with you.
add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top