@devoxa/integresql-client

中文文档
2.1.2发布于 2025/05/02MITCommonJS近 30 天下载 6.9万

在集成测试中管理孤立的 PostgreSQL 数据库的IntegreSQL 客户端

中文使用文档
文档目录8 节
  1. 安装
  2. 使用量
  3. 完整实例
  4. 分步指南
  5. 帮助者
  6. API 请求
  7. 贡献者
  8. 许可证

integresql 客户端

整合SQL 在集成测试中管理孤立的 PostgreSQL 数据库的客户端

Package Version Build Status Code Coverage

安装 二. 支助 使用量 二. 支助 贡献者 二. 支助 许可证


安装

yarn add --dev @devoxa/integresql-client

要安装IntegreSQL, 请跟随他们 安装指令。 。 。 .

使用量

完整实例

举个例子,你看看 融合测试。 。 。 .

分步指南

  1. 初始化 IntegreSQL 客户端
import { IntegreSQLClient } from '@devoxa/integresql-client'

const integreSQL = new IntegreSQLClient({ url: 'http://localhost:5000' })
// options.url: The URL of the IntegreSQL instance
  1. (每一次试跑程序) 获取迁移设置的散列( T)
// The hash can be generated in any way that fits your business logic, the included
// helper creates a SHA1 hash of the file content of all files matching the glob patterns.
const hash = await integreSQL.hashFiles(['./migrations/**/*', './fixtures/**/*'])
  1. (每一次试跑程序) 初始化模板数据库
await integreSQL.initializeTemplate(hash, async (databaseConfig) => {
  await migrateTemplateDatabase(databaseConfig)
  await seedTemplateDatabase(databaseConfig)
  await disconnectFromDatabase(databaseConfig)
})
  1. (每次试验之前) 获取一个孤立的测试数据库
const databaseConfig = await integreSQL.getTestDatabase(hash)

帮助者

  • integreSQL.databaseConfigToConnectionUrl(databaseConfig)

API 请求

您可以直接通过包含的 API 客户端向 IntegreSQL 实例发送请求, 或者可选择 切换新的 IntegreSQLApiClient 你自己来.

await integreSQL.api.reuseTestDatabase(hash, id)

const api = new IntegreSQLApiClient({ url: 'http://localhost:5000' })
await api.reuseTestDatabase(hash, id)

贡献者

感谢这些伟大的人emoji 密钥:

David Reeß
大卫·瑞斯

💻 📖 ⚠️
Pedro Saratscheff
佩德罗·萨拉特谢夫

💻 ⚠️

本项目遵循 全部贡献者 规格。 任何捐款都欢迎!

许可证

麻省理工学院

版本与发布记录

@devoxa/integresql-client 共发布 6 个版本,首次发布于 2023/02/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.1.2latest2025/05/021.5 年前
2.1.12024/11/162 年前
2.1.02024/11/162 年前
2.0.02023/07/293 年前
1.0.12023/05/193 年前
1.0.02023/02/043 年前

关于 @devoxa/integresql-client 的常见问题

@devoxa/integresql-client 是什么?

在集成测试中管理孤立的 PostgreSQL 数据库的IntegreSQL 客户端

如何安装 @devoxa/integresql-client?

在项目目录运行 npm install @devoxa/integresql-client,或使用 pnpm add / yarn add / bun add。

@devoxa/integresql-client 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/devoxa__integresql-client 是否存在。

@devoxa/integresql-client 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@devoxa/integresql-client 可以商用吗?

@devoxa/integresql-client 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@devoxa/integresql-client 的下载量有多少?

根据 npm 官方下载统计,@devoxa/integresql-client 在 2026/10/12 – 2026/11/10 这 30 天内被下载 68,895 次,日均约 2,297 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@devoxa/integresql-client 还在维护吗?

最新版本 2.1.2 发布于 2025/05/02(1.5 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/02/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。