runCommand

runCommand is a Change Type in the Liquibase Open Source and Liquibase Pro extensions for MongoDB that provides a helper to run specified database commands.

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.

runCommand is one such Change Type. You can use it to run commands on the current database. This is the preferred method to issue database commands as it provides a consistent interface between the shell and drivers.

If you want to run commands on the built-in admin database, use adminCommand instead.

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.runCommand().

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
command Raw JSON

The command to run

 Required

Examples

databaseChangeLog:
  - changeSet:
      id: 1
      author: your.name
      changes:
        - runCommand:
            command: |
              {
                buildInfo: 1
              }
        - rollback:
{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "1",
        "author": "your.name",
        "changes": [
          {
            "runCommand": {
              "command": "{ buildInfo: 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="1" author="your.name">
        <mongodb:runCommand>
            <mongodb:command>
                {
                  buildInfo: 1
                }
            </mongodb:command>
        </mongodb:runCommand>

        <rollback/>
    </changeSet>
</databaseChangeLog>

Database support

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