Overview
| Warning |
|---|
|
Unless your system experiences an error with the Horde data conversion process, do not use this script. |
The /usr/local/cpanel/scripts/horde_mysqltosqlite script transfers and converts Horde user data from a single shared MySQL® database to one-per-cPanel-user SQLite databases. The system executes this script when you upgrade from cPanel & WHM version 11.48 to cPanel & WHM version 11.50. For more information about how to troubleshoot problems with the migration process, read our How to troubleshoot Horde Data Conversion from MySQL to SQLite documentation.
| Note |
|---|
|
If the system experiences an error with the conversion process, it sends a notification to the contact details that you added in WHM's Basic WebHost Manager Setup interface (WHM >> Home >> Server Configuration >> Basic WebHost Manager Setup). |
Script behavior
This script processes the Horde database conversion in following order:
Creates a backup of the Horde MySQL database.
| Note |
|---|
|
- Retain this backup until you verify that the script successfully converted your Horde data.
- The backup of the Horde MySQL database only occurs if a backup of the database does not exist.
|
- Checks and repairs any Horde MySQL database schema problems.
- Converts the Horde user data from a single shared MySQL database to one-per-cPanel-user SQLite databases.
- Removes the Horde MySQL database.
Run the /usr/local/cpanel/scripts/horde_mysqltosqlite script
| Warning |
|---|
|
After the conversion process completes successfully, do not run this script. If you run this script after the data conversion process finishes, the script overwrites previously-converted data. |
To run the /usr/local/cpanel/scripts/horde_mysqltosqlite script from the command line as the root user, use the following format:
| Desired action | Command |
|---|
| Convert all users |
| Code Block |
|---|
| /usr/local/cpanel/scripts/horde_mysqltosqlite |
|
| Convert a single user |
| Code Block |
|---|
| /usr/local/cpanel/scripts/horde_mysqltosqlite --user [user] |
|
| Convert multiple users |
| Code Block |
|---|
| /usr/local/cpanel/scripts/horde_mysqltosqlite --user [user1] [users2] [user3] |
|
Exhaustive argument list
| Option | Description |
|---|
| Code Block |
|---|
| --user user1 [user2] [...] |
| Use this option to designate specific users to convert. | Warning |
|---|
| If you do not use this option, the script attempts to convert all users. |
|
| Code Block |
|---|
| --force-backup |
| Use this option to overwrite the MySQL database backup if a backup already exists. | Warning |
|---|
| Do not use this option unless you wish to overwrite a corrupt MySQL Horde database backup. |
|
| Use this option to skip the MySQL database backup during the conversion process.
|
| Use this option to run the script without the conversion process. | Note |
|---|
| You can use this option to perform the other functions of this script. For example, you can use this option to repair the Horde MySQL database. |
|
| Code Block |
|---|
| --no-fix-schema |
| Use this option to skip the script's Horde MySQL database schema repair function. |
| Use this option skip the Horde MySQL database removal at the end of the conversion. |
| Use this option to force the script to remove the Horde MySQL database when the conversion finishes. | Note |
|---|
| This script only removes the Horde MySQL database after a successful conversion of all Horde user data. |
| Warning |
|---|
| Only use this flag after you have converted all Horde user data. |
|
| Code Block |
|---|
| --replace-dest-db |
| Use this option to move the existing SQLite database and create a new one. | Note |
|---|
| - Use this option to reprocess a failed conversion for a single user.
- You can use this option with the
--user option to specify multiple users.
|
|
| Use this option to generate additional output details. |
| Use this option to show all of the available options for this script. |
Additional documentation
| Localtab Group |
|---|
| Localtab |
|---|
| active | true |
|---|
| title | Suggested documentation |
|---|
| | Content by Label |
|---|
| showLabels | false |
|---|
| max | 5 |
|---|
| showSpace | false |
|---|
| cql | label = "whm" and label in ("mysql","sqlite","horde","webmail") and space = currentSpace() |
|---|
|
|
| Localtab |
|---|
| | Content by Label |
|---|
| showLabels | false |
|---|
| max | 5 |
|---|
| showSpace | false |
|---|
| cql | label = "whm" and label in ("mysql","sqlite","horde","webmail") and space in ("DOC",currentSpace()) |
|---|
|
|
| Localtab |
|---|
| | Content by Label |
|---|
| showLabels | false |
|---|
| max | 5 |
|---|
| showSpace | false |
|---|
| cql | label = "whm" and label in ("mysql","sqlite","webmail","horde") and space in (currentSpace(),"DOC") |
|---|
|
|
| Localtab |
|---|
| | Content by Label |
|---|
| showLabels | false |
|---|
| max | 5 |
|---|
| showSpace | false |
|---|
| cql | label in ("mysql","sqlite","horde","webmail") and space = "DD" |
|---|
|
|
|