Knex.js PGlite 发音
用于使用的方言 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数字 :
- 使用
satisfies PGliteConnectionConfig以强制执行connectionknex PGlite Dialect 所需的属性.- 确认它符合 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 软件 文档.
许可证
麻省理工学院