pg_crdt 项目教程

pg_crdt 项目教程

pg_crdt POC CRDT support in Postgres 项目地址: https://gitcode.com/gh_mirrors/pg/pg_crdt

1. 项目介绍

pg_crdt 是一个实验性的 PostgreSQL 扩展，旨在为 Postgres 添加对冲突自由复制数据类型（CRDTs）的支持。CRDTs 是一种去中心化的数据结构，可以在多个计算机/节点之间安全地复制和同步。它们是协作编辑应用程序（如 Notion）的关键技术。

该项目的目标是评估是否可以利用基于 Postgres 的 CRDT 和 Supabase 现有的实时 API 进行变更数据捕获，以在 Supabase 平台上启用协作应用程序的开发。pg_crdt 扩展是一个概念验证，它使用 pgx 框架包装了 Rust 的 yrs 和 automerge 库，以添加 Postgres 原生 CRDT。

2. 项目快速启动

安装 Docker

首先，确保你已经安装了 Docker。然后按照以下步骤操作：

# 克隆项目仓库
git clone https://github.com/supabase/pg_crdt.git

# 进入项目目录
cd pg_crdt

# 启动 Docker 容器
docker-compose up

启用扩展

在 Postgres 中启用 pg_crdt 扩展：

-- 创建扩展
CREATE EXTENSION pg_crdt;

创建和使用 CRDT 表

-- 创建一个包含 CRDT 列的表
CREATE TABLE posts (
    id SERIAL PRIMARY KEY,
    content CRDT_YDOC DEFAULT CRDT_NEW_YDOC()
);

-- 插入一行数据
INSERT INTO posts (content) VALUES (CRDT_NEW_YDOC()) RETURNING id;

-- 更新 CRDT 内容
UPDATE posts SET content = CRDT_MERGE(content, CRDT_NEW_YDOC()) WHERE id = 1;

3. 应用案例和最佳实践

应用案例

pg_crdt 可以用于构建协作编辑应用程序，如多人同时编辑文档或表格。例如，一个团队可以共同编辑一个文档，每个成员的更改都会实时同步到所有其他成员的视图中。

最佳实践

1. 频繁更新处理：由于频繁更新的 CRDT 会产生大量 WAL 和死元组，建议在设计数据库时考虑这些因素，并优化数据库配置以处理高频率的更新。
2. 序列化/反序列化优化：对于大型 CRDT 类型，确保在更新时进行有效的序列化和反序列化，以减少性能开销。
3. 实时广播优化：使用 Supabase 的实时 API 广播数据库更改时，考虑优化广播机制，避免不必要的全量数据广播。

4. 典型生态项目

Supabase Realtime

Supabase Realtime 是一个实时数据库变更广播服务，可以与 pg_crdt 结合使用，实现数据库变更的实时同步。

Yjs 和 Automerge

pg_crdt 扩展使用了 Yjs 和 Automerge 库，这两个库是实现 CRDT 的核心组件。Yjs 主要用于协作编辑，而 Automerge 则提供了更通用的 CRDT 支持。

pgx

pgx 是一个 Rust 框架，用于构建 PostgreSQL 扩展。pg_crdt 使用 pgx 来实现 Postgres 原生 CRDT 支持。

通过这些生态项目的结合，pg_crdt 可以为开发者提供一个强大的工具集，用于构建高效的协作应用程序。

pg_crdt POC CRDT support in Postgres 项目地址: https://gitcode.com/gh_mirrors/pg/pg_crdt