pg-mem 中适配器(adapters)的正确使用方法

在使用 pg-mem 这个内存 PostgreSQL 模拟库时，开发者可能会遇到一个常见的类型错误："Property 'adapters' does not exist on type '(opts?: MemoryDbOptions) => IMemoryDb'"。这个错误通常是由于对 pg-mem 的 API 使用方式理解有误导致的。

问题本质

pg-mem 从版本 3.0.0 开始，API 设计发生了一些变化。newDb 现在是一个函数，而不是直接包含属性的对象。开发者需要先调用这个函数创建一个数据库实例，然后才能访问其上的 adapters 属性。

正确用法

正确的使用方式应该是：

import { newDb } from 'pg-mem';

// 创建数据库实例
const db = newDb();

// 然后访问adapters属性创建pg-promise适配器
const pg = await db.adapters.createPgPromise();

// 像使用普通pg-promise一样使用它
await pg.connect();

版本变化说明

在 pg-mem 3.0.0 之前的版本中，API 设计可能允许直接通过 newDb.adapters 访问适配器。但在 3.0.0 及之后的版本中，这种用法已经不再支持。这种变化使得 API 设计更加清晰和一致，因为：

1. 明确区分了数据库创建和操作两个阶段
2. 避免了全局状态的污染
3. 提供了更好的类型安全

适配器的作用

pg-mem 的适配器系统允许开发者使用熟悉的 PostgreSQL 客户端库（如 pg-promise）来操作内存数据库。这些适配器会：

• 将标准 PostgreSQL 客户端调用转换为 pg-mem 的内部操作
• 保持与真实 PostgreSQL 相似的接口和行为
• 提供无缝的迁移体验

最佳实践

对于使用 pg-mem 的开发者，建议：

1. 始终查阅对应版本的官方文档
2. 在升级 pg-mem 版本时注意检查 API 变更
3. 使用 TypeScript 以获得更好的类型提示和错误检查
4. 考虑将数据库实例创建封装为单独的函数，便于管理和测试

通过正确理解和使用 pg-mem 的 API 设计，开发者可以充分利用这个强大的内存数据库模拟工具，为单元测试和开发环境提供便利。