Check the database schema
This task is for administrators and developers after an upgrade, an extension update or a database move. At the end you know whether the database matches what Exponential and its active extensions expect. Reference: The upgrade check, section 6.
Contents
Before you start
- An administrator account.
- A recent backup (Take a backup before a change).
Steps
- Setup > Upgrade check (
/setup/systemupgrade). - Check database consistency. It compares the database with
share/db_schema.dbaand the schema files of active extensions. - Read the figures and the card per table; Download SQL for the record. The page never runs any SQL.
Reading the result
| Kind | Meaning | Do |
|---|---|---|
| Missing table | shipped with Exponential or an active extension, not in the database; the feature fails | run its CREATE statement after a backup |
| Changed table | fields or indexes differ | read each statement; those marked Removes something can remove data |
| Table not in the schema | an own extension's table, or one of a removed extension | leave it unless you know the data is not needed |
| Table of an extension that is not active | belongs to an installed, inactive extension | no SQL is written for it; activate or leave |
| Engine notes | differences the engine's schema handler writes no SQL for | nothing |
On MongoDB the check compares collections and offers the mongosh command for missing ones.
Applying SQL safely
- On staging first.
- One statement at a time, with the vendor's client.
- Run the check again: the table disappears from the findings.
- Note the statements in the change record.
Related pages
- Check upgrade consistency
- Upgrade overview for the public sector
- PHP and database upgrades
- Database support
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.