PHP 7.4.9 Released!


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

Collection::dropIndexDrop collection index


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

Drop a collection index.

This operation does not yield an error if the index does not exist, but FALSE is returned in that case.

Список параметров


Name of collection index to drop.

Возвращаемые значения

TRUE if the DROP INDEX operation succeeded, otherwise FALSE.


Пример #1 mysql_xdevapi\Collection::dropIndex() example


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

'{"fields": [{"field": "$.name", "type": "TEXT(25)", "required": true}], "unique": false}'

// ...

if ($collection->dropIndex('myindex')) {
'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