示例应用导览
逐屏带你逛一遍 SQLly Embedded 附带的示例管理应用:状态与许可、配置文件与连接、标签、用户,以及启动 SQLly。
该软件包包括一个小型管理应用程序(sample-app/,Node.js 20+、无依赖),它把 SQLly Embedded 能做的事全部演练一遍。它扮演的是 你的 应用:管理端负责连接配置、标签和用户,用户端负责让人登录并打开 SQLly。下面的每个界面都只是对一到两个 管理 API 调用,它们的名字标在每个截图下方,这样你能看到你自己的应用会调用什么。
这些截图来自连接着试用许可证的真实桥接,背后是 SQL Server 的 Northwind 数据库。
管理员登录
状态和许可
状态 是 GET /manage/status 渲染为页面。没有密钥或许可证文件启动的桥接是 未授权:你已经可以创建和测试连接配置,但在关联安装之前,SQLly 不会启动。
连接到 sqlly.app 向 sqlly.app 请求一个链接码(POST /api/embedded/links)并显示它。 打开 sqlly.app 进行批准 会把许可证持有者带到 sqlly.app,在那里确认相同的代码并选择一个许可证:
几秒后,管理应用会收集安装密钥并将其交给桥接,同时附上 PUT /manage/license,而 Status 会显示许可证:
配置文件
配置文件是某一组用户可见的连接集合。列表会显示每个配置文件的连接及分配给它的用户,并提供 启动 即可打开一个从该节点所在行开始的查询标签页。
编辑连接
连接编辑器会提供凭据格式为所选引擎定义的所有字段。引擎列表和每个引擎的登录类型来自 GET /manage/engines. 测试 会检查表单上的内容,无论是否已保存,并就地显示引擎本身的答复:
标签
客户、项目和环境为 SQLly 中的连接着色并分组,同时带有安全规则。示例应用维护一份共享集合,并随每个配置文件一起发送,因此重命名一处,所有用到它的连接都会跟着更新。
用户和席位
示例应用的用户是它自己的账户,每个账户分配一个配置文件。在你的应用里,用户及其访问权限就用你现有的那套。该页面还会显示当前占用席位的都有谁(GET /manage/seats),带有 释放席位 (DELETE /manage/seats/{user}).
你的用户看到的内容
用户在应用的根路径登录,而不是在 /admin 下:
SQLly 打开期间,状态会显示正在使用的席位:
阅读代码
| 文件 | 从中可以获取什么 |
|---|---|
lib/bridge.js | 一个完整的管理 API 客户端:每一个调用、错误处理、超时。复制或移植它。 |
lib/credentials.js | 将表单字段和共享标签转换为一个 sqlly-credentials 文档。 |
lib/sqllyapp.js | sqlly.app 一侧的关联流程:创建关联记录,然后轮询获取密钥。 |
server.js | 路由。 GET /app/ 是入口路由; /admin/* 是管理端; /admin/link* 负责链接。 |
views/pages.js | HTML,包括 injectLaunch,它会先设置这两个全局变量,然后 boot.js. |
test/ | node --test 针对模拟桥接运行应用程序的测试套件。是测试你自己集成的好范例。 |
准备好换掉它了吗? 构建自己的应用 会带你逐一过一遍你自己技术栈里的每一项工作。