Skip to main content
Version: Release 25.1

Archive Database

Release stores completed releases and reporting metadata in a separate archive database. For more information about the archiving process, see How archiving works.

In the default setup, an embedded database is used, and data is stored in: XL_RELEASE_SERVER_HOME/archive/

Before You Begin​

  • You must configure the archive database before initializing the repository (that is, before starting Release for the first time).
  • Changing the database vendor or location after initialization is not supported.

Supported Databases​

You can use one of the following databases as the archive database:

DatabaseVersions Supported
Apache Derby (embedded)Deprecated
H2 (embedded)Included with Release
PostgreSQL (recommended)17.2 / 16.6
Oracle23ai LTS / 19c LTS
Microsoft SQL Server2022 (16.0) / 2019 (15.0)
MySQL8.4 LTS / 8.0 LTS

Configure the Archive Database​

To configure the archive database, update the configuration before initializing the Release repository:

  1. Ensure that the file XL_RELEASE_SERVER_HOME/conf/xl-release.conf exists.

  2. Add or update the database configuration. For example:

    xl {
      reporting {
        db-driver-classname = "com.mysql.jdbc.Driver"
        db-url = "jdbc:mysql://mysql-host.db:3306/archive?characterEncoding=UTF-8"
        db-username = "xlrelease"
        db-password = "s3cr3t"
      }
    }

  3. Ensure the JDBC driver is available:

    • Embedded database drivers are included with Release.
    • For MySQL or Oracle, add the appropriate JDBC driver to: XL_RELEASE_SERVER_HOME/plugins
    • Download drivers from the database vendor’s website.

Configure the Archive Database location​

You can change the archive database location by updating the db-url property in:

XL_RELEASE_SERVER_HOME/conf/xl-release.conf

Example:

xl {
  reporting {
    db-url = "<JDBC_URL>"
  }
}

MySQL-specific Configuration​

Increase Maximum Allowed Packet Size​

Release supports attachments up to 100 MB. To store large attachments, increase the max_allowed_packet setting in MySQL.

If not configured, the server may return "Packet Too Large" errors.

Use UTF-8 Character Set​

Release stores data in UTF-8. To support multibyte characters, configure one of the following:

  • Set the MySQL server option: character_set_server=utf8
  • Or include encoding in the JDBC URL: characterEncoding=UTF-8

For more information, see Character Sets and Collations in General.