Navicat 是一款图形数据库管理和开发软件,适用于 MySQL、MariaDB、Redis、MongoDB、Oracle、SQLite、PostgreSQL 和 MicrosoftSQLServer。它具有类似资源管理器的图形用户交互界面,并支持本地和远程数据库的多个数据库连接。
背景信息
ByteHouse 支持通过 IAM 用户或数据库用户连接 Navicat。IAM 用户与数据库用户二者差异说明如下,您可按需选择。
- IAM 用户为火山引擎访问控制(IAM)中创建的用户,其权限由 IAM 权限策略及您授予的 ByteHouse 资源和数据权限决定。IAM 用户可访问 ByteHouse 控制台,也支持通过 CLI、连接驱动、生态工具、API 等方式访问 ByteHouse。
- 数据库用户为 ByteHouse 中创建的数据库级别用户,可为其授予环境、资源和数据权限。数据库用户不可访问 ByteHouse 控制台,但支持通过 CLI、连接驱动、生态工具、API 等方式访问 ByteHouse。
更多 IAM 用户和数据库用户的介绍请参见以下文档:
前提条件
请提前安装好 Navicat,并获得相应的商用授权。
连接步骤
打开 Navicat,单击左上角图标,选择创建 MySQL 数据源。

填写一下连接信息字段。

参数 | 使用 IAM 用户连接 | 使用数据库用户连接 |
|---|
Host | 配置为 ByteHouse 的网络域名,您可以在 ByteHouse 控制台的租户管理 > 基本信息 > 网络信息中获取。详情请参见步骤二:配置网络信息。 |
Port | 数据库端口号,配置为固定取值:3306。 |
User Name & Password | 【推荐】方式一:
使用 API Key 作为 Username 和 Password。详情请参见获取 API Key。 - Username 为 API Key 的前半部分,比如获取的 API Key xxxx.yyyy,则 User 需填写 xxxx。
- Password 为 API Key 的前半部分,比如获取的 API Key xxxx.yyyy,则 User 需填写 yyyy。
方式二: - Username 默认为
bytehouse。 - Password 为 <API_Key>,可以在 ByteHouse 控制台 > 租户管理 > 连接信息中获取的 API Key。详情请参见获取 API Key。
| - User Name 配置为
{accountID_or_accountName}::{username}[::{envID}],详情请参见步骤三:获取 ByteHouse 连接串信息:
{accountID_or_accountName}:指火山引擎用户账号 ID 或名称,可登录 ByteHouse 控制台,单击右上角个人中心查看并复制账号 ID 或名称。{username}:登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台 > 权限管理 > 用户 > 查看数据库用户名。{envID}:可选配置,数据库所在的环境名称。如果使用 default 环境,可不配置;如需使用其他环境,需指定环境名称,配置时无需添加[]。您可登录 ByteHouse 控制台,在租户管理 > 基本信息 > 当前环境中获取。
使用示例如下:
- 配置环境 ID:
21xxxxxxxx::demouser::demoenv - 不配置环境 ID:
21xxxxxxxx::demouser
- Password:数据库账号的密码由管理员创建数据库账号时自定义配置,您可联系管理员获取密码。如果密码丢失或遗忘,可通联系管理员重置密码,详情请参考重置密码。
|
切换到 SSL 页签,启用 Use SSL。

点击 Test Connection,如出现“Connection Successful”则表示连接成功。
