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: Имя индекса коллекции для удаления.

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

true, если операция DROP INDEX выполнена успешно, 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 "Индекс с названием 'myindex' был найден и удалён.";
}
?>

Результат выполнения приведённого примера:

Индекс с названием 'myindex' был найден и удалён.

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы