Collection::dropIndex

master Ver versión oficial en línea Licencia CC-BY-3.0Descargado el 2026-08-02

En esta página

Descripción#

Elimina un índice de colección

Descripción#

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

Elimina un índice de colección.

Esta operación no lanza un error si el índice no existe, pero `false` es devuelto en este caso.

## Parámetros

`index_name`  
El nombre del índice de colección a eliminar.

## Valores devueltos

`true` si la operación DROP INDEX ha tenido éxito, de lo contrario `false`.

## Ejemplos

Ejemplo de `mysql_xdevapi\Collection::dropIndex`

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 "Un índice llamado 'myindex' fue encontrado y eliminado."; } ?>

```php

El ejemplo anterior mostrará:

Un índice llamado 'myindex' fue encontrado y eliminado.