dropIndex

dropIndex is a Change Type in the Liquibase Open Source and Liquibase Pro extensions for MongoDB that drops an index for a collection by its keys.

Uses

The Liquibase Pro extension for MongoDB includes several modeled Change Types from the Liquibase Open Source version. These let you specify a few MongoDB commands using Liquibase XML, JSON, and YAML changelogs.

dropIndex is one such Change Type. You can use it to drop an existing index from your database.

Note: If you want to specify mongosh statements in your XML, JSON, and YAML changelogs, use the mongo and mongoFile Change Types instead.

Run

To run this Change Type, follow these steps:

  1. Add the Change Type to your changeset, as shown in the examples on this page.
  2. Specify any required attributes. Use the table on this page to see which ones your database requires.
  3. Deploy your changeset by running the update command:
    4. liquibase update

Available attributes

For more information, see db.collection.dropIndex().

Tip: You must specify all top-level attributes marked as required. If you specify an optional attribute, you must also specify any nested attributes that it requires.

Name Type Description Requirement
collectionName String Name of the collection to drop the index from Required

keys

Required. A document that defines the index's basic contents and structure.

keys has the following nested attributes:

  • name (string) (required): the name of a key in the collection to use for the index
  • type (string) (required): the type of the index. For an ascending index, specify 1. For a descending index, specify -1. Other accepted values include text, geospatial, hashed, and more.

Examples

databaseChangeLog:
  - changeSet:
      id: 4
      author: your.name
      changes:
        - dropIndex:
            collectionName: countries_yaml
            keys: '{ name: 1, type: 1}'
        - rollback:
{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "4",
        "author": "your.name",
        "changes": [
          {
            "dropIndex": {
              "collectionName": "countries_json",
              "keys": {
                "$rawJson": {
                  "name": 1,
                  "type": 1
                }
              }
            }
          }
        ],
        "rollback": ""
      }
    }
  ]
}

The Liquibase MongoDB Open Source extension uses a unique mongodb XML namespace and XSD files in the changelog header. However, the ext prefix used with other extensions is backwards-compatible:

<databaseChangeLog
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:mongodb="http://www.liquibase.org/xml/ns/mongodb"
    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
    http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd
    http://www.liquibase.org/xml/ns/mongodb
    http://www.liquibase.org/xml/ns/mongodb/liquibase-mongodb-latest.xsd">

    <changeSet id="4" author="your.name">
        <mongodb:dropIndex collectionName="countries">
            <mongodb:keys>
                { name: 1, type: 1}
            </mongodb:keys>
        </mongodb:dropIndex>

        <rollback/>
    </changeSet>

</databaseChangeLog>

Database support

This Change Type is only supported for MongoDB. It does not support auto rollback.