Use native executors with PostgreSQL
Last updated: July 23, 2025
This page describes how to use Liquibase with the PSQL native executor on a PostgreSQL database.
Before you begin
Use Liquibase 4.13.0 or later.
Add PSQL to your
PATH
environment variable. Alternatively, pass its location in theliquibase.psql.conf
file or from the command prompt during runtime. Seeliquibase.psql.path
in the PSQL integration arguments section.To use Liquibase and SQLCMD with Windows Integrated Security, follow the steps from Using Liquibase and MSSQL Server with Windows Integrated Security and proceed with the following instructions.
Setup
Liquibase searches the executor location in the following order: runtime arguments, .conf
file values, and then your PATH
.
1. Add the runWith
attribute to the needed changesets in the changelog:
SQL:
runWith:psql
XML:
runWith="psql"
YAML:
runWith: psql
JSON:
"runWith": "psql"
2. Specify the PSQL integration arguments in one of the following ways:
Pass the values at runtime on the command line.
Add the values to
liquibase.psql.conf
or the Liquibase properties file.Set the values as environment variables.
Run the values as Java system properties (
JAVA_OPTS
) along with any command at the command prompt:
Windows example:
set JAVA_OPTS=-Dliquibase.psql.<option>=<value> && liquibase <command> --changelog-file=my_script.sql
macOS & Linux example:
export JAVA_OPTS=-Dliquibase.psql.<option>=<value> && liquibase <command> --changelog-file=my_script.sql
3. Run a Liquibase command:
Example: liquibase status --changelog-file=my_script.sql
Note: If the command fails, you will receive an error message. However, if you add a property that is not used in Liquibase to the liquibase.psql.conf
file, no error occurs. Liquibase only ignores it.
PSQL integration arguments
Note: Syntax for each parameter is specified in kebab-case
(CLI and flow file), camelCase
(properties file and JAVA_OPTS
), and MACRO_CASE
(environment variable).
Syntax ( | Type | Description |
--psql-args liquibase.psql.args LIQUIBASE_PSQL_ARGS | String | Defines extra arguments to pass to the Note: The delimiter for arguments is a space |
--psql-keep-temp liquibase.psql.keep.temp LIQUIBASE_PSQL_KEEP_TEMP | Boolean | Indicates whether or not to keep a temporary SQL file after the execution of PSQL. If |
--psql-keep-temp-name liquibase.psql.keep.temp.name LIQUIBASE_PSQL_KEEP_TEMP_NAME | String | Indicates the name of a temporary SQL file after the execution of PSQL. If no file name is specified, a name is automatically generated. |
--psql-keep-temp-path liquibase.psql.keep.temp.path LIQUIBASE_PSQL_KEEP_TEMP_PATH | String | Specify the path in which to store the temporary files after the execution of PSQL. If not specified, the files will be stored in the system's |
--psql-log-file liquibase.psql.logFile LIQUIBASE_PSQL_LOG_FILE | String | Log file for PSQLoutput. |
--psql-path liquibase.psql.path LIQUIBASE_PSQL_PATH | String | Path to Linux: Windows: |
--psql-timeout liquibase.psql.timeout LIQUIBASE_PSQL_TIMEOUT | Integer | Indicates seconds to wait for the |
runWith and psql examples
--liquibase formatted sql
--changeset myauthorname:2314 runWith:psql
DECLARE l_emp_name VARCHAR2(250);
l_emp_no NUMBER;
l_salary NUMBER;
l_manager VARCHAR2(250);
BEGIN
INSERT INTO emp(emp_name,emp_no,salary,manager) VALUES('BBB',1000,25000,'AAA');
...
END;
/
Best practices
Do not set the
endDelimiter
orsplitStatements=true
property on PSQL changesets. PSQLhandles delimiters and statement splitting natively. Prevent hanging queries by configuring the timeout. In your
liquibase.psql.config
file, addliquibase.psql.timeout=nn
, wherenn
is time in seconds to wait before stopping the process.Save the output of your spool files to your temp directory by adding
liquibase.
psql.keep.temp=true
to theliquibase.psql.conf
file.
Example liquibase.psql.conf file
# The full path to the psql executable.
# Sample Linux path
# liquibase.psql.path=/usr/local/bin/psql
# Sample Windows path
# liquibase.psql.path="C:\\Program Files\\PostgreSQL\\<version>\\bin\\psql.exe"
# Timeout value for the execution of the psql tool
# Measured in seconds. -1 to disable.
liquibase.psql.timeout=-1
# Flag to indicate whether or not to keep the temporary SQL file after execution of psql.
# True = keep False = delete (default)
liquibase.psql.keep.temp=false
# OPTIONAL Flag to designate the location to store temporary SQL file after execution of psql.
# Liquibase will attempt to use path exactly as entered, so please ensure it complies with your OS requirements.
# liquibase.psql.keep.temp.path=
# OPTIONAL Flag to designate the name of temporary SQL file after execution of psql.
# Liquibase will attempt to use the name exactly as entered, so please ensure it complies with your OS requirements.
# liquibase.psql.keep.temp.name=
# OPTIONAL Args to pass directly to psql.
# Note: The delimiter for args is a space eg:" " and not "," or ";" separated.
# liquibase.psql.args=
# OPTIONAL Path to a log file for the psql output
# liquibase.psql.logFile=