Support

Documentation

The databaseInfo section

Required: Yes; this section is mandatory

Scope: UNITE needs to know how to connect to your MySQL database so that it can restore the database(s) dumped during backup time. The databaseInfo section does exactly that. It takes one <database> section per database to restore.

Each <database> section tag has a name attribute which corresponds to the base name of the database SQL dump file. For the main database of your site the value of the name attribute needs to always be site:

<database name="site">
  <!-- Database options go here -->
</database>

The extra databases are dumped using short UUID's as their base name which typically look like ABCD123-databasename.sql. In this case, the name attribute needs to be the base name of the dump file, i.e. ABCD123-databasename in this example.

The best way to figure out which database is dumped under which name is to take a look at the databases.ini file in the installation/sql directory inside the archive. To do that, simply take one backup of the site and extract it using Kickstart on a secondary server or your computer, without clicking on the Run the Installer button. Then, navigate to the extracted installation/sql directory and open the databases.json file in your text editor. Each top level key is the base name of a dump file. You can use that as your “cheat sheet” when creating the <database> sections of the <databaseInfo> tag for UNiTE.

Each <database> tag can contain the tags you see in the database options reference.