Metabase CLI

Metabase附带一些实用的CLI命令。要查看命令列表，请运行Metabase jar包后跟help。

java -jar metabase.jar help

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

api-documentation

生成包含所有API端点文档的Markdown文件。此文件将写入名为docs/api-documentation.md的文件中。

driver-methods

或driver-methods _docs。

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

drop-entity-ids

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

导出路径和选项

此命令已弃用。请使用export代替。

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

选项

-u，--user EMAIL导出指定用户的集合

-s，--state (active|all) all当设置为active时，不要导出存档实体。默认行为是all。

dump-to-h2 h2-filename & opts

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

选项

-k，--keep-existing如果存在，则不删除目标H2文件。

-p，--dump-plaintext不要加密导出内容。

环境变量文档

生成包含与配置Metabase相关的环境变量文档的Markdown文件。该命令仅包括注册为defsettings的环境变量。有关环境变量的完整列表，请参阅环境变量。

export path & options

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

选项

-c，--collection ID仅导出指定的ID。使用逗号分隔多个ID。

-C，--no-collections不导出任何集合中的内容。

-S，--no-settings不导出settings.yaml

-D，--no-data-model不导出任何数据模型实体；对于后续导出很有用。

-f，--include-field-values包括字段值以及字段元数据。

-s，--include-database-secrets 包含数据库连接详情（纯文本格式；请谨慎使用）。

帮助

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

导入路径和选项

从目录 path 加载由导出命令创建的序列化 Metabase 实例。没有选项。

加载路径和选项

此命令已弃用。请使用 import 代替。

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

选项

-m，--mode (skip|update) skip 在冲突时更新或跳过。

-e，--on-error (continue|abort) 继续或中止错误。

从 H2 加载

将现有 H2 数据库中的数据传输到由环境变量指定的新创建的 MySQL 或 Postgres DB。

load-from-h2 h2-connection-string

降级迁移

用于降级版本。

配置文件

以常规方式启动 Metabase 并退出。用于分析 Metabase 启动时间。

重置密码 电子邮件地址

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

旋转加密密钥 新密钥

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

版本

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