数据库用户功能为 Beta 功能，如需使用数据库用户连接，请联系提交工单或联系 ByteHouse 团队获取白名单权限。

环境要求

建议使用 Metabase v0.49.13。

运行 Metabase Docker

docker run -d -p 3000:3000 --name metabase metabase/metabase

具体用法可参考 Metabase 官方网站：https://www.metabase.com/start/oss/
在浏览器中打开 http://localhost:3000/ 以访问 Metabase 界面。

下载 ClickHouse 插件 jar 文件

1. 由于 Metabase 通过 Docker 容器部署，所以需要进入容器下载 ClickHouse Metabase 插件 jar 到 plugins 目录下。

   docker exec -it <container_id> bash
   cd plugins
   wget https://github.com/ClickHouse/metabase-clickhouse-driver/releases/download/1.3.3/clickhouse.metabase-driver.jar
   

2. 退出并重启容器。

   docker restart <container_id>
   

3. 重新打开 http://localhost:3000/ 以访问 Metabase 界面。

这里以 SSB 数据集为例，执行下面的命令生成数据。请注意，如果您不需要执行性能测试，您可以缩减数据量。

./dbgen -s 1 -T c 
./dbgen -s 1 -T l 
./dbgen -s 1 -T p 
./dbgen -s 1 -T s

1. 单击右上角的齿轮图标，然后选择管理设置 Admin Settings 以访问您的 Metabase管理页面。

2. 单击 添加数据库 Add a database。或者，您可以单击“数据库 Databases”选项卡并选择“添加数据库 Add database”按钮。

3. 如果您的驱动程序安装成功，您将在数据库类型 Database type 的下拉菜单中看到 ClickHouse：
   

4. 为您的数据库指定一个显示名称 Display name，您可按需自定义名称。

5. 输入 ByteHouse 数据库的连接详细信息。
   

   参数	使用 IAM 用户连接	使用数据库用户连接
   Host	配置为 ByteHouse 的网络域名，格式为：gateway-v2.tenant-{TENANT_ID}-{REGION}-public.bytehouse.volces.com，您可以在 ByteHouse 控制台的租户管理>基本信息>网络信息中获取。详情请参见步骤二：配置网络信息。
   Port	数据库端口号，配置为固定取值：8123。
   Username & Password	Username 默认为 bytehouse。 Password 为 <API_Key>，可以在 ByteHouse 控制台>租户管理>连接信息中获取的 API Key，详情请参见获取 API Key。	Username 由 {accountID_or_accountName}::{username}[::{envID}] 构成，详情请参见步骤三：获取 ByteHouse 连接串信息： accountID_or_accountName：指火山引擎用户账号 ID 或名称，可登录 ByteHouse 控制台，单击右上角个人中心查看并复制账号ID 或名称。 username：登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台>权限管理>用户>查看数据库用户名。 envID：可选配置，数据库所在的环境名称。如果使用 default 环境，可不配置，如需使用其他环境，需指定环境名称。您可登录 ByteHouse 控制台，在租户管理>基本信息>**当前环境 **中获取。 password：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。
   Database	配置为 ByteHouse 已创建的数据库名称。
   Use a secure connection (SSL)	启用安全连接（SSL）。 注意 ByteHouse 需要加密认证，从而保护数据安全，因此您需打开 SSL。

6. 单击“保存”按钮，Metabase 将扫描数据库中的表。