Skip to content

[nightly] release-x.57.x -> release-x.57.x #823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-automation-metabase merged 1 commit into from
Nov 26, 2025
Merged

[nightly] release-x.57.x -> release-x.57.x #823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 73 additions & 25 deletions _docs/latest/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9695,6 +9695,7 @@
"description" : "Server error response"
}
},
"deprecated" : true,
"tags" : [ "/api/activity" ]
}
},
Expand Down Expand Up @@ -11161,9 +11162,15 @@
"$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
},
"collection_id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
"anyOf" : [ {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}, {
"description" : "String must be a valid 21-character NanoID string.",
"type" : "string",
"pattern" : "^[A-Za-z0-9_\\-]{21}$"
} ]
},
"cache_ttl" : {
"description" : "value must be an integer greater than zero.",
Expand Down Expand Up @@ -13091,6 +13098,7 @@
"description" : "Server error response"
}
},
"deprecated" : true,
"tags" : [ "/api/dashboard" ]
},
"post" : {
Expand Down Expand Up @@ -16183,6 +16191,44 @@
"tags" : [ "/api/ee/billing" ]
}
},
"/api/ee/cloud-add-ons/addons" : {
"get" : {
"summary" : "GET /api/ee/cloud-add-ons/addons",
"description" : "Get addons information from the Metabase Store API.",
"parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
},
"5XX" : {
"description" : "Server error response"
}
},
"tags" : [ "/api/ee/cloud-add-ons" ]
}
},
"/api/ee/cloud-add-ons/plans" : {
"get" : {
"summary" : "GET /api/ee/cloud-add-ons/plans",
"description" : "Get plans information from the Metabase Store API.",
"parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
},
"5XX" : {
"description" : "Server error response"
}
},
"tags" : [ "/api/ee/cloud-add-ons" ]
}
},
"/api/ee/cloud-add-ons/{product-type}" : {
"post" : {
"summary" : "POST /api/ee/cloud-add-ons/{product-type}",
Expand All @@ -16193,7 +16239,7 @@
"required" : true,
"schema" : {
"type" : "string",
"enum" : [ "metabase-ai" ]
"enum" : [ "metabase-ai", "metabase-ai-tiered" ]
}
} ],
"responses" : {
Expand All @@ -16213,11 +16259,13 @@
"schema" : {
"type" : "object",
"properties" : {
"quantity" : {
"type" : "integer"
},
"terms_of_service" : {
"type" : "boolean"
}
},
"required" : [ "terms_of_service" ]
}
}
}
}
Expand Down Expand Up @@ -25752,6 +25800,25 @@
"tags" : [ "/api/preview_embed" ]
}
},
"/api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
"get" : {
"summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}",
"description" : "Embedded version of chain filter search endpoint.",
"parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
},
"5XX" : {
"description" : "Server error response"
}
},
"tags" : [ "/api/preview_embed" ]
}
},
"/api/preview_embed/dashboard/{token}/params/{param-key}/values" : {
"get" : {
"summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/values",
Expand Down Expand Up @@ -28621,25 +28688,6 @@
"tags" : [ "/api/setup" ]
}
},
"/api/setup/user_defaults" : {
"get" : {
"summary" : "GET /api/setup/user_defaults",
"description" : "Returns object containing default user details for initial setup, if configured,\n and if the provided token value matches the token in the configuration value.",
"parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
},
"5XX" : {
"description" : "Server error response"
}
},
"tags" : [ "/api/setup" ]
}
},
"/api/slack/bug-report" : {
"post" : {
"summary" : "POST /api/slack/bug-report",
Expand Down
1 change: 1 addition & 0 deletions _docs/latest/configuring-metabase/config-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ config:
not-behind-proxy: false
notification-link-base-url: null
notification-system-event-thread-pool-size: 5
notification-temp-file-size-max-bytes: 10485760
notification-thread-pool-size: 3
persisted-model-refresh-cron-schedule: 0 0 0/6 * * ? *
persisted-models-enabled: false
Expand Down
95 changes: 37 additions & 58 deletions _docs/latest/installation-and-operation/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,114 +8,97 @@ title: Metabase CLI
source_url: >-
https://github.com/metabase/metabase/blob/master/docs/installation-and-operation/commands.md
layout: new-docs
description: >-
CLI commands for managing your Metabase instance, including database
migrations, serialization, and administrative tasks.
latest: true
---

# Metabase CLI

Metabase ships with some handy CLI commands. To view a list of commands, run the Metabase jar followed by `help`.
Metabase ships with some handy CLI commands for administration, maintenance, and automation tasks. These commands let you manage your Metabase instance, migrate databases, handle serialization, and generate documentation.

To view a list of commands, run the Metabase jar followed by `help`.

```
java --add-opens java.base/java.nio=ALL-UNNAMED -jar metabase.jar help
```

Metabase will print out the help text for available commands.


## `api-documentation`

Generate a markdown file containing documentation for all API endpoints. This is written to a file called `docs/api.html`.
Generate an HTML and JSON files for all API endpoints.

## `driver-methods` | `driver-methods _docs`
## `command-documentation`

Print a list of all multimethods available for a driver to implement. Add `_docs` to include their docstrings.
Generates a markdown file containing documentation for all CLI commands. This is written to a file called `docs/installation-and-operation/commands.md`.

## `config-template`

Generates a Markdown file with documentation and an example configuration file in YAML. The YAML template includes Metabase settings and their defaults. Metabase will save the file as `docs/configuring-metabase/config-template.md`.

## `drop-entity-ids`

Drop Entity IDs for instances of serializable models. Useful for migrating from v1 serialization (x.46 and earlier) to v2 (x.47+).
Generates a markdown file with some documentation and an example configuration file in YAML. The YAML template includes Metabase settings and their defaults. Metabase will save the template as `docs/configuring-metabase/config-template.md`.

## `dump path & options`
## `driver-methods | driver-methods _docs`

**Note: this command is deprecated. Use `export` instead.**
Print a list of all multimethods available for a driver to implement, optionally with their docstrings.

Serializes Metabase instance into directory `path`.

Options:
## `drop-entity-ids`

- `-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
Drop entity IDs for instances of serializable models. Useful for migrating from v1 serialization (x.46 and earlier) to v2 (x.47+).

## `dump-to-h2 h2-filename & opts`
## `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
- `-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 https://www.metabase.com/docs/latest/configuring-metabase/environment-variables.

## `export path & options`

{% include plans-blockquote.html feature="Serialization" self-hosted-only="true" %}
## `export path options`

Serialize Metabase instance into directory at `path`.

Options:

- `-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
- `-c, --collection ID` - Export only specified ID(s). Use commas to separate multiple IDs. Pass either PKs or entity IDs.
- `-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

## `help command-name` | `help`
- `-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.

Show this help message listing valid Metabase commands. Use `help command-name` for specific command details.
## `help command-name | help`

## `import path & options`
Show this help message listing valid Metabase commands.

{% include plans-blockquote.html feature="Serialization" self-hosted-only="true" %}
## `import path options`

Load serialized Metabase instance as created by the `export` command from directory `path`.
Load serialized Metabase instance as created by the [[export]] command from directory `path`.

Options:

- `-e, --continue-on-error` - Do not break execution on errors
- `--full-stacktrace` - Output full stacktraces on errors
- `-e, --continue-on-error` - Do not break execution on errors.
- `--full-stacktrace` - Output full stacktraces on errors.

## `load path & options`

**Note: this command is deprecated. Use `import` instead.**

Load serialized Metabase instance as created by `dump` command from directory `path`.

Options:

- `-m, --mode (skip|update)` - Update or skip on conflicts. Default: skip
- `-e, --on-error (continue|abort)` - Abort or continue on error. Default: continue

## `load-from-h2` | `load-from-h2 h2-connection-string`
## `load-from-h2 | load-from-h2 h2-connection-string`

Transfer data from existing H2 database to the newly created MySQL or Postgres DB specified by env vars.

## `migrate direction`

Run database migrations. Valid options for `direction` are `up`, `force`, `down`, `print`, or `release-locks`.
Run database migrations. Valid options for `direction` are `up`, `force`, `down`, `down-force`, `print`, or `release-locks`.

## `profile`
## `remove-encryption`

Start Metabase the usual way and exit. Useful for profiling Metabase launch time.
Decrypts data in the metabase database. The MB_ENCRYPTION_SECRET_KEY environment variable has to be set to the current key

## `reset-password email-address`

Expand All @@ -125,13 +108,9 @@ Reset the password for a user with `email-address`.

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.

## `remove-encryption`

Decrypts data in the metabase database. The MB_ENCRYPTION_SECRET_KEY environment variable has to be set to the current key.

## `seed-entity-ids`

Add Entity IDs for instances of serializable models that don't already have them.
Add entity IDs for instances of serializable models that don't already have them.

## `version`

Expand Down
Loading