尧图网页设计 
Beekeeper Studio 连接 SurrealDB 完整指南WebSocket/HTTP 连接、认证方式与当前功能支持现状【免费下载链接】beekeeper-studioModern and easy to use SQL client for MySQL, Postgres, SQLite, SQL Server, and more. Linux, MacOS, and Windows.项目地址: https://gitcode.com/GitHub_Trending/be/beekeeper-studioBeekeeper Studio 是一款面向 MySQL、Postgres、SQLite、SQL Server 等多数据库的现代易用 SQL 客户端在其连接类型列表中同样内置了对 SurrealDB 的支持连接类型定义。本文围绕官方文档 surrealdb.es.md 展开详细讲解如何在 Beekeeper Studio 中通过ws/wss/http/https协议连接 SurrealDB 实例、各个连接字段的含义与认证方式并结合仓库源码连接表单、驱动注册、方言实现与数据库迁移深入说明底层实现与当前支持边界。读完本文你将能够独立完成 SurrealDB 连接配置、正确选择认证方式并清楚了解哪些功能可用、哪些仍处于规划阶段。一、连接 SurrealDB 的快速上手按照官方文档的说法连接一个 SurrealDB 实例非常简单在新建连接界面中从数据库类型下拉菜单里选择SurrealDB依次填写协议Protocol、主机Host、端口Port、用户名Username和密码Password等字段点击Conectar连接按钮完成连接。对应的连接表单实现在 SurrealDBForm.vue该表单顶部还会显示一条警告提示说明当前 SurrealDB 支持仍处于 alpha 阶段SurrealDB support is in alpha并给出支持功能文档与问题反馈入口方便使用者在遇到问题时快速上报。从源码结构看Beekeeper Studio 的 SurrealDB 驱动与连接类型注册于 数据库客户端注册表其在连接类型枚举与下拉列表中均以surrealdb作为内部标识见 types.ts 与 ConnectionTypes 列表。二、SurrealDB 连接参数详解官方文档列出了连接 SurrealDB 实例所需的全部信息下面逐项结合表单源码 SurrealDBForm.vue 进行说明参数说明默认值 / 可选值Protocol协议与 SurrealDB 实例通信所使用的传输协议。当前支持ws、wss、http、https四种无默认必须手动选择表单中为必选项Host主机SurrealDB 实例的 IP 地址或主机名无Port端口SurrealDB 服务监听端口默认8000若服务器使用其他端口可自定义Authentication Method认证方式从 SurrealDB 提供的多种认证方式中选择一种见下文第三节Username用户名SurrealDB 用户名无Password密码SurrealDB 密码无需要特别说明的是协议是必选项。在 SurrealDBForm.vue 中协议字段是一个下拉选择框第一项为占位的 Select a protocol...禁用且隐藏实际可选项由源码中的protocols: [http, https, ws, wss]提供见 SurrealDBForm.vue与官方文档列出的协议清单完全一致。端口字段类型为数字。表单中端口输入框显式声明了typenumber见 SurrealDBForm.vue因此只接受数字输入。用户名/密码与 Token 互斥显示。表单根据所选认证方式动态切换当认证方式不是 Token 时显示用户 密码输入框当选择 Token 认证时则只显示 Token 输入框见 SurrealDBForm.vue。Namespace 与 Database 是附加字段。表单底部还提供命名空间Namespace与数据库Database两个输入框见 SurrealDBForm.vue。由于 SurrealDB 采用命名空间 → 数据库 → 表的三层逻辑组织方式这两项用于在连接时定位到具体的数据域其中数据库值对应连接配置中的defaultDatabase。从连接配置的数据模型看上述协议、认证方式、命名空间与 Token 均存储在surrealDbOptions对象中其接口定义为见 types.tsexport interface SurrealDBOptions { authType?: SurrealAuthType; protocol?: http | https | ws | wss; namespace?: string; token?: string; }该字段通过数据库迁移 20250702_add_surrealdb_options.js 写入saved_connection与used_connection两张表以text类型存储、默认值为{}用于持久化 SurrealDB 专属的连接选项兼容历史连接记录。三、SurrealDB 认证方式Authentication Method官方文档提到从 SurrealDB 提供的多种认证方式中选择一种具体可选项定义在 types.ts 中。当前表单实际开放以下四种认证方式认证方式说明对应表单输入Root以 SurrealDB 根用户root身份认证权限最高用户名 密码Namespace以命名空间级用户身份认证用户名 密码Database以数据库级用户身份认证用户名 密码Token直接使用已有的认证 Token 连接Token不显示用户名/密码需要指出的是源码中枚举还包含RecordAccess记录级访问与Anonymous匿名访问两种类型但目前均被注释禁用见 types.ts。代码注释给出的原因是RecordAccess需要更多实现工作而Anonymous匿名模式似乎不生效且无法访问表或查询数据。因此从源码结构看当前可用的认证方式以 Root、Namespace、Database、Token 四类为准。认证方式与输入框的联动逻辑体现在 SurrealDBForm.vue 的isTokenAuth计算属性中——当authType SurrealAuthType.Token时表单切换为纯 Token 输入模式。四、源码视角SurrealDB 方言与功能边界除了连接表单仓库中还包含 SurrealDB 的方言dialect定义 surrealdb.ts它决定了客户端中关于 SurrealDB 的数据类型、SQL 转义与可用功能范围数据类型支持string、text、number、int、float、decimal、bool、datetime、date、time、duration、uuid、object、array、bytes、any、null、record、geometry、option等类型见 surrealdb.ts其中string/text/number/decimal支持长度设置默认长度分别为 255 与 10。值转义实现了surrealEscapeString、surrealEscapeValue等工具函数能够对字符串做单引号转义、识别 record ID形如表名:记录ID对应正则RECORD_ID_REGEX并保留其不加引号的原生形式同时尝试将字符串自动转换为 JSON 对象/数组、布尔值与数字等原生类型。功能禁用清单通过disabledFeatures明确声明了当前未开放的能力见 surrealdb.ts包括手动提交事务manualCommit、结果内编辑resultEditing、AI Shell、表结构变更alter 一切、触发器SurrealDB 使用 events 而非 triggers、备份、排序规则、schema 编辑、事务、建表/删表、复合主键以及文件导入等。这与官方文档Todavía pendiente仍待实现清单在整体方向上一致也解释了为什么某些菜单项在 SurrealDB 连接下不可用。五、当前已支持的功能官方文档明确列出Beekeeper Studio 的 SurrealDB 支持目前处于早期 alpha 实现阶段以下功能已经可用表数据视图Table data view浏览表中的记录数据表数据排序与过滤Table data sorting, filtering对表数据进行排序和条件过滤表结构视图Table structure view针对 schemafull完整模式表可查看表结构实体侧边栏Entity sidebar在侧边栏中浏览数据库实体对应组件见 SurrealNamespaceDropdown.vue 与 CoreSidebar.vue数据编辑Editing data支持编辑表数据执行查询Running queries可在查询编辑器中直接对数据库执行 SurrealQL/SQL 查询导出Export支持将数据导出SSH 隧道SSH tunneling支持通过 SSH 隧道连接 SurrealDB 实例连接配置中的通用高级选项见表单中的CommonAdvanced组件。六、尚待实现的功能TBD以下功能官方文档明确标注为Todavía pendiente仍待实现在使用时需要注意规避导入Import暂不支持从文件向 SurrealDB 导入数据Schema 编辑Schema Editing暂不支持修改表结构/模式备份/恢复Backup/Restore暂不支持备份与恢复操作。这一点也可以从方言的disabledFeatures配置中得到印证importFromFile文件导入、alter结构变更、backup备份等能力在 SurrealDB 方言下均被显式禁用见 surrealdb.ts。七、连接 SurrealDB 的注意事项综合官方文档与仓库实现连接 SurrealDB 时有以下几点值得留意alpha 阶段定位官方文档明确说明这是对 SurrealDB 支持的早期实现团队正在持续更新建议定期关注文档与新版发布连接表单也会以警告横幅提示当前支持状态见 SurrealDBForm.vue。协议选择影响底层通信ws/wss走 WebSocket 通道http/https走 HTTP 通道两种通道适用于不同的 SurrealDB 部署形态本地开发常用ws/http生产环境建议使用带 TLS 的wss/https选择错误将导致无法连通。命名空间与数据库必须对应SurrealDB 的逻辑层级是命名空间Namespace→ 数据库Database→ 表连接时填写的 Namespace 与 Database 必须与实例中实际创建的一致否则即使认证通过也可能无法看到目标数据。认证方式影响可访问范围Root 拥有最高权限Namespace/Database 级用户仅能在其授权范围内操作选择 Token 认证时无需填写用户名密码但 Token 本身应具备足够的权限。功能边界要心中有数导入、Schema 编辑、备份/恢复等功能尚未就绪涉及这些操作时需要通过 SurrealDB 官方工具或命令行完成。结语本文以官方文档 surrealdb.es.md 为核心完整梳理了在 Beekeeper Studio 中连接 SurrealDB 的流程、连接参数、认证方式与功能支持现状并结合仓库源码连接表单 SurrealDBForm.vue、连接配置模型 types.ts、方言定义 surrealdb.ts 与数据库迁移 20250702_add_surrealdb_options.js做了底层印证。虽然 SurrealDB 支持尚处 alpha 阶段但表数据浏览、排序过滤、查询执行、数据编辑、导出与 SSH 隧道等核心能力已经可用足以支撑日常开发调试后续随着导入、Schema 编辑与备份恢复等能力补齐Beekeeper Studio 对 SurrealDB 的支持将更加完整。【免费下载链接】beekeeper-studioModern and easy to use SQL client for MySQL, Postgres, SQLite, SQL Server, and more. Linux, MacOS, and Windows.项目地址: https://gitcode.com/GitHub_Trending/be/beekeeper-studio创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Beekeeper Studio 连接 SurrealDB 完整指南：WebSocket/HTTP 连接、认证方式与当前功能支持现状
Beekeeper Studio 连接 SurrealDB 完整指南WebSocket/HTTP 连接、认证方式与当前功能支持现状【免费下载链接】beekeeper-studioModern and easy to use SQL client for MySQL, Postgres, SQLite, SQL Server, and more. Linux, MacOS, and Windows.项目地址: https://gitcode.com/GitHub_Trending/be/beekeeper-studioBeekeeper Studio 是一款面向 MySQL、Postgres、SQLite、SQL Server 等多数据库的现代易用 SQL 客户端在其连接类型列表中同样内置了对 SurrealDB 的支持连接类型定义。本文围绕官方文档 surrealdb.es.md 展开详细讲解如何在 Beekeeper Studio 中通过ws/wss/http/https协议连接 SurrealDB 实例、各个连接字段的含义与认证方式并结合仓库源码连接表单、驱动注册、方言实现与数据库迁移深入说明底层实现与当前支持边界。读完本文你将能够独立完成 SurrealDB 连接配置、正确选择认证方式并清楚了解哪些功能可用、哪些仍处于规划阶段。一、连接 SurrealDB 的快速上手按照官方文档的说法连接一个 SurrealDB 实例非常简单在新建连接界面中从数据库类型下拉菜单里选择SurrealDB依次填写协议Protocol、主机Host、端口Port、用户名Username和密码Password等字段点击Conectar连接按钮完成连接。对应的连接表单实现在 SurrealDBForm.vue该表单顶部还会显示一条警告提示说明当前 SurrealDB 支持仍处于 alpha 阶段SurrealDB support is in alpha并给出支持功能文档与问题反馈入口方便使用者在遇到问题时快速上报。从源码结构看Beekeeper Studio 的 SurrealDB 驱动与连接类型注册于 数据库客户端注册表其在连接类型枚举与下拉列表中均以surrealdb作为内部标识见 types.ts 与 ConnectionTypes 列表。二、SurrealDB 连接参数详解官方文档列出了连接 SurrealDB 实例所需的全部信息下面逐项结合表单源码 SurrealDBForm.vue 进行说明参数说明默认值 / 可选值Protocol协议与 SurrealDB 实例通信所使用的传输协议。当前支持ws、wss、http、https四种无默认必须手动选择表单中为必选项Host主机SurrealDB 实例的 IP 地址或主机名无Port端口SurrealDB 服务监听端口默认8000若服务器使用其他端口可自定义Authentication Method认证方式从 SurrealDB 提供的多种认证方式中选择一种见下文第三节Username用户名SurrealDB 用户名无Password密码SurrealDB 密码无需要特别说明的是协议是必选项。在 SurrealDBForm.vue 中协议字段是一个下拉选择框第一项为占位的 Select a protocol...禁用且隐藏实际可选项由源码中的protocols: [http, https, ws, wss]提供见 SurrealDBForm.vue与官方文档列出的协议清单完全一致。端口字段类型为数字。表单中端口输入框显式声明了typenumber见 SurrealDBForm.vue因此只接受数字输入。用户名/密码与 Token 互斥显示。表单根据所选认证方式动态切换当认证方式不是 Token 时显示用户 密码输入框当选择 Token 认证时则只显示 Token 输入框见 SurrealDBForm.vue。Namespace 与 Database 是附加字段。表单底部还提供命名空间Namespace与数据库Database两个输入框见 SurrealDBForm.vue。由于 SurrealDB 采用命名空间 → 数据库 → 表的三层逻辑组织方式这两项用于在连接时定位到具体的数据域其中数据库值对应连接配置中的defaultDatabase。从连接配置的数据模型看上述协议、认证方式、命名空间与 Token 均存储在surrealDbOptions对象中其接口定义为见 types.tsexport interface SurrealDBOptions { authType?: SurrealAuthType; protocol?: http | https | ws | wss; namespace?: string; token?: string; }该字段通过数据库迁移 20250702_add_surrealdb_options.js 写入saved_connection与used_connection两张表以text类型存储、默认值为{}用于持久化 SurrealDB 专属的连接选项兼容历史连接记录。三、SurrealDB 认证方式Authentication Method官方文档提到从 SurrealDB 提供的多种认证方式中选择一种具体可选项定义在 types.ts 中。当前表单实际开放以下四种认证方式认证方式说明对应表单输入Root以 SurrealDB 根用户root身份认证权限最高用户名 密码Namespace以命名空间级用户身份认证用户名 密码Database以数据库级用户身份认证用户名 密码Token直接使用已有的认证 Token 连接Token不显示用户名/密码需要指出的是源码中枚举还包含RecordAccess记录级访问与Anonymous匿名访问两种类型但目前均被注释禁用见 types.ts。代码注释给出的原因是RecordAccess需要更多实现工作而Anonymous匿名模式似乎不生效且无法访问表或查询数据。因此从源码结构看当前可用的认证方式以 Root、Namespace、Database、Token 四类为准。认证方式与输入框的联动逻辑体现在 SurrealDBForm.vue 的isTokenAuth计算属性中——当authType SurrealAuthType.Token时表单切换为纯 Token 输入模式。四、源码视角SurrealDB 方言与功能边界除了连接表单仓库中还包含 SurrealDB 的方言dialect定义 surrealdb.ts它决定了客户端中关于 SurrealDB 的数据类型、SQL 转义与可用功能范围数据类型支持string、text、number、int、float、decimal、bool、datetime、date、time、duration、uuid、object、array、bytes、any、null、record、geometry、option等类型见 surrealdb.ts其中string/text/number/decimal支持长度设置默认长度分别为 255 与 10。值转义实现了surrealEscapeString、surrealEscapeValue等工具函数能够对字符串做单引号转义、识别 record ID形如表名:记录ID对应正则RECORD_ID_REGEX并保留其不加引号的原生形式同时尝试将字符串自动转换为 JSON 对象/数组、布尔值与数字等原生类型。功能禁用清单通过disabledFeatures明确声明了当前未开放的能力见 surrealdb.ts包括手动提交事务manualCommit、结果内编辑resultEditing、AI Shell、表结构变更alter 一切、触发器SurrealDB 使用 events 而非 triggers、备份、排序规则、schema 编辑、事务、建表/删表、复合主键以及文件导入等。这与官方文档Todavía pendiente仍待实现清单在整体方向上一致也解释了为什么某些菜单项在 SurrealDB 连接下不可用。五、当前已支持的功能官方文档明确列出Beekeeper Studio 的 SurrealDB 支持目前处于早期 alpha 实现阶段以下功能已经可用表数据视图Table data view浏览表中的记录数据表数据排序与过滤Table data sorting, filtering对表数据进行排序和条件过滤表结构视图Table structure view针对 schemafull完整模式表可查看表结构实体侧边栏Entity sidebar在侧边栏中浏览数据库实体对应组件见 SurrealNamespaceDropdown.vue 与 CoreSidebar.vue数据编辑Editing data支持编辑表数据执行查询Running queries可在查询编辑器中直接对数据库执行 SurrealQL/SQL 查询导出Export支持将数据导出SSH 隧道SSH tunneling支持通过 SSH 隧道连接 SurrealDB 实例连接配置中的通用高级选项见表单中的CommonAdvanced组件。六、尚待实现的功能TBD以下功能官方文档明确标注为Todavía pendiente仍待实现在使用时需要注意规避导入Import暂不支持从文件向 SurrealDB 导入数据Schema 编辑Schema Editing暂不支持修改表结构/模式备份/恢复Backup/Restore暂不支持备份与恢复操作。这一点也可以从方言的disabledFeatures配置中得到印证importFromFile文件导入、alter结构变更、backup备份等能力在 SurrealDB 方言下均被显式禁用见 surrealdb.ts。七、连接 SurrealDB 的注意事项综合官方文档与仓库实现连接 SurrealDB 时有以下几点值得留意alpha 阶段定位官方文档明确说明这是对 SurrealDB 支持的早期实现团队正在持续更新建议定期关注文档与新版发布连接表单也会以警告横幅提示当前支持状态见 SurrealDBForm.vue。协议选择影响底层通信ws/wss走 WebSocket 通道http/https走 HTTP 通道两种通道适用于不同的 SurrealDB 部署形态本地开发常用ws/http生产环境建议使用带 TLS 的wss/https选择错误将导致无法连通。命名空间与数据库必须对应SurrealDB 的逻辑层级是命名空间Namespace→ 数据库Database→ 表连接时填写的 Namespace 与 Database 必须与实例中实际创建的一致否则即使认证通过也可能无法看到目标数据。认证方式影响可访问范围Root 拥有最高权限Namespace/Database 级用户仅能在其授权范围内操作选择 Token 认证时无需填写用户名密码但 Token 本身应具备足够的权限。功能边界要心中有数导入、Schema 编辑、备份/恢复等功能尚未就绪涉及这些操作时需要通过 SurrealDB 官方工具或命令行完成。结语本文以官方文档 surrealdb.es.md 为核心完整梳理了在 Beekeeper Studio 中连接 SurrealDB 的流程、连接参数、认证方式与功能支持现状并结合仓库源码连接表单 SurrealDBForm.vue、连接配置模型 types.ts、方言定义 surrealdb.ts 与数据库迁移 20250702_add_surrealdb_options.js做了底层印证。虽然 SurrealDB 支持尚处 alpha 阶段但表数据浏览、排序过滤、查询执行、数据编辑、导出与 SSH 隧道等核心能力已经可用足以支撑日常开发调试后续随着导入、Schema 编辑与备份恢复等能力补齐Beekeeper Studio 对 SurrealDB 的支持将更加完整。【免费下载链接】beekeeper-studioModern and easy to use SQL client for MySQL, Postgres, SQLite, SQL Server, and more. Linux, MacOS, and Windows.项目地址: https://gitcode.com/GitHub_Trending/be/beekeeper-studio创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考