Metabase命令行工具全解析：从基础操作到高级功能

Metabase命令行工具全解析：从基础操作到高级功能

metabase metabase/metabase: 是一个开源的元数据管理和分析工具，它支持多种数据库，包括 PostgreSQL、 MySQL、 SQL Server 等。适合用于数据库元数据管理和分析，特别是对于需要管理和分析数据库元数据的场景。特点是元数据管理和分析工具、支持多种数据库、易于使用。 项目地址: https://gitcode.com/gh_mirrors/me/metabase

前言

作为一款开源商业智能工具，Metabase提供了丰富的命令行接口(CLI)来帮助管理员进行系统管理和维护工作。本文将全面解析Metabase提供的各种命令行工具，帮助用户更好地管理和维护自己的Metabase实例。

基础命令概览

Metabase的命令行工具通过Java jar包运行，基本命令格式如下：

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

这条命令会列出所有可用的CLI命令。需要注意的是，由于Java模块系统的限制，必须添加--add-opens参数才能正常运行。

文档生成类命令

1. API文档生成

api-documentation命令可以自动生成所有API端点的Markdown格式文档，输出到docs/api.html文件。这对于开发者了解Metabase的API接口非常有用。

2. 配置模板生成

config-template命令会生成一个包含所有配置项说明和默认值的Markdown文件，同时提供一个YAML格式的配置模板。这对于初次配置Metabase的用户特别有帮助。

3. 环境变量文档

environment-variables-documentation命令生成环境变量配置文档，但需要注意它只包含通过defsettings注册的环境变量。

数据迁移与备份命令

1. 数据导出(export)

export命令是推荐的序列化工具，可以将整个Metabase实例导出到指定目录。它提供了丰富的选项：

• 按集合ID选择性导出
• 排除集合、设置或数据模型
• 包含字段值或数据库连接细节(需谨慎)
• 错误处理选项

2. 数据导入(import)

与export对应，import命令用于加载之前导出的数据。支持错误处理和完整堆栈跟踪选项。

3. H2数据库迁移

Metabase提供了两组H2数据库迁移命令：

• dump-to-h2: 从现有数据库迁移到新的H2数据库
• load-from-h2: 从H2数据库迁移到MySQL或PostgreSQL

系统维护命令

1. 数据库迁移

migrate命令用于管理数据库schema迁移，支持多种操作：

• up: 执行待处理的迁移
• down: 回滚迁移
• force: 强制标记迁移为完成
• print: 显示待处理的迁移
• release-locks: 释放迁移锁

2. 加密相关操作

Metabase提供了完整的加密管理工具：

• rotate-encryption-key: 轮换加密密钥
• remove-encryption: 移除数据加密(解密数据)

3. 密码重置

reset-password命令可以重置指定邮箱用户的密码，这在用户忘记密码时非常有用。

开发与调试命令

1. 驱动方法查看

driver-methods命令可以列出所有驱动程序可以实现的multimethods，添加_docs参数可以查看详细的文档说明。

2. 性能分析

profile命令会正常启动Metabase然后立即退出，主要用于分析启动性能。

3. 实体ID管理

Metabase提供了实体ID管理工具：

• seed-entity-ids: 为可序列化模型添加实体ID
• drop-entity-ids: 删除实体ID(用于v1到v2序列化迁移)

实用技巧

H2数据库交互

虽然这不是Metabase的直接命令，但可以通过以下方式与H2数据库交互：

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

这对于直接查询或修改数据库内容非常有用，但操作时需格外小心。

版本信息

version命令可以查看当前Metabase版本和系统信息，在排查问题时非常有用。

总结

Metabase提供了丰富的命令行工具，涵盖了从文档生成、数据迁移到系统维护的各个方面。掌握这些命令可以帮助管理员更高效地管理Metabase实例。对于生产环境，建议在使用这些命令前先进行测试，特别是涉及数据迁移和加密操作时。

metabase metabase/metabase: 是一个开源的元数据管理和分析工具，它支持多种数据库，包括 PostgreSQL、 MySQL、 SQL Server 等。适合用于数据库元数据管理和分析，特别是对于需要管理和分析数据库元数据的场景。特点是元数据管理和分析工具、支持多种数据库、易于使用。 项目地址: https://gitcode.com/gh_mirrors/me/metabase