Skip to content

Liquibase - Process Steps

GenerateDBDoc

Execute Liquibase in dbDoc mode to produce or update database reference documentation.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to use.Yes
docOutDirtextBoxPath to directory for output of dbDocs commandYes

Update

Applies given count of change sets is specified. Else updates database to current version.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to use.Yes
updateCounttextBoxNumber of change sets to be applied.Yes
previewcheckBoxIf true, update script will be printed but not applied.Yes

GenerateChangelog

Generates change log of the database.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to be generated.Yes

Export Data

Generates change log of the database.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to be generated.Yes

ChangelogSync

Mark all changes as executed in the database.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to use.Yes

Rollback

Rolls back change sets.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to use.Yes
rollbackTypeselectBoxIt is possible to rollback to specific date, tag or by given number of changesets.Yes
rollbackValuetextBoxNumber of changesets/Date ('yyyy-MM-dd'T'HH:mm:ss')/Tag depending on rollback type selected.Yes
previewcheckBoxIf true, rollback script will be printed but not applied.Yes

UpdateTestingRollback

Updates the database, then rolls back changes before updating again.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to use.Yes

Tag

"Tags" the current database state for future rollback.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to use.Yes
tagtextBoxTag to use.Yes

Validate

Checks the changelog for errors.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to use.Yes

DropAll

Drops all database objects owned by the user.

NameTypeDescriptionRequired
commandtextBoxPath to liquibase binary.Yes
drivertextBoxDatabase driver class name.Yes
driverClasspathtextBoxClasspath containing migration files and JDBC Driver.Yes
jdbcURLtextBoxDatabase JDBC URL.Yes
usernametextBoxDatabase usernameYes
passwordsecureBoxPassword for given username.Yes
changeLogFiletextBoxThe changelog file to use.Yes