Documentation Home
MySQL PHP API
Download this Manual
PDF (US Ltr) - 2.4Mb
PDF (A4) - 2.4Mb
HTML Download (TGZ) - 250.2Kb
HTML Download (Zip) - 257.7Kb


MySQL PHP API  /  ...  /  Collection::dropIndex

5.6.6 Collection::dropIndex

Copyright 1997-2019 the PHP Documentation Group.

  • Collection::dropIndex

    Drop collection index

Description

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

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 5.15 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.