rxdb-adapter-pglite
RxDB 适配器,使用 PGlite 在浏览器中运行 PostgreSQL。
功能特性
- 本地优先: 在浏览器中通过 WebAssembly 运行完整 PostgreSQL
- 零服务器: 无需后端服务器,数据存储在本地
- PostgreSQL 兼容: 支持标准 PostgreSQL 语法和功能
- 响应式: 数据变化自动触发更新
安装
npm install @aiao/rxdb-adapter-pglite
# 或
pnpm add @aiao/rxdb-adapter-pglite
使用
import { createRxdb } from '@aiao/rxdb';
import { createPgliteAdapter } from '@aiao/rxdb-adapter-pglite';
const db = await createRxdb({
adapter: createPgliteAdapter()
});
Enumerations
| Enumeration | Description |
|---|---|
| PGliteChangeType | PGlite 变更事件类型枚举 对应 PostgreSQL 的 TG_OP (trigger operation) |
Classes
| Class | Description |
|---|---|
| PGliteClient | 事件调度器 提供类型安全的事件添加、移除和分发功能 |
| PostgreSQLDialect | PostgreSQL 方言实现 |
| RxDBAdapterPGlite | RxDB PGlite 适配器 |
| RxdbAdapterPGliteError | PGlite 适配器错误类 |
Interfaces
| Interface | Description |
|---|---|
| IPGliteClient | - |
| ISqlDialect | SQL 方言接口 定义数据库特定的 SQL 语法转换方法 |
| PGliteChangeEvent | PGlite 变更事件 触发器通过 NOTIFY 发送的数据库变更事件 |
| PGliteClientEvents | PGlite 客户端事件映射 |
| PGliteClientOptions | PGlite 客户端配置选项 扩展自 PGlite 原生配置 |
| PGliteNotifyPayload | PGlite 通知 payload 结构 从 NOTIFY 消息中解析的数据 |
| PgliteTableColumn | PGlite 数据库表列信息接口 包含 PostgreSQL information_schema.columns 视图的所有字段 |
Type Aliases
| Type Alias | Description |
|---|---|
| ForeignKey | 外键约束信息类型 描述表之间的外键关系 |
Variables
| Variable | Description |
|---|---|
| ADAPTER_NAME | PGlite 适配器名称常量 |
| pgDialect | 默认导出 PostgreSQL 方言实例 |