Metabase CLI

Metabase 提供了一些方便的 CLI 命令，用于管理、维护和自动化任务。这些命令允许您管理 Metabase 实例、迁移数据库、处理序列化以及生成文档。

要查看命令列表，请运行 Metabase jar 文件，后跟 help。

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

Metabase 将打印出可用命令的帮助文本。

api-documentation

为 Metabase API 的 Scalar 文档生成 HTML 文件和 JSON 文件。

command-documentation

生成一个 Markdown 文件，其中包含所有 CLI 命令的文档。该文件将保存为 docs/installation-and-operation/commands.md。

config-template

生成一个 Markdown 文件，其中包含一些文档和一个 YAML 格式的示例配置文件。YAML 模板包括 Metabase 设置及其默认值。Metabase 将模板保存为 docs/configuring-metabase/config-template.md。

driver-methods | driver-methods _docs

打印一个驱动程序实现的所有多方法列表，可选地包含其文档字符串。

drop-entity-ids

删除可序列化模型实例的实体 ID。这对于从 v1 序列化（x.46 及更早版本）迁移到 v2（x.47+）非常有用。

dump-to-h2 h2-filename opts

将数据从现有数据库传输到新创建的 H2 数据库，并指定文件名。目标 H2 文件将在转储之前被删除，除非提供了 –keep-existing 标志。

选项

• -k, --keep-existing - 如果目标 H2 文件存在，则不删除。
• -p, --dump-plaintext - 不加密转储的内容。

environment-variables-documentation

生成一个 Markdown 文件，其中包含与配置 Metabase 相关的环境变量的文档。该命令仅包含注册为 defsettings 的环境变量。有关环境变量的完整列表，请参阅 https://metabase.net.cn/docs/latest/configuring-metabase/environment-variables。

export path options

将 Metabase 实例序列化到 path 指定的目录。

选项

• -c, --collection ID - 仅导出指定的 ID。使用逗号分隔多个 ID。传递主键或实体 ID。
• -C, --no-collections - 不导出集合中的任何内容。
• -S, --no-settings - 不导出 settings.yaml
• -D, --no-data-model - 不导出任何数据模型实体；这对于后续导出很有用。
• -f, --include-field-values - 包含字段值以及字段元数据。
• -s, --include-database-secrets - 包含数据库连接详细信息（明文；请谨慎使用）。
• -e, --continue-on-error - 发生错误时不中断执行。
• --full-stacktrace - 在错误时输出完整的堆栈跟踪。

help command-name | help

显示此帮助消息，列出有效的 Metabase 命令。

import path options

从目录 path 加载由 [[export]] 命令创建的已序列化的 Metabase 实例。

选项

• -e, --continue-on-error - 发生错误时不中断执行。
• --full-stacktrace - 在错误时输出完整的堆栈跟踪。

load-from-h2 | load-from-h2 h2-connection-string

将数据从现有 H2 数据库传输到通过环境变量指定的、新创建的 MySQL 或 Postgres 数据库。

migrate direction

运行数据库迁移。 direction 的有效选项是 up、force、down、down-force、print 或 release-locks。

remove-encryption

解密 Metabase 数据库中的数据。MB_ENCRYPTION_SECRET_KEY 环境变量必须设置为当前密钥。

reset-password email-address

重置拥有 email-address 的用户的密码。

rotate-encryption-key new-key

轮换 Metabase 数据库的加密密钥。MB_ENCRYPTION_SECRET_KEY 环境变量必须设置为当前密钥，并且 new-key 参数必须是新密钥。new-key 必须至少为 16 个字符。

seed-entity-ids

为尚无实体 ID 的可序列化模型实例添加实体 ID。

version

打印 Metabase 和当前系统的版本信息。

其他有用命令

H2 SQL Shell

打开 Metabase H2 数据库的 SQL Shell

java -cp metabase.jar org.h2.tools.Shell -url jdbc:h2:/path/to/metabase.db