From 0a6096a1bb51aac8fc6576615b093cc7be2bc5c5 Mon Sep 17 00:00:00 2001 From: Ingo Schommer Date: Fri, 21 Jun 2019 08:47:40 +1200 Subject: [PATCH] DOCS File migration background notes (#9058) --- docs/en/02_Developer_Guides/14_Files/05_File_Migration.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/en/02_Developer_Guides/14_Files/05_File_Migration.md b/docs/en/02_Developer_Guides/14_Files/05_File_Migration.md index 2d4159056..e409a1b0c 100644 --- a/docs/en/02_Developer_Guides/14_Files/05_File_Migration.md +++ b/docs/en/02_Developer_Guides/14_Files/05_File_Migration.md @@ -42,7 +42,13 @@ When executing the task on CLI, you'll get colour coded error messages. ## Background migration through the Queuedjobs module +In general, it's safest to run the file migration on a non-production environment, +and switch over to the migrated assets and new database. That's not always feasible. You can also run this task without CLI access through the [queuedjobs](https://github.com/symbiote/silverstripe-queuedjobs) module. +Due to the incremental nature of this migration, you need to consider how a partially migrated database +and asset store will impact your own site's behaviour, or how you can recover from migration errors. +When running a background migration in production, we recommend to put your site in maintenance mode to avoid inconsistent behaviour. + Open up `admin/queuedjobs`, then create a job of type `RunBuildTaskJob`. The only constructor parameter allowed is the full name of the task: `SilverStripe\Dev\Tasks\MigrateFileTask`. The task output will be progressively written to the job record, and can be inspected via the "Messages" tab within the job in the CMS.