@@ -16,11 +16,9 @@ Metabase will print out the help text for available commands.
Generate a markdown file containing documentation for all API endpoints. This is written to a file called `docs/api-documentation.md`.
## `driver-methods`
## `driver-methods` | `driver-methods _docs`
Or `driver-methods _docs`.
Print a list of all multimethods available for a driver to implement, optionally with their docstrings.
Print a list of all multimethods available for a driver to implement. Add `_docs` to include their docstrings.
## `drop-entity-ids`
...
...
@@ -28,29 +26,28 @@ Drop entity IDs for instances of serializable models. Useful for migrating from
## `dump path & options`
> This command is deprecated. Use `export` instead.
**Note: this command is deprecated. Use `export` instead.**
Serializes Metabase instance into directory `path`.
**Options:**
`-u`, `--user EMAIL` Export collections owned by the specified user
Options:
`-s`, `--state (active|all) all` When set to `active`, do not dump archived entities. Default behavior is `all`.
-`-u, --user EMAIL` - Export collections owned by the specified user
-`-s, --state (active|all)` - When set to `active`, do not dump archived entities. Default behavior is `all`
-`--include-entity-id` - Include entity_id property in all dumped entities. Default: false
## `dump-to-h2 h2-filename & opts`
Transfer data from existing database to newly created H2 DB with specified filename. Target H2 file is deleted before dump, unless the --keep-existing flag is given.
**Options:**
`-k`, `--keep-existing` Do not delete target H2 file if it exists.
Options:
`-p`, `--dump-plaintext` Do not encrypt dumped contents.
-`-k, --keep-existing` - Do not delete target H2 file if it exists
-`-p, --dump-plaintext` - Do not encrypt dumped contents
## `environment-variables-documentation`
Generates a markdown file containing documentation for environment variables relevant to configuring Metabase. The command only includes environment variables registered as defsettings. For a full list of environment variables, see [Environment variables](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables).
Generates a markdown file containing documentation for environment variables relevant to configuring Metabase. The command only includes environment variables registered as defsettings. For a full list of environment variables, see https://www.metabase.com/docs/latest/configuring-metabase/environment-variables.
## `export path & options`
...
...
@@ -58,53 +55,50 @@ Generates a markdown file containing documentation for environment variables rel
Serialize Metabase instance into directory at `path`.
**Options:**
`-c`, `--collection ID` Export only specified ID(s). Use commas to separate multiple IDs.
`-C`, `--no-collections` Do not export any content in collections.
`-S`, `--no-settings` Do not export settings.yaml
Options:
`-D`, `--no-data-model` Do not export any data model entities; useful for subsequent exports.
-`-c, --collection ID` - Export only specified ID(s). Use commas to separate multiple IDs. You can pass entity ids with `eid:<...>` as a prefix
-`-C, --no-collections` - Do not export any content in collections
-`-S, --no-settings` - Do not export settings.yaml
-`-D, --no-data-model` - Do not export any data model entities; useful for subsequent exports
-`-f, --include-field-values` - Include field values along with field metadata
-`-s, --include-database-secrets` - Include database connection details (in plain text; use caution)
-`-e, --continue-on-error` - Do not break execution on errors
-`--full-stacktrace` - Output full stacktraces on errors
`-f`, `--include-field-values` Include field values along with field metadata.
## `help command-name` | `help`
`-s`, `--include-database-secrets` Include database connection details (in plain text; use caution).
## `help`
Show this help message listing valid Metabase commands.
Show this help message listing valid Metabase commands. Use `help command-name` for specific command details.
## `import path & options`
{% include plans-blockquote.html feature="Serialization" self-hosted-only="true" %}
Load serialized Metabase instance as created by the export command from directory `path`. Has no options.
Load serialized Metabase instance as created by the `export` command from directory `path`.
## `load path & options`
Options:
> This command is deprecated. Use `import` instead.
-`-e, --continue-on-error` - Do not break execution on errors
-`--full-stacktrace` - Output full stacktraces on errors
Load serialized Metabase instance as created by [[dump]] command from directory `path`.
## `load path & options`
**Options:**
**Note: this command is deprecated. Use `import` instead.**
`-m`, `--mode (skip|update) skip` Update or skip on conflicts.
Load serialized Metabase instance as created by `dump` command from directory `path`.
`-e`, `--on-error (continue|abort)` continue Abort or continue on error.
Options:
## `load-from-h2`
-`-m, --mode (skip|update)` - Update or skip on conflicts. Default: skip
-`-e, --on-error (continue|abort)` - Abort or continue on error. Default: continue
Transfer data from existing H2 database to the newly created MySQL or Postgres DB specified by env vars.
Transfer data from existing H2 database to the newly created MySQL or Postgres DB specified by env vars.
## `migrate down`
## `migrate direction`
Used for downgrading versions.
Run database migrations. Valid options for `direction` are `up`, `force`, `down`, `print`, or `release-locks`.
## `profile`
...
...
@@ -116,8 +110,22 @@ Reset the password for a user with `email-address`.
## `rotate-encryption-key new-key`
Rotate the encryption key of a Metabase database. The `MB_ENCRYPTION_SECRET_KEY` environment variable has to be set to the current key, and the parameter `new-key` has to be the new key. `new-key` has to be at least 16 chars.
Rotate the encryption key of a metabase database. The MB_ENCRYPTION_SECRET_KEY environment variable has to be set to the current key, and the parameter `new-key` has to be the new key. `new-key` has to be at least 16 chars.
## `seed-entity-ids`
Add entity IDs for instances of serializable models that don't already have them.
## `version`
Print version information about Metabase and the current system.
Jeff Bruemmer <jeff.bruemmer@gmail.com>