From 04820a001446fb2eec0448756ec0ac3472fa9698 Mon Sep 17 00:00:00 2001 From: Metabase Docs bot Date: Wed, 26 Nov 2025 02:45:05 +0000 Subject: [PATCH] [auto] adding content to release-x.57.x->release-x.57.x --- _docs/latest/api.json | 98 ++++++++---- .../configuring-metabase/config-template.md | 1 + .../installation-and-operation/commands.md | 95 +++++------- _docs/v0.57/api.json | 98 ++++++++---- .../configuring-metabase/config-template.md | 1 + .../installation-and-operation/commands.md | 93 +++++------- _site/docs/latest/api.json | 98 ++++++++---- .../configuring-metabase/config-template.html | 1 + .../installation-and-operation/commands.html | 141 +++++------------- _site/docs/v0.57/api.json | 98 ++++++++---- .../configuring-metabase/config-template.html | 1 + .../installation-and-operation/commands.html | 141 +++++------------- 12 files changed, 438 insertions(+), 428 deletions(-) diff --git a/_docs/latest/api.json b/_docs/latest/api.json index 331090089..f4e527009 100644 --- a/_docs/latest/api.json +++ b/_docs/latest/api.json @@ -9695,6 +9695,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/activity" ] } }, @@ -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.", @@ -13091,6 +13098,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/dashboard" ] }, "post" : { @@ -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}", @@ -16193,7 +16239,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "metabase-ai" ] + "enum" : [ "metabase-ai", "metabase-ai-tiered" ] } } ], "responses" : { @@ -16213,11 +16259,13 @@ "schema" : { "type" : "object", "properties" : { + "quantity" : { + "type" : "integer" + }, "terms_of_service" : { "type" : "boolean" } - }, - "required" : [ "terms_of_service" ] + } } } } @@ -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", @@ -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", diff --git a/_docs/latest/configuring-metabase/config-template.md b/_docs/latest/configuring-metabase/config-template.md index 656655030..4f484a2ca 100644 --- a/_docs/latest/configuring-metabase/config-template.md +++ b/_docs/latest/configuring-metabase/config-template.md @@ -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 diff --git a/_docs/latest/installation-and-operation/commands.md b/_docs/latest/installation-and-operation/commands.md index 86b722336..9cabe07d7 100644 --- a/_docs/latest/installation-and-operation/commands.md +++ b/_docs/latest/installation-and-operation/commands.md @@ -8,12 +8,17 @@ 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 @@ -21,101 +26,79 @@ 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` @@ -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` diff --git a/_docs/v0.57/api.json b/_docs/v0.57/api.json index 331090089..f4e527009 100644 --- a/_docs/v0.57/api.json +++ b/_docs/v0.57/api.json @@ -9695,6 +9695,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/activity" ] } }, @@ -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.", @@ -13091,6 +13098,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/dashboard" ] }, "post" : { @@ -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}", @@ -16193,7 +16239,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "metabase-ai" ] + "enum" : [ "metabase-ai", "metabase-ai-tiered" ] } } ], "responses" : { @@ -16213,11 +16259,13 @@ "schema" : { "type" : "object", "properties" : { + "quantity" : { + "type" : "integer" + }, "terms_of_service" : { "type" : "boolean" } - }, - "required" : [ "terms_of_service" ] + } } } } @@ -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", @@ -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", diff --git a/_docs/v0.57/configuring-metabase/config-template.md b/_docs/v0.57/configuring-metabase/config-template.md index 4f8e9243a..bf869a88b 100644 --- a/_docs/v0.57/configuring-metabase/config-template.md +++ b/_docs/v0.57/configuring-metabase/config-template.md @@ -216,6 +216,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 diff --git a/_docs/v0.57/installation-and-operation/commands.md b/_docs/v0.57/installation-and-operation/commands.md index 1a5f5c05e..cd5b5e327 100644 --- a/_docs/v0.57/installation-and-operation/commands.md +++ b/_docs/v0.57/installation-and-operation/commands.md @@ -7,11 +7,14 @@ category: 'Installation and Operation' 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.' --- # 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 @@ -19,101 +22,79 @@ 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` @@ -123,13 +104,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` diff --git a/_site/docs/latest/api.json b/_site/docs/latest/api.json index 331090089..f4e527009 100644 --- a/_site/docs/latest/api.json +++ b/_site/docs/latest/api.json @@ -9695,6 +9695,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/activity" ] } }, @@ -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.", @@ -13091,6 +13098,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/dashboard" ] }, "post" : { @@ -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}", @@ -16193,7 +16239,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "metabase-ai" ] + "enum" : [ "metabase-ai", "metabase-ai-tiered" ] } } ], "responses" : { @@ -16213,11 +16259,13 @@ "schema" : { "type" : "object", "properties" : { + "quantity" : { + "type" : "integer" + }, "terms_of_service" : { "type" : "boolean" } - }, - "required" : [ "terms_of_service" ] + } } } } @@ -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", @@ -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", diff --git a/_site/docs/latest/configuring-metabase/config-template.html b/_site/docs/latest/configuring-metabase/config-template.html index 802d3eb81..e5a9c9886 100644 --- a/_site/docs/latest/configuring-metabase/config-template.html +++ b/_site/docs/latest/configuring-metabase/config-template.html @@ -5661,6 +5661,7 @@

Metabase config file template

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 diff --git a/_site/docs/latest/installation-and-operation/commands.html b/_site/docs/latest/installation-and-operation/commands.html index c9982d84c..f45669977 100644 --- a/_site/docs/latest/installation-and-operation/commands.html +++ b/_site/docs/latest/installation-and-operation/commands.html @@ -52,7 +52,7 @@ - + @@ -62,7 +62,7 @@ - + @@ -5459,7 +5459,9 @@
Other resources

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
@@ -5468,151 +5470,82 @@

Metabase CLI

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+).

- -

dump path & options

+

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.

-

Note: this command is deprecated. Use export instead.

+

driver-methods | driver-methods _docs

-

Serializes Metabase instance into directory path.

+

Print a list of all multimethods available for a driver to implement, optionally with their docstrings.

-

Options:

+

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+).

-

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:

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

- -
-
- - - - - - - - - - - -

- Serialization is only available on - Pro and - Enterprise - plans (only on self-hosted - plans). -

-
-
+

export path options

Serialize Metabase instance into directory at path.

Options:

-

help command-name | help

+

help command-name | help

-

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

+

Show this help message listing valid Metabase commands.

-

import path & options

+

import path options

-
-
- - - - - - - - - - - -

- Serialization is only available on - Pro and - Enterprise - plans (only on self-hosted - plans). -

-
-
- -

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:

-

load path & options

- -

Note: this command is deprecated. Use import instead.

- -

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

- -

Options:

- - - -

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

@@ -5622,13 +5555,9 @@

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

diff --git a/_site/docs/v0.57/api.json b/_site/docs/v0.57/api.json index 331090089..f4e527009 100644 --- a/_site/docs/v0.57/api.json +++ b/_site/docs/v0.57/api.json @@ -9695,6 +9695,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/activity" ] } }, @@ -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.", @@ -13091,6 +13098,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/dashboard" ] }, "post" : { @@ -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}", @@ -16193,7 +16239,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "metabase-ai" ] + "enum" : [ "metabase-ai", "metabase-ai-tiered" ] } } ], "responses" : { @@ -16213,11 +16259,13 @@ "schema" : { "type" : "object", "properties" : { + "quantity" : { + "type" : "integer" + }, "terms_of_service" : { "type" : "boolean" } - }, - "required" : [ "terms_of_service" ] + } } } } @@ -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", @@ -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", diff --git a/_site/docs/v0.57/configuring-metabase/config-template.html b/_site/docs/v0.57/configuring-metabase/config-template.html index e34319877..94e819928 100644 --- a/_site/docs/v0.57/configuring-metabase/config-template.html +++ b/_site/docs/v0.57/configuring-metabase/config-template.html @@ -5663,6 +5663,7 @@

Metabase config file template

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 diff --git a/_site/docs/v0.57/installation-and-operation/commands.html b/_site/docs/v0.57/installation-and-operation/commands.html index 18cef15d0..18f637825 100644 --- a/_site/docs/v0.57/installation-and-operation/commands.html +++ b/_site/docs/v0.57/installation-and-operation/commands.html @@ -54,7 +54,7 @@ - + @@ -64,7 +64,7 @@ - + @@ -5461,7 +5461,9 @@
Other resources

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
@@ -5470,151 +5472,82 @@

Metabase CLI

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+).

- -

dump path & options

+

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.

-

Note: this command is deprecated. Use export instead.

+

driver-methods | driver-methods _docs

-

Serializes Metabase instance into directory path.

+

Print a list of all multimethods available for a driver to implement, optionally with their docstrings.

-

Options:

+

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+).

-

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:

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

- -
-
- - - - - - - - - - - -

- Serialization is only available on - Pro and - Enterprise - plans (only on self-hosted - plans). -

-
-
+

export path options

Serialize Metabase instance into directory at path.

Options:

-

help command-name | help

+

help command-name | help

-

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

+

Show this help message listing valid Metabase commands.

-

import path & options

+

import path options

-
-
- - - - - - - - - - - -

- Serialization is only available on - Pro and - Enterprise - plans (only on self-hosted - plans). -

-
-
- -

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:

-

load path & options

- -

Note: this command is deprecated. Use import instead.

- -

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

- -

Options:

- - - -

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

@@ -5624,13 +5557,9 @@

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