Collection::dropIndex

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

Collection::dropIndexDrop collection index

Description

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.

Parameters

index_name

Name of collection index to drop.

Return Values

true if the DROP INDEX operation succeeded, otherwise false.

Examples

Example #1 mysql_xdevapi\Collection::dropIndex() example

<?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.";}?>

The above example will output:

An index named 'myindex' was found, and dropped.