User guide

Get the most out of your tools. From everyday tasks to advanced workflows, the User guide shows you how to work efficiently and effectively with our platform.

Changelogs

Introduction to Liquibase

What is a changelog?

Changelog examples

SQL changelog example

XML changelog example

JSON changelog example

YAML changelog example

Formatted Mongo changelog example

Changesets

What is a changeset?

When should I use context and label attributes?

What is a changeset checksum?

Liquibase concepts

What are attributes?

What are preconditions?

What is property substitution?

How does Liquibase find files?

What is the liquibase.properties file?

What are liquibase environment variables?

Use environment variables to control log level

Use environment variables in Docker

What are JAVA_OPTS environment variables?

How does Liquibase handle data types?

How do I manage an offline database?

How do I trim my changelog?

Assess logs to understand changelog efficiency

Working with UUIDs

How do I include and exclude database objects?

Run the include-objects attribute

Run the exclude-objects attribute

Generate a changelog with diff-types

What is drift detection?

Diff multiple schema in Liquibase

Generate SQL to update database schemas

What is stored logic?

How does Liquibase handle security?

What data does Liquibase collect and how is it used?

Tracking tables

What is the Databasechangelog table?

What is the Databasechangeloghistory table?

What is the Databasechangeloglock table?

Limitations

What are the COTS database limitations?

What are the memory limits on inspecting large schemas?

CI/CD Workflows

Use GitHub actions with Liquibase

Rollback

What is rollback?

Create custom rollback statements in Liquibase

What automatic rollbacks does Liquibase support?

What are targeted rollbacks?

Liquibase Flow files

What is a Flow file?

What are flow conditionals?

Use Shell commands in Flow files

Exit a Flow file

What is a Flow variable?

What are Advanced flow files?

Native executors

Configure changesets to use native executors

What are the benefits of using native executors?

Best practices when using native executors

Observability

What is Liquibase observability?

What are operation reports?

How do I enable operation reports?

What is the checks report?

Use drift reports in your CI/CD pipeline

What parameters can I use with operation reports?

What is the update report?

What is the rollback report?

Structured Logging

What is structured logging?

What are structured logging keys?

Enable structured logging

Analyze and use structured log data

Disable structured logging

What is custom data in structured logging?

Remote Files

What are the rules for remote file paths?

What are the rules for using search path with remote files?

What Liquibase commands are used for remote files?

Secrets management

What are Liquibase secrets management extensions?

What is the Liquibase Hashicorp Vault extension?

Use the Liquibase Hashicorp Vault extension

Policy checks

What are Policy checks?

Automatically create a snapshot and run checks

Manually create a snapshot and run checks

Run a Policy check

Customize a Policy check

Disable Policy checks

Filter checks table output

Use git-bash with Policy checks

Create a new checks settings file

Create an additional checks settings file

Use the checks settings files

Severity exit codes policy check automation

Set policy check severity and exit codes

What is a Policy checks JSON object?

Verify naming conventions in your database

What are Check chains?

Create a Check chain

Use your Check chain

Troubleshoot your Check chain

What are policy checks packages?

Create a checks package-file

Use the checks package file

What are Policy check package paths?

Custom policy checks

What are Liquibase Pro Custom policy checks?

Create a Custom policy check

Configure a Custom policy check

Implement Liquibase Pro Custom policy checks

What are some examples of Custom policy check scripts?

What are Liquibase Python modules?

Write dynamic status messages for Custom policy checks

What is Custom policy check property substitution?

Apply property substitution in Custom policy checks

Set up a custom Python virtual environment for Liquibase Policy checks

Use Custom policy checks with Docker

What default Policy checks does Liquibase offer?

What generic Changelog policy checks does Liquibase offer?

Custom policy checks library

Check Buffer Pool

Collection Camel Case

Collection Must Have Validator

Column Default Value

Create Index Count

Create Table Space

Current Schema Only

Delete Without Where

Identifiers Without Quotes

Index Different Tablespace

Table Column Disallow

Table Column Name Size

Table Name Camel Case

Table Names Uppercase

Timestamp Column Name

Varchar Data Integrity

Varchar Max Size

Varchar Preferred

Varchar2 Must Use Char

Regex Custom policy checks library

Crq Label Required

Enumeration List Context

MultipleCreateProceduresNotAllowed

MultipleCreateTablesNotAllowed

MultipleDropsNotAllowed

MultipleGrantsNotAllowed

NoDataDmlStatements

OnlySpecificSchemasAllowed

TablesMustHaveCreateTableOnly

TablesMustHavePkOrBeNamedNpk

UppercaseTableNames

viewsMustHaveCreateReplaceViewOnly

Cassandra Regex Custom policy checks library

CreateTableMustHaveIFNOTEXIST

CreateTableMustHavePrimaryKey

CreateTableMustHaveSystemKeyFile

MariaDB Regex Custom policy checks library

CannotModifyUsersOrRoles

PreventLockingColumnOrIndex

MongoDB Regex Custom policy checks library

mongoCrCollectionValidatorChk

mongoCrIndexNameStdChk

mongoCreateIdxWarning

mongoNoDeleteMany

mongoNoDropCollection

mongoNoDropIndex

mongoNoMergeAggregation

mongoNoRenameCollection

mongoNoUpdateMany

Oracle Regex Custom policy checks library

CreateTableMustHaveOneGrant

Create Table Must Have One Partition

Create Table Must Have Primary Key

Create Table No Compress Advanced

Create Table No Compress For

Create Table With Certain Column Requires Sequence

Create Table With Certain Column Requires Trigger

Execute Immediate Warning

No Delete Without Where

No Grant To Public

No Grant To System

No System Schema Changes

Snowflake Regex Custom policy checks library

Create Object Check

Create Table Must Have Data Retention

Database Name Not Allowed

Do Not Use QA Prod Databases

No Use Database

SQL Server Regex Custom policy checks library

Create Procedure Must Have Grant

Create Table Must Have Primary Key

No Alter Procedure

No Create Table

No Delete Without Where

No Grant Except Grant Execute

No Grant With Grant Option

No Open Data Source

No Open Row Set

Only Temp Table Drop Allowed

Changelog checks library

Change Drop Column Warn

Change Drop Table Warn

Changeset Attributes And Value

Changeset Attributes Set True Or False

Changeset Comment Check

Changeset Context Check

Changeset Label Check

Change Truncate Table Warn

Check Run In Transaction Value

Detect Change Type

DynamoChangetypeAttributes

End Delimiter Exists When Pattern Exists

Formatted Sql Header Required

Max Affected Rows Allowed Delete

Max Affected Rows Allowed Insert

Max Affected Rows Allowed Update

Modify Data Type Warn

MongoChangetypeAttributes

One Change Per Changeset

Primary Key On Create Table

Pattern a Followed By pattern b

Pattern a Preceded By pattern b

Patterna Not followed By pattern b

Pattern a Not preceded By pattern b

Require Changeset Id Is Uuid

Rollback Required

Sql Grant Admin Warn

Sql Grant Option Warn

Sql Grant Specific Privs Warn

Sql Revoke Warn

Sql Select Star Warn

Sql User Defined Pattern Check

User Defined Context Check

User Defined Label Check

Warn On Use Database

Changelog database checks library

Object Name Must Match

Object Name Must Not Match

Oracle Reserved Keywords

Postgres Nonreserved Keywords

Postgres Reserved Keywords

Sql Server Future Reserved Keywords

Sql Server Odbc Reserved Keywords

Sql Server Reserved Keywords

Table Column Limit

Table Comment Check

Table Comment Pattern Check

Database checks library

Check Tables For Index

Constraint Must Exist

User guide - Liquibase