TablePlus 是一款跨平台数据库管理工具，旨在简化数据库的连接、查询、编辑和管理流程，支持管理 MySQL、PostgreSQL、SQLite、SQL Server、Oracle 等数据库。本文介绍了如何在 TablePlus 中连接和使用 ByteHouse 中创建的 MySQL 和 ClickHouse 数据库。

• 您已安装 TablePlus，详情请参见 TablePlus 官网。
• 数据库用户当前为 Beta 功能，如需使用数据库用户连接 TablePlus，请提交工单或联系 ByteHouse 团队获取白名单权限。

ByteHouse 支持通过 IAM 用户或数据库用户连接，您在使用该工具前，请先配置好用户账号相关信息。IAM 用户和数据库用户的区别请参考ByteHouse权限管控概述。

step1 配置公网域名

登录并进入 ByteHouse 控制台后，在顶部租户管理的基本信息页面，查看网络组配置，确认已绑定 VPC，并绑定了公网域名。

• 如果未绑定 VPC 和公网域名，需参考设置网络信息文档完成绑定配置。
• 完成绑定后，可单击复制公网域名，用于后续对接参数配置。

step2 设置默认计算组

进入顶部租户管理的参数设置页面，查看已设置了默认计算组，并确保此计算组是正在运行的状态，未被停止。后续对接 ByteHouse 后的数据查询等操作，即会使用此处配置的默认计算组。

step 3 获取连接串的用户及密码信息

使用 IAM 用户连接

IAM 用户使用 API Key 作为连接密码，您可进入顶部租户管理的连接信息页面，在 API Key 模块新建一个 API key，并将 API Key 保存至本地，用于后续的配置使用。

使用数据库用户连接

数据库用户的账号使用 ByteHouse 账号、数据库用户名、账号、环境 ID（可选）拼接而成，格式为{accountID_or_accountName}::{username}[::{envID}]。密码为数据库用户的密码。

获取账号信息

登录并进入 ByteHouse 控制台后，单击右上角个人中心查看并复制账号 ID 或名称。

配置数据库用户及密码

登录并进入 ByteHouse 控制台，在顶部权限管理下的用户页面，查看用户列表，筛选用户类别为数据库的用户，查看并复制数据库用户名。如果尚未创建数据库用户，可联系管理员参考管理数据库用户创建。
数据库用户的密码为管理员配置，可联系管理员获取对应的密码。如果密码丢失或遗忘，可联系管理员重置密码，详情请参考重置密码。

（可选）获取环境信息

如果使用 default 环境，可不配置，如需使用其他环境，需指定环境名称。您可登录并进入 ByteHouse 控制台后，在顶部租户管理下的基本信息页面，查看当前环境名称。

您可以使用 TablePlus 创建 MySQL 或 ClickHouse 数据源，并连接至 ByteHouse。

连接 MySQL 数据库驱动程序

1. 启动 TablePlus，在界面右侧空白处，单击鼠标右键，单击 New > Connection。

2. 在弹窗中搜索并选择 MySQL，单击 Create。

   

3. 在 MySQL Connection 弹窗中，按照ByteHouse 侧配置中获取的连接信息填写配置信息：

   

   参数	使用 IAM 用户连接	使用数据库用户连接
   Name	自定义连接名称。
   Host/IP	配置为 ByteHouse 的公网域名，格式为：tenant-{TENANT_ID}-{REGION}-public.bytehouse.volces.com，您可以在 ByteHouse 控制台的租户管理>基本信息>网络信息中获取。详情请参见 获取集群连接地址 {HOST}:{PORT}。
   Port	数据库端口号，配置为固定取值：3306。
   User & Password	登录 ByteHouse 数据库的用户名和密码。获取相关连接信息 可以在 ByteHouse 控制台>租户管理>连接信息中获取的 API Key。详情请参见获取 API Key。 User 为 API Key 的前半部分，比如获取的 API Key xxxx.yyyy，则 User 需填写 xxxx。 密码为 API Key 的前半部分，比如获取的 API Key xxxx.yyyy，则 User 需填写 yyyy。	User Name 配置为 {accountID_or_accountName}::{username}[::{envID}]，详情请参见使用数据库账号连接： accountID_or_accountName：指用户账号或名称，可登录 ByteHouse 控制台，单击右上角个人中心查看并复制账号ID 或名称。 username：登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台>权限管理>用户>查看数据库用户名。 envID：可选配置，数据库所在的环境名称。如果使用 default 环境，可不配置，如需使用其他环境，需指定环境名称。您可登录 ByteHouse 控制台，在**租户管理>基本信息>当前环境 **中获取。 password：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。
   Database	填写您的数据库名称或空。
   SSL	选择 REQUIRED。

4. 单击 Test，测试是否能够成功连接。当输入框底色变为绿色，则表示连接成功。
   连接成功的示例如下：

   

5. 测试连接成功后，单击 Connect，创建连接。

6. （可选）配置计算组信息。单击 Bootsrap commands，添加set virtual_warehouse='virtual_warehouse_id'引导命令。
   'virtual_warehouse_id' 设置为您使用的 ByteHouse 计算组 ID，您可通过登录 ByteHouse 控制台，单击顶部计算组页签，查看所需的计算组 ID。
   
   在每次使用 SQL 编辑器前，请先运行set virtual_warehouse='virtual_warehouse_id'。
   

连接 Clickhouse 数据库驱动程序

1. 启动 TablePlus，在界面右侧空白处，单击鼠标右键，单击 New > Connection。

2. 在弹窗中搜索并选择 ClickHouse，单击 Create。

   

3. 在 ClickHouse Connection 弹窗中，按照ByteHouse 侧配置中获取的连接信息填写配置信息：

   

   参数	使用 IAM 用户连接	使用数据库用户连接
   Name	自定义连接名称。
   Host	配置为 ByteHouse 的公网域名，格式为：tenant-{TENANT_ID}-{REGION}-public.bytehouse.volces.com，您可以在 ByteHouse 控制台的租户管理>基本信息>网络信息中获取。详情请参见 获取集群连接地址 {HOST}:{PORT}。
   Port	数据库端口号，配置为固定取值：19000。
   User & Password	登录 ByteHouse 数据库的用户名和密码。 User Name 默认为 bytehouse。 密码为 <API_Key>，可以在 ByteHouse 控制台>租户管理>连接信息中获取的 API Key。详情请参见获取 API Key。	User Name 配置为 {accountID_or_accountName}::{username}[::{envID}]，详情请参见使用数据库账号连接： accountID_or_accountName：指用户账号或名称，可登录 ByteHouse 控制台，单击右上角个人中心查看并复制账号ID 或名称。 username：登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台>权限管理>用户>查看数据库用户名。 envID：可选配置，数据库所在的环境名称。如果使用 default 环境，可不配置，如需使用其他环境，需指定环境名称。您可登录 ByteHouse 控制台，在**租户管理>基本信息>当前环境 **中获取。 password：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。
   Database	填写您的数据库名称或空。
   SSL	选择 USE SSL(SKIP VALIDATE)。

4. 单击 Test，测试是否能够成功连接。当输入框底色变为绿色，则表示连接成功。
   连接成功的示例如下：

   

5. 测试连接成功后，单击 Connect，创建连接。

6. （可选）配置计算组信息。单击 Bootsrap commands，添加set virtual_warehouse='virtual_warehouse_id'引导命令。
   'virtual_warehouse_id' 设置为您使用的 ByteHouse 计算组 ID，您可通过登录 ByteHouse 控制台，单击顶部计算组页签，查看所需的计算组 ID。
   
   在每次使用 SQL 编辑器前，请先运行set virtual_warehouse='virtual_warehouse_id'。