@harryplusplus/knex-pglite

中文文档
0.13.13发布于 2025/10/14MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 10万

以克能克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克.

中文使用文档
文档目录10 节
  1. 目录
  2. 语言
  3. 安装
  4. 使用量
  5. 简单初始化
  6. 注入 PGlite 实例
  7. API 密码
  8. client
  9. connection
  10. 许可证

Knex.js PGlite 发音

test npm version npm downloads

用于使用的方言 PGlite 读取 与 Knex.js (英语)。 。 。 .

目录

语言

安装

以下列命令安装 .

# using npm
npm i knex @electric-sql/pglite @harryplusplus/knex-pglite
# using pnpm
pnpm add knex @electric-sql/pglite @harryplusplus/knex-pglite

[尖叫声]
雅伦 财务报告和审定财务报表 阿宝 环境尚未测试兼容性.

使用量

简单初始化

配置 client 财务报告和审定财务报表 connection knex 创建函数的属性. 其价值 connection 属性用作 dataDir pGlite 构造器的参数.

[注]
详细规格: dataDir 在 PGlite 构造器中,请参见 PGLITE API 软件 dataDir 文档.

下面的例子说明了如何进行简单的初始化.

import { PGliteDialect } from "@harryplusplus/knex-pglite";
import Knex from "knex";

const knex = Knex({
  client: PGliteDialect, // Knex PGlite Dialect

  // In-memory ephemeral storage
  connection: {},
  connection: "",
  connection: "memory://",

  // IndexedDB storage
  connection: "idb://",

  // File system storage
  connection: "/my/pglite/data",
});

[尖叫声]
没有 connection 属性, Knex 运行于 未连接模式。 。 。 . 由于未连接模式是 SQL 字符串生成器,所以您必须定义一个值,即使它是一个空对象,才能使用 PGlite .

[尖叫声]
connection 文件 URI 形式的值(例如). file:///my/pglite/data)不能使用,因为它们不以适合按照当前 Knex 连接字符串解析规则初始化的 PGlite 格式解析. 请输入文件路径( 例如 ) . /my/pglite/data)而不是文件URI.

注入 PGlite 实例

使用时 简单初始化 pGlite 实例变成 拥有 以Knex为例. 换句话说,PGlite实例与Knex实例分享其生命周期.

对于具有模拟临时存储的 PGlite 实例,与 Knex 实例共享生命周期可能无法满足您的需要, 取决于您的使用情况 . 此外,不能使用PGlite初始化的各种参数.

配置 connection.pglite 属性到返回 PGlite 实例的同步或同步函数. 在这种情况下,克涅斯公司内部认为PGlite案是在下列情况下发生的: 借款 状态. 换句话说,Knex无法管理PGlite实例的创建和销毁,因为它将PGlite实例的生命周期委托给外部实体.

下面的例子说明如何注入PGlite实例.

import { PGlite } from "@electric-sql/pglite";
import Knex from "knex";
import {
  PGliteConnectionConfig,
  PGliteDialect,
} from "@harryplusplus/knex-pglite";

const pglite = new PGlite();

const knex = Knex({
  client: PGliteDialect,
  connection: {
    pglite: () => pglite,
  } satisfies PGliteConnectionConfig as Knex.Knex.StaticConnectionConfig,
});

[注]
这就是为什么我们使用 satisfies PGliteConnectionConfig as Knex.Knex.StaticConnectionConfig数字 :

  1. 使用 satisfies PGliteConnectionConfig 以强制执行 connection knex PGlite Dialect 所需的属性.
  2. 确认它符合 Knex 类型定义 as Knex.Knex.StaticConnectionConfig。 。 。 .

API 密码

从 Knex 创建函数的参数配置以下属性:

client

要使用 Knex PGlite 对话框, 您必须指定 PGliteDialect 类别 client 属性.

connection

类型 connection 属性为:

export interface PGliteConnectionConfig {
  pglite?: PGliteProvider;
}

以下是配置属性 connection。 。 。 .

pglite

类型 pglite 属性是:

export interface PGliteProvider {
  (): MaybePromise<PGlite>; // (): PGlite | Promise<PGlite>
}

[注]
欲了解PGlite的各种特征,请阅读 PGLITE API 软件 文档.

许可证

麻省理工学院

版本与发布记录

@harryplusplus/knex-pglite 共发布 40 个版本,首次发布于 2025/10/05;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.13.13latest2025/10/141.1 年前
0.13.122025/10/141.1 年前
0.13.112025/10/141.1 年前
0.13.102025/10/141.1 年前
0.13.92025/10/141.1 年前
0.13.82025/10/141.1 年前

其他发布通道:dev → 0.1.1-dev.3。

关于 @harryplusplus/knex-pglite 的常见问题

@harryplusplus/knex-pglite 是什么?

以克能克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克.

如何安装 @harryplusplus/knex-pglite?

在项目目录运行 npm install @harryplusplus/knex-pglite,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@electric-sql/pglite(^0.3.10)、knex(^3.1.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@harryplusplus/knex-pglite 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@harryplusplus/knex-pglite 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@harryplusplus/knex-pglite 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >= 20.19.5。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@harryplusplus/knex-pglite 可以商用吗?

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

@harryplusplus/knex-pglite 的下载量有多少?

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

@harryplusplus/knex-pglite 还在维护吗?

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