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

# Collection::dropIndex

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

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

### 説明

public function 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.

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open