includeAll

Use the includeAll tag to specify a directory that contains multiple changelog files. It is used within your root changelog file to call on the directory and include all XML, YAML, and JSON files as changelog files, and all SQL files as individual changes. If you use includeAll to specify a directory that contains subdirectories, the tag also includes all files in those subdirectories.

Uses

In Liquibase, you can break up your root changelog into more manageable pieces by creating multiple changelogs to separate your changesets in a way that makes sense for you. For example, you can separate changesets into their own files, according to features, releases, or other logical boundaries. Breaking up your changelogs can make it easier to find and manage complex database schema scripts.

If you store all of your changelog files in one directory, you can use the <includeAll> tag to reference the directory containing those files. Alternatively, you can use <includeAll> to reference a single directory containing multiple subdirectories that store all your changelog files.

For more guidance on structuring your changelogs, see Design Your Liquibase Project.

How to use the includeAll tag

1. Create a root changelog file. The root changelog file works as a configuration file that holds all the references to other directories.

Note: Your root changelog can be an XML, YAML, or JSON file. In Liquibase Pro 4.28.0+, your root changelog can also be a SQL file. However, your root changelog cannot be a formatted Mongo (JS) file.

2. In your root changelog, add the <includeAll> tag with a path to the directory you want to include.

Note: Your changelogs inside of the directory you include can be SQL, XML, YAML, or JSON files. If you use the Liquibase MongoDB Pro 1.3.0+, you can also include formatted Mongo changelogs as JS files.

• SQL example
• YAML example
• JSON example
• XML example

--liquibase formatted sql

--includeAll path:com/example/changelogs/
--includeAll path:liquibase/parser/core/yaml/included/

Note: includeAll is only supported for formatted SQL changelogs in Liquibase Pro 4.28.0 and later.

databaseChangeLog:
 - includeAll:
     path: com/example/changelogs/
 - includeAll:
     path: liquibase/parser/core/yaml/included/

{
    "databaseChangeLog": [
        {
            "includeAll": {
                "path": "com/example/changelogs/"
            }
        },
        {
            "includeAll": {
                "path": "liquibase/parser/core/yaml/included/"
            }
        }
    ]
}

<databaseChangeLog
    xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
    xmlns:pro="http://www.liquibase.org/xml/ns/pro"
    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
        http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd
        http://www.liquibase.org/xml/ns/dbchangelog-ext
        http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd
        http://www.liquibase.org/xml/ns/pro
        http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd">

	<includeAll path="com/example/changelogs/"/>
	<includeAll path="liquibase/parser/core/yaml/included/"/>

</databaseChangeLog>

How the includeAll tag runs in a changelog

All files inside of the included directory are run in alphabetical order.

If you use the includeAll tag, enforce a naming strategy to prevent conflicts and the need to rename and reorder files.

Infinite loops in changelogs

By default, Liquibase checks for looping changelogs in your root file. If you create a changelog loop like the following, you will get an infinite loop, which will prevent the operation from completing:

Example: root.changelog.xml includes the path com/example/changelogs/ which includes a changelog changelogloop.xml which includes root.changelog.xml.

Make sure to avoid infinite loops when referencing directories.

If you create an infinite loop, Liquibase will display the following error:

Unexpected error running Liquibase: Circular reference detected in 'com/example/changelogs/'. Set liquibase.errorOnCircularIncludeAll if you'd like to ignore this error.

It is a best practice to leave the error-on-circular-include-all argument at its default setting of true in order to avoid a StackOverflowError.

Available attributes

root
    changelog.xml
    packages
        my_pkg_1.apple.sql
        my_pkg_1.orange.sql
        my_pkg_2.apple.sql
        my_pkg_2.orange.sql

Related links

• include
• Changelog