Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

docs: remove db secrets export from serialization docs (#80114)

Michael Eby50568b4841e3
diff --git a/docs/installation-and-operation/serialization.md b/docs/installation-and-operation/serialization.md
index 74b9ef0a063..c8c1c208a14 100644
--- a/docs/installation-and-operation/serialization.md
+++ b/docs/installation-and-operation/serialization.md
@@ -69,7 +69,6 @@ Metabase will only export the following entities:
- Notification channels (email and webhook destinations used by alerts and subscriptions)
- Metabot configuration (AI assistant settings and prompts)
- Python libraries (shared Python modules used by transforms)
-- Database connection strings (only if specified through the [Include database connection details](#include-database-connection-details) option)
All other entities—including users, groups, permissions, alerts, subscriptions, document comments—won't get exported. Those entities are tied to user accounts, and therefore aren't portable between Metabases.
@@ -161,7 +160,7 @@ unaggregated-query-row-limit
### Customize what gets exported
-You can customize what gets exported — select specific collections, exclude settings or the data model, include field values or database connection details, and more. The same options are available through both the CLI and the API; only the syntax differs.
+You can customize what gets exported — select specific collections, exclude settings or the data model, include field values, and more. The same options are available through both the CLI and the API; only the syntax differs.
See [Export options](#export-options) for the full list.
@@ -216,7 +215,7 @@ A high-level workflow for using Entity IDs when embedding Metabase in your app w
### Databases, schemas, tables, and fields are identified by name
-By default, Metabase exports some database and data model settings. Exports exclude database connection strings by default. You can [explicitly include database connection strings](#include-database-connection-details). You can also choose to exclude the data model entirely.
+By default, Metabase exports some database and data model settings. Exports exclude database connection strings. You can also choose to exclude the data model entirely.
Metabase serializes databases and tables in the `databases` directory. It will include YAML files for every database, table, field, segment, and metric.
@@ -320,17 +319,6 @@ Default: Field values are excluded.
Includes sample values for fields, which Metabase uses to present dropdown menus. Excluded by default to keep exports compact.
-### Include database connection details
-
-- **CLI:** `-s, --include-database-secrets`
-- **API:** `database_secrets=true`
-
-Type: Boolean.
-
-Default: Database connection details are excluded.
-
-Includes database connection details (including the database username and password) in plain text. Use with caution. If you don't include this option, you'll need to manually input the credentials in the target Metabase.
-
### Output directory name
- **CLI:** positional argument (required): `export <dir_name>`
@@ -605,7 +593,6 @@ Your databases must have the same engine, and ideally they should have the same
You'll need to keep in mind:
- Databases, tables and fields are [referred to in Metabase by name](#databases-schemas-tables-and-fields-are-identified-by-name)
-- Database connection details are not exported by default. To export database connection details, you'll need to enable the [Include database connection details](#include-database-connection-details) option.
- Databases, tables and fields referenced by an item should either already exist in the target Metabase, or be included in the import.
For example, if you want to switch all questions in the `Movie reviews` collection to use the `Romance` database instead of the `Horror` database, and _both databases have the same schema_, you could follow a process like this: