diff --git a/docs/cli/built-in-commands/update.md b/docs/cli/built-in-commands/update.md index 203c39a9..31e64dc8 100644 --- a/docs/cli/built-in-commands/update.md +++ b/docs/cli/built-in-commands/update.md @@ -31,3 +31,10 @@ Update -- Updates ExpressionEngine ## Examples: `php eecli.php update --verbose` + +## Related: `update:db` + +Use [`update:db`](cli/built-in-commands/update-db.md) when you need to run only database update steps. + +- `update` updates files and database. +- `update:db` updates only the database steps. diff --git a/docs/cli/intro.md b/docs/cli/intro.md index 53674a56..adce6b34 100644 --- a/docs/cli/intro.md +++ b/docs/cli/intro.md @@ -33,6 +33,7 @@ By default the CLI is located `system/ee/eecli.php` . - [sync:reindex - Sync content used in search indexes](cli/built-in-commands/sync-reindex.md) - [sync:upload-directory - Sync files in an upload directory](cli/built-in-commands/sync-upload-directory.md) - [Update ExpressionEngine](cli/built-in-commands/update.md) + - [update:db - Run database updates only](cli/built-in-commands/update-db.md) - [Creating a Command](cli/creating-a-command.md) - [Defining Input](cli/defining-input.md) - [Displaying Output](cli/displaying-output.md) diff --git a/docs/cli/usage.md b/docs/cli/usage.md index d2bdd21f..9acd8868 100644 --- a/docs/cli/usage.md +++ b/docs/cli/usage.md @@ -49,6 +49,7 @@ $ php system/ee/eecli.php list | hello | The most basic of commands | | list | Lists all available commands | | update | Updates ExpressionEngine | +| update:db | Runs ExpressionEngine database updates | | cache:clear | Clears all ExpressionEngine caches | ... ``` diff --git a/docs/installation/updating.md b/docs/installation/updating.md index a8d5fe43..1264003e 100755 --- a/docs/installation/updating.md +++ b/docs/installation/updating.md @@ -47,9 +47,13 @@ NOTE: **Website Online Status:** In some versions of ExpressionEngine the curren You can also update ExpressionEngine via the command line on your server. This allows you to keep your installation's files only writable by your user and not also by your web service. -To update via the [eecli](cli/intro.md) tool, run: +### Full update (files + database) - php eecli.php update +Use [`update`](cli/built-in-commands/update.md) when you need to update both files and database changes. + +Example: + + php eecli.php update --verbose #### Options @@ -58,6 +62,33 @@ To update via the [eecli](cli/intro.md) tool, run: - **force-addon-upgrades**: Automatically runs all addon updaters at end of update (advanced) - **y**: Skip all confirmations. (advanced) +### Database-only update + +Use [`update:db`](cli/built-in-commands/update-db.md) when files are already in place and you only need to run database update steps. + +Examples: + + php eecli.php update:db + + php eecli.php update:db --to-version=7.5.3 -y + +#### Options + +- **rollback**: Rollback last database update +- **verbose,v**: Verbose output +- **y**: Skip all confirmations. (advanced) +- **skip-cleanup**: Skip cleanup steps after update +- **to-version**: Target database version to upgrade to +- **from-version**: Starting database version to upgrade from + +#### Notes and caveats + +- `--to-version` cannot be greater than the installed app version. +- If the current database version is already at or above the target version, no update steps are run. +- If `--from-version` does not match the detected database version, a warning is shown. +- Rollback requires `system/user/cache/ee_update/database.sql` to exist. +- If you are running against a local installer payload, `EE_INSTALL_MODE` must be set to `TRUE` in `.env.php`. + ## Updating Manually TIP: **Feature Update:** diff --git a/docs/toc_sections/_advanced_usage_toc.yml b/docs/toc_sections/_advanced_usage_toc.yml index b6ff0261..f8c29c4d 100644 --- a/docs/toc_sections/_advanced_usage_toc.yml +++ b/docs/toc_sections/_advanced_usage_toc.yml @@ -698,6 +698,8 @@ href: cli/built-in-commands/sync-upload-directory.md - name: Update ExpressionEngine href: cli/built-in-commands/update.md + - name: Update Database + href: cli/built-in-commands/update-db.md - name: Version href: cli/built-in-commands/version.md - name: Widget Generator