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
Formatted Mongo changelog example
Changesets
When should I use context and label attributes?
Liquibase concepts
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?
Assess logs to understand changelog efficiency
How do I include and exclude database objects?
Run the include-objects attribute
Run the exclude-objects attribute
Generate a changelog with diff-types
Diff multiple schema in Liquibase
Generate SQL to update database schemas
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
Create custom rollback statements in Liquibase
What automatic rollbacks does Liquibase support?
Liquibase Flow files
Use Shell commands in 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?
How do I enable operation reports?
Use drift reports in your CI/CD pipeline
What parameters can I use with operation reports?
Structured Logging
What are structured logging keys?
Analyze and use structured log data
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
Automatically create a snapshot and run checks
Manually create a snapshot and run checks
Use git-bash with Policy checks
Create a new checks settings file
Create an additional checks settings file
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 policy checks packages?
What are Policy check package paths?
Custom policy checks
What are Liquibase Pro Custom policy checks?
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
Collection Must Have Validator
Regex Custom policy checks library
MultipleCreateProceduresNotAllowed
MultipleCreateTablesNotAllowed
viewsMustHaveCreateReplaceViewOnly
Cassandra Regex Custom policy checks library
CreateTableMustHaveSystemKeyFile
MariaDB Regex Custom policy checks library
MongoDB Regex Custom policy checks library
Oracle Regex Custom policy checks library
Create Table Must Have One Partition
Create Table Must Have Primary Key
Create Table No Compress Advanced
Create Table With Certain Column Requires Sequence
Create Table With Certain Column Requires Trigger
Snowflake Regex Custom policy checks library
Create Table Must Have Data Retention
SQL Server Regex Custom policy checks library
Create Procedure Must Have Grant
Create Table Must Have Primary Key
Changelog checks library
Changeset Attributes And Value
Changeset Attributes Set True Or False
Check Run In Transaction Value
End Delimiter Exists When Pattern Exists
Max Affected Rows Allowed Delete
Max Affected Rows Allowed Insert
Max Affected Rows Allowed Update
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
Sql User Defined Pattern Check
Changelog database checks library
Sql Server Future Reserved Keywords
Sql Server Odbc Reserved Keywords