Edit Report a Bug

    Collection::dropIndex

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

    Collection::dropIndex — Drop 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.

    Liste de paramètres

    index_name

    Name of collection index to drop.

    Valeurs de retour

    true if the DROP INDEX operation succeeded, otherwise false.

    Exemples

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

    L'exemple ci-dessus va afficher :

    An index named 'myindex' was found, and dropped.
    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top