diff --git a/learn/update_and_migration/updating.mdx b/learn/update_and_migration/updating.mdx index d2fd3be50..39142aabe 100644 --- a/learn/update_and_migration/updating.mdx +++ b/learn/update_and_migration/updating.mdx @@ -47,9 +47,9 @@ Once the project has been successfully updated, you will receive an email confir ## Updating a self-hosted Meilisearch instance - You may update a self-hosted instance in one of two ways: with or without a dump. + This guide only works for v0.15 and above. If you are using an older Meilisearch release, please [contact support](https://discord.meilisearch.com) for more information. @@ -156,9 +156,21 @@ Meilisearch should launch normally and immediately create a new `UpgradeDatabase While the task is processing, you may continue making search queries. You may also enqueue new tasks. Meilisearch will only process new tasks once `UpgradeDatabase` is completed. - -If after the upgrade is completed the task status is set to `failed` or Meilisearch returns internal error messages to your queries, [restart your instance from the snapshot](/learn/data_backup/snapshots#starting-from-a-snapshot) you generated during step 1. You may then retry the upgrade, or upgrade using a dump. You are also welcome to open an issue on the [Meilisearch repository](https://github.com/meilisearch/meilisearch). - +#### Rolling back an update + +If the upgrade is taking too long, or if after the upgrade is completed its task status is set to `failed`, you can cancel the upgrade task. + +Cancelling the update task to automatically rolls back your database to its state before the upgrade began. + +After launching Meilisearch with `--experimental-dumpless-upgrade` flag: + +1. Cancel the `databaseUpgrade` task +2. If you cancelled the update before it failed, skip to the next step. If the update failed, relaunch Meilisearch using the binary of the version you were upgrading to +3. Wait for the cancel request to be processed +4. Replace the new binary with the binary of the previous version +5. Relaunch Meilisearch + +If you are upgrading Meilisearch to <= v1.14, you must instead [restart your instance from the snapshot](/learn/data_backup/snapshots#starting-from-a-snapshot) you generated during step 1. You may then retry the upgrade, or upgrade using a dump. You are also welcome to open an issue on the [Meilisearch repository](https://github.com/meilisearch/meilisearch). ### Using a dump @@ -505,6 +517,10 @@ rm /var/opt/meilisearch/dumps/{dump_uid.dump} +## Cancel an update + +If a Meilisearch update fails or takes too long, depending on your version you can either cancel the update task and automatically roll back to an earlier version of your database, or import a backup snapshot. + ## Version-specific warnings After migrating to the most recent version of Meilisearch, your code-base may require some changes. This section contains warnings for some of the most impactful version-specific changes. For full changelogs, see the [releases tab on GitHub](https://github.com/meilisearch/meilisearch/releases). diff --git a/reference/api/tasks.mdx b/reference/api/tasks.mdx index 56121cd13..35cc86e90 100644 --- a/reference/api/tasks.mdx +++ b/reference/api/tasks.mdx @@ -74,7 +74,7 @@ This value is always `null` for [global tasks](/learn/async/asynchronous_operati ### `type` **Type**: String
-**Description**: Type of operation performed by the task. Possible values are `indexCreation`, `indexUpdate`, `indexDeletion`, `indexSwap`, `documentAdditionOrUpdate`, `documentDeletion`, `settingsUpdate`, `dumpCreation`, `taskCancelation`, `taskDeletion`, and `snapshotCreation` +**Description**: Type of operation performed by the task. Possible values are `indexCreation`, `indexUpdate`, `indexDeletion`, `indexSwap`, `documentAdditionOrUpdate`, `documentDeletion`, `settingsUpdate`, `dumpCreation`, `taskCancelation`, `taskDeletion`, `databaseUpgrade`, `documentEdition`, and `snapshotCreation` ### `canceledBy`