Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:upgradedatabase

Upgrade stage 3, database: the schema and data steps on every engine (dry run unless --apply).

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/commands/upgradedatabase.md

On this page

exp:upgradedatabase

Upgrade stage 3, database: the schema and data steps on every engine (dry run unless --apply).

Script bin/php/upgradedatabase.php, code in kernel/private/classes/commands/upgradedatabase.php. Run it from the installation root, as the user the web server runs as:

./console exp:upgradedatabase --help
./console exp:upgrade:database --help
php bin/php/upgradedatabase.php --help

Help text

Upgrade stage 3: the database
The tables, columns, indexes and rows the release needs, on MySQL/MariaDB, PostgreSQL, SQLite,
Oracle (ezoracle) and MongoDB, written from the kernel schema (share/db_schema.dba). Each step
looks at the database first, so what the SQL update files already did counts. Dry run unless
--apply.

./console exp:upgrade:database
./console exp:upgrade:database --apply
./console exp:upgrade:database --apply --only=6.0.15-user-audit-table
Guide: doc/eng-us/guides/upgrading-with-the-console.md

Options

OptionValueHelp
--applyMake the changes (the default is a dry run that lists them and changes nothing)
--dry-runThe default, accepted for scripts that pass it: list what would change, change nothing
--onlyrequiredOnly these steps (step ids, a comma list or repeated); an optional step runs only when named here
--skiprequiredNever these steps (step ids, a comma list or repeated)
--formatrequiredtext (default) or json (the machine output exp-upgrade/1)
--no-backupWrite without making a backup first
--backup-dirrequiredWhere the backup goes (default var/backup/upgrade); a directory <time> is made in it
--force-orderRun a stage although an earlier stage has pending steps
--fail-on-pendingExit 1 when steps are still pending (for CI)
--force-no-backupWith --no-backup on a production installation: write without a backup all the same
--no-captionWrite without taking a caption first (the same as --no-backup); refused on production without --force-no-caption
--force-no-captionWith --no-caption on a production installation: write without a caption all the same

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).


Generated by ./console exp:help:examples from bin/php/upgradedatabase.php, kernel/private/classes/commands/upgradedatabase.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x