Database Backup

Last Updated: Dec 2, 2022
documentation for the dotCMS Content Management System

⚠️ Note: For dotCMS instances of version 22.02 or later using PostgreSQL, there is a simple method to create a database backup through the admin panel. The content below applies to prior versions, or those using MSSQL.

⚠️ Please also note that support has been discontinued for MySQL and Oracle. This tool can simplify the migration from MySQL to PostgreSQL. It is believed to work in most cases, though it has not been tested with significantly old versions of the software. We still recommend, as always, that you make backups before performing any major operation on a database.

It is highly recommendeded that you perform periodic backups of the dotCMS database, and all important dotCMS files. For more information on files which need to be backed up, please see the Backup and Restore documentation.

Database Backup Procedure

It is important that you shut down dotCMS before backing up your database, to ensure that:

  • All database objects are properly backed up
  • All database objects are properly synchronized with related objects
  • Backup processes do not interfere with database access by dotCMS

You may use the following basic procedure to back up your database.

1. Shut down dotCMS

Run the dotCMS shutdown script to stop dotCMS

  • Linux:      /bin/
  • Windows: /bin/shutdown.bat
2. Back Up Your Database

Back up your database using the backup tools provided by your database vendor. For more information on how to back up your database, please click the appropriate link below to see the vendor documentation:

  • PostgreSQL
  • Microsoft SQL Server
  • MySQL (No longer supported)
    • Important Note: When backing up and restoring a MySQL database, make sure to include the --routines flag to include the stored procedures.
  • Oracle (No longer supported)

Note: The H2 database shipped with dotCMS is intended for demonstration and evaluation purposes only. Therefore dotCMS does not support database backup for the H2 database.

3. Backup Important dotCMS Files

In addition to database backup, it is also highly recommended that you periodically back up several important files in your dotCMS installation. For more information on performing a full backup of dotCMS, please see the Back Up and Restore documentation.

4. Restart dotCMS.


On this page


We Dig Feedback

Selected excerpt: