diff options
| author | Bob Van Landuyt <bob@gitlab.com> | 2017-05-02 15:10:55 +0300 |
|---|---|---|
| committer | Bob Van Landuyt <bob@gitlab.com> | 2017-05-02 15:10:55 +0300 |
| commit | ffc486a58547b6984a44a43097183b34592be608 (patch) | |
| tree | 6c0a8efd917b1c6caf70af93592f0ffecfcf9bda | |
| parent | 29f200110245443454fd4358ed8c71ff8607fdd7 (diff) | |
Add some documentation for the new migration helpers
| -rw-r--r-- | doc/development/migration_style_guide.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/development/migration_style_guide.md b/doc/development/migration_style_guide.md index 3e8b709c18f..77ba2a5fd87 100644 --- a/doc/development/migration_style_guide.md +++ b/doc/development/migration_style_guide.md @@ -270,3 +270,28 @@ end When doing so be sure to explicitly set the model's table name so it's not derived from the class name or namespace. + +### Renaming reserved paths + +When a new route for projects is introduced that could conflict with any +existing records. The path for this records should be renamed, and the +related data should be moved on disk. + +Since we had to do this a few times already, there are now some helpers to help +with this. + +To use this you can include `Gitlab::Database::RenameReservedPathsMigration::V1` +in your migration. This will provide 3 methods which you can pass one or more +paths that need to be rejected. + +**`rename_root_paths`**: This will rename the path of all _namespaces_ with the +given name that don't have a `parent_id`. + +**`rename_child_paths`**: This will rename the path of all _namespaces_ with the +given name that have a `parent_id`. + +**`rename_wildcard_paths`**: This will rename the path of all _projects_, and all +_namespaces_ that have a `project_id`. + +The `path` column for these rows will be renamed to their previous value followed +by an integer. For example: `users` would turn into `users0` |