From 411d4b20f24164f6495096030c9dbddcb368fe1f Mon Sep 17 00:00:00 2001 From: Jeff Bruemmer <jeff.bruemmer@gmail.com> Date: Wed, 16 Aug 2023 13:04:39 -0400 Subject: [PATCH] docs - serialization migration note (#32414) * migration note * note about same version --- .../serialization.md | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/installation-and-operation/serialization.md b/docs/installation-and-operation/serialization.md index 25eb83478f7..c137d9ca626 100644 --- a/docs/installation-and-operation/serialization.md +++ b/docs/installation-and-operation/serialization.md @@ -269,6 +269,26 @@ custom-formatting For more on Metabase settings, see [Configuring Metabase](../configuring-metabase/start.md) +## Migrating from the old serialization commands + +If you're upgrading from Metabase version 46.X or older, here's what you need to know: + +- The `export` command replaces the `dump` command. +- The `import` command replace the `load` command. + +A few other changes to call out: + +- The exported YAML files have a slightly different structure: + - Metabase will prefix each file with a 24-character entity ID (like `IA96oUzmUbYfNFl0GzhRj_accounts_model.yaml`). + - The file tree is slightly different. +- To serialize personal collections, you just need to include the personal collection IDs in the list of comma-separated IDs following the `-c` option (short for `--collection`). + +If you've written scripts to automate serialization, you'll need to: + +- Reserialize your Metabase using the upgraded Metabase (which uses the new `export` and `import` commands). Note that serialization will only work if you export and import your Metabase using the same Metabase version. +- Update those scripts with the new commands. See the new [export options](#export-options). +- If your scripts do any post-processing of the exported YAML files, you may need to update your scripts to accommodate the slightly different directory and YAML file structures. + ## Further reading - [Serialization tutorial](https://www.metabase.com/learn/administration/serialization). -- GitLab