> User Documentation Home

User Handbook
Tutorials
Resources

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Liquibase Runner

View this plugin on the Plugins site

step([$class: 'DropAllBuilder']): Liquibase: Drop everything in database

  • changeLogFile (optional)
    • Type: String
  • changeLogParameters (optional)
    • Type: String
  • contexts (optional)
    Liquibase contexts to execute under.
    • Type: String
  • credentialsId (optional)
    • Type: String
  • installationName (optional)
    • Type: String
  • labels (optional)
    Liquibase labels to execute
    • Type: String
  • liquibasePropertiesPath (optional)
    A liquibase.properties file can be used for default values. Any of the below settings will override what is in this file. This file should be relative to a directory listed in the "Resource directories" section.
    • Type: String
  • password (optional)
    • Type: String
  • resourceDirectories (optional)
    Leave blank for workspace root. May be relative to workspace or an absolute path.
    • Type: String
  • url (optional)
    example: jdbc:mysql://localhost:3306/sampledb. The JDBC driver must be available in the "lib" directory of your Liquibase installation
    • Type: String
  • username (optional)
    • Type: String

step([$class: 'RawCliBuilder']): Liquibase: CLI Command

  • changeLogFile (optional)
    • Type: String
  • changeLogParameters (optional)
    • Type: String
  • commandArguments (optional)
    • Type: String
  • contexts (optional)
    Liquibase contexts to execute under.
    • Type: String
  • credentialsId (optional)
    • Type: String
  • installationName (optional)
    • Type: String
  • labels (optional)
    Liquibase labels to execute
    • Type: String
  • liquibasePropertiesPath (optional)
    A liquibase.properties file can be used for default values. Any of the below settings will override what is in this file. This file should be relative to a directory listed in the "Resource directories" section.
    • Type: String
  • password (optional)
    • Type: String
  • resourceDirectories (optional)
    Leave blank for workspace root. May be relative to workspace or an absolute path.
    • Type: String
  • url (optional)
    example: jdbc:mysql://localhost:3306/sampledb. The JDBC driver must be available in the "lib" directory of your Liquibase installation
    • Type: String
  • username (optional)
    • Type: String

step([$class: 'RollbackBuilder']): Liquibase: Roll Back Changes

  • changeLogFile (optional)
    • Type: String
  • changeLogParameters (optional)
    • Type: String
  • contexts (optional)
    Liquibase contexts to execute under.
    • Type: String
  • credentialsId (optional)
    • Type: String
  • installationName (optional)
    • Type: String
  • labels (optional)
    Liquibase labels to execute
    • Type: String
  • liquibasePropertiesPath (optional)
    A liquibase.properties file can be used for default values. Any of the below settings will override what is in this file. This file should be relative to a directory listed in the "Resource directories" section.
    • Type: String
  • numberOfChangesetsToRollback (optional)
    • Type: String
  • password (optional)
    • Type: String
  • resourceDirectories (optional)
    Leave blank for workspace root. May be relative to workspace or an absolute path.
    • Type: String
  • rollbackLastHours (optional)
    • Type: String
  • rollbackToDate (optional)
    • Type: String
  • rollbackToTag (optional)
    • Type: String
  • rollbackType (optional)
    • Type: String
  • url (optional)
    example: jdbc:mysql://localhost:3306/sampledb. The JDBC driver must be available in the "lib" directory of your Liquibase installation
    • Type: String
  • username (optional)
    • Type: String

step([$class: 'TagBuilder']): Liquibase: Tag Database

  • changeLogFile (optional)
    • Type: String
  • changeLogParameters (optional)
    • Type: String
  • contexts (optional)
    Liquibase contexts to execute under.
    • Type: String
  • credentialsId (optional)
    • Type: String
  • installationName (optional)
    • Type: String
  • labels (optional)
    Liquibase labels to execute
    • Type: String
  • liquibasePropertiesPath (optional)
    A liquibase.properties file can be used for default values. Any of the below settings will override what is in this file. This file should be relative to a directory listed in the "Resource directories" section.
    • Type: String
  • password (optional)
    • Type: String
  • resourceDirectories (optional)
    Leave blank for workspace root. May be relative to workspace or an absolute path.
    • Type: String
  • tag (optional)
    The tag to apply to the database. If the tag already exists, it will be moved the current datatabase state.

    If left empty, an auto-generated tag based on the build number will be applied
    • Type: String
  • url (optional)
    example: jdbc:mysql://localhost:3306/sampledb. The JDBC driver must be available in the "lib" directory of your Liquibase installation
    • Type: String
  • username (optional)
    • Type: String

step([$class: 'UpdateBuilder']): Liquibase: Update Database

  • changeLogFile (optional)
    • Type: String
  • changeLogParameters (optional)
    • Type: String
  • contexts (optional)
    Liquibase contexts to execute under.
    • Type: String
  • credentialsId (optional)
    • Type: String
  • installationName (optional)
    • Type: String
  • labels (optional)
    Liquibase labels to execute
    • Type: String
  • liquibasePropertiesPath (optional)
    A liquibase.properties file can be used for default values. Any of the below settings will override what is in this file. This file should be relative to a directory listed in the "Resource directories" section.
    • Type: String
  • password (optional)
    • Type: String
  • resourceDirectories (optional)
    Leave blank for workspace root. May be relative to workspace or an absolute path.
    • Type: String
  • url (optional)
    example: jdbc:mysql://localhost:3306/sampledb. The JDBC driver must be available in the "lib" directory of your Liquibase installation
    • Type: String
  • username (optional)
    • Type: String

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.