PGlite:在浏览器中运行Postgres的轻量级解决方案
pglite 项目地址: https://gitcode.com/gh_mirrors/pg/pglite
项目介绍
PGlite是由ElectricSQL团队开发的一个创新项目,它将Postgres数据库编译为WebAssembly(WASM),并封装成一个TypeScript客户端库。通过PGlite,开发者可以在浏览器、Node.js、Bun和Deno等环境中直接运行Postgres,无需安装任何其他依赖。PGlite的体积仅为3MB(压缩后),并且支持多种Postgres扩展,如pgvector。
项目技术分析
PGlite的核心技术是将Postgres编译为WASM,并通过Emscripten实现与JavaScript环境的交互。传统的Postgres使用进程分叉模型来管理客户端连接,但WASM不支持进程分叉,因此PGlite利用Postgres的“单用户模式”来实现这一功能。这种模式主要用于命令行工具,PGlite在此基础上引入了输入/输出路径,使得Postgres在WASM环境中能够正常运行。
项目及技术应用场景
PGlite适用于多种场景,特别是在需要轻量级、快速启动的数据库解决方案时:
- 前端开发:在浏览器中运行Postgres,实现本地数据存储和查询,适用于需要离线功能的Web应用。
- 后端开发:在Node.js、Bun和Deno等环境中使用PGlite,作为轻量级的嵌入式数据库。
- 实时应用:结合ElectricSQL的其他组件,构建反应式、实时的本地优先应用。
项目特点
- 轻量级:PGlite的体积仅为3MB(压缩后),适合在资源受限的环境中使用。
- 跨平台:支持浏览器、Node.js、Bun和Deno等多种运行环境。
- 持久化:支持将数据持久化到文件系统(Node/Bun/Deno)或indexedDB(浏览器)。
- 扩展支持:支持多种Postgres扩展,如pgvector。
- 开源:PGlite采用Apache 2.0和PostgreSQL双重许可,开发者可以根据需要选择合适的许可。
如何开始
浏览器环境
你可以通过npm或CDN导入PGlite:
import { PGlite } from "@electric-sql/pglite";
或者使用CDN:
import { PGlite } from "https://cdn.jsdelivr.net/npm/@electric-sql/pglite/dist/index.js";
创建一个内存数据库:
const db = new PGlite();
await db.query("select 'Hello world' as message;");
// -> { rows: [ { message: "Hello world" } ] }
或者将数据持久化到indexedDB:
const db = new PGlite("idb://my-pgdata");
Node/Bun/Deno环境
安装PGlite:
NodeJS
npm install @electric-sql/pglite
Bun
bun install @electric-sql/pglite
Deno
deno add npm:@electric-sql/pglite
创建一个内存数据库:
import { PGlite } from "@electric-sql/pglite";
const db = new PGlite();
await db.query("select 'Hello world' as message;");
// -> { rows: [ { message: "Hello world" } ] }
或者将数据持久化到文件系统:
const db = new PGlite("./path/to/pgdata");
贡献与社区
PGlite是一个开源项目,欢迎开发者贡献代码。你可以通过以下步骤开始贡献:
- 安装pnpm和Node.js(v20及以上)。
- 下载Postgres WASM构建文件,并放置在
packages/pglite/release
目录下。 - 安装依赖并构建项目:
pnpm install
pnpm build
- 开发和测试你的代码,确保通过
stylecheck
和typecheck
检查。 - 提交PR时,运行
pnpm changeset
并按照指示创建适当的changeset。
结语
PGlite为开发者提供了一个轻量级、跨平台的Postgres解决方案,特别适合需要快速启动和离线功能的应用场景。无论你是前端开发者还是后端开发者,PGlite都能为你带来便利。快来尝试PGlite,体验在浏览器中运行Postgres的乐趣吧!