S3

Liquibase integrates the use of Amazon S3 to store and retrieve data from anywhere. Extending Liquibase to use remote file locations enables secure, centralized file management. Liquibase files include changelogs, snapshots, SQL files, liquibase.properties files, native executor configuration files, checks settings configuration files, and flow files. Remote file location access allows you to build a reusable repository of Liquibase files. It also removes the need for all developers to have local copies of Liquibase files, which ensures files are always accurate.

Set up S3 with Liquibase

  1. Before using S3 in conjunction with Liquibase, you must configure your AWS keys via environment variables or AWS configuration files. That includes the following:
    • AWS_SECRET_ACCESS_KEY
    • AWS_ACCESS_KEY_ID
    • AWS_REGION
  2. Optional: After the AWS keys are set up, if you usually store your Liquibase Pro license key in a defaults file which you want to store on S3, you will need to set up your license in an environment variable, on the CLI, or in another standard property-setting method.
  3. Note: Note: A Liquibase Pro license key is needed to access remote S3 files. Therefore, the license key will not be accessible if only stored in a remote S3 defaults file. It is best practice to set up an environment variable that contains the key.

    Set the environment variable:

    LIQUIBASE_LICENSE_KEY=Enter Key Here

    Export the key in the CLI:

    export LIQUIBASE_LICENSE_KEY="Enter Key Here"

    Once the AWS keys and Liquibase Pro license key are configured, you are ready to begin using S3 with Liquibase.

Video: learn more about using remote files on S3

Related links