PHP Conference China 2020

Collection::dropIndex

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

Collection::dropIndexコレクションのインデックスを削除

説明

public mysql_xdevapi\Collection::dropIndex ( string $index_name ) : bool

コレクションのインデックスを削除します。

この操作は、インデックスが存在しなくてもエラーは発生しません。 しかし、その場合には FALSE を返します。

パラメータ

index_name

削除するコレクションのインデックスの名前

返り値

DROP INDEX の操作が成功したら TRUE そうでなければ FALSE

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

<?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");
$create $schema->createCollection("people");

// ...

$collection $schema->getCollection("people");

$collection->createIndex(
  
'myindex'
  
'{"fields": [{"field": "$.name", "type": "TEXT(25)", "required": true}], "unique": false}'
);

// ...

if ($collection->dropIndex('myindex')) {
    echo 
'An index named 'myindex' was found, and dropped.';
}
?>

上の例の出力は以下となります。

An index named 'myindex' was found, and dropped.
add a note add a note

User Contributed Notes

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