# @electric-sql/pglite-sync 中文文档

规范地址：https://npmcn.com/package/%40electric-sql/pglite-sync/

版本：0\.6\.17
npm 元数据更新时间：2026-11-09T14:25:16.971Z
中文译文更新时间：2026-11-13T11:00:36.089Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40electric-sql/pglite-sync
原文对照：https://npmcn.com/package/%40electric-sql/pglite-sync/?lang=original
项目主页：https://pglite.dev/
源码仓库：https://github.com/electric-sql/pglite

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：145 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@electric-sql/pglite 0\.5\.16
- 首次发布：2024-08-12T09:20:57.490Z
- 最新版本发布：2026-11-09T14:25:16.584Z
- 近 30 天下载量：107945（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：68（近 12 个月 27 个）

## 中文简介

PGlite 的 Postgres 同步

## 安装

```sh
npm install @electric-sql/pglite-sync
```

也可以使用：`pnpm add @electric-sql/pglite-sync`、`yarn add @electric-sql/pglite-sync`、`bun add @electric-sql/pglite-sync`

## README

# PGlite Postgres 同步插件

A 类 [同步插件](https://pglite.dev/docs/sync) 页:1 [PGlite 读取](https://pglite.dev/) 使用 [电器](https://electric.ax/)。完整的文件可在 [pglite.dev/docs/ sync (英语)](https://pglite.dev/docs/sync)。 。 。 .

要安装 :

```sh
npm install @electric-sql/pglite-sync
```

并创建所需的本地表格:

```ts
import { electricSync } from '@electric-sql/pglite-sync'

const pg = await PGlite.create({
  extensions: {
    electric: electricSync(),
  },
})

await pg.exec(`
  CREATE TABLE IF NOT EXISTS todo (
    id SERIAL PRIMARY KEY,
    task TEXT,
    done BOOLEAN
  );
`)
```

您可以使用单个表格或多表 API 同步来自 Electric 的数据 :

### 单表同步

使用 `syncShapeToTable` 以同步单个表格 :

```ts
const shape = await pg.electric.syncShapeToTable({
  shape: { url: 'http://localhost:3000/v1/shape', table: 'todo' },
  shapeKey: 'todo', // or null if the shape state does not need to be persisted
  table: 'todo',
  primaryKey: ['id'],
  onError: (error) => {
    console.error('Shape sync error', error)
  }
})
```

### 多表同步

多表 API 当您需要同步相关表格时是有用的, 通过同步 PGLite 中作为单项交易在 Postgres 中发生的更新来保证多个表格的一致性 .

使用 `syncShapesToTables` 以同步多个表格:

```ts
const sync = await pg.electric.syncShapesToTables({
  shapes: {
    todos: {
      shape: { url: 'http://localhost:3000/v1/shape', table: 'todo' },
      table: 'todo',
      primaryKey: ['id'],
    },
    users: {
      shape: { url: 'http://localhost:3000/v1/shape', table: 'users' },
      table: 'users',
      primaryKey: ['id'],
    }
  },
  key: 'my-sync', // or null if the sync state does not need to be persisted
  onInitialSync: () => {
    console.log('Initial sync complete')
  },
  onError: (error) => {
    console.error('Sync error', error)
  }
})

// Unsubscribe when done
sync.unsubscribe()
```

## 常见问题

### @electric-sql/pglite-sync 是什么？

PGlite 的 Postgres 同步

### 如何安装 @electric-sql/pglite-sync？

在项目目录运行 npm install @electric-sql/pglite-sync，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@electric-sql/pglite（0\.5\.16）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @electric-sql/pglite-sync 支持 TypeScript 吗？

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

### @electric-sql/pglite-sync 支持 ESM 还是 CommonJS？

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

### @electric-sql/pglite-sync 可以商用吗？

@electric-sql/pglite-sync 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @electric-sql/pglite-sync 的下载量有多少？

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

### @electric-sql/pglite-sync 还在维护吗？

最新版本 0\.6\.17 发布于 2026/11/09（4 天前）；至今共发布 68 个版本，其中过去 12 个月发布了 27 个；首次发布于 2024/08/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。