# @pgpmjs/pglite-adapter
A PGlite driver for pgpm. It registers an **in-process** [PGlite](https://github.com/electric-sql/pglite)
instance (WASM Postgres) as the `pg-cache` pool factory, so the **unmodified**
pgpm engine deploys, verifies, and reverts migrations against PGlite with **no
Postgres server and no socket**.
All `@electric-sql/pglite*` dependencies live here — `@pgpmjs/core`, `pg-cache`,
and `pgsql-test` never import them.
## Install
```sh
npm install @pgpmjs/pglite-adapter @electric-sql/pglite
```
`@electric-sql/pglite` is a peer dependency, so you pin the version.
## How it works
pgpm's engine only needs a node-`pg`-shaped pool (`query` / `connect` / `end`).
Step 1 added a driver seam in `pg-cache` (`registerPgPoolFactory`). This package
implements that seam against PGlite's JS API:
- parameterized queries → `db.query` (extended protocol)
- parameterless / multi-statement SQL (pgpm's bootstrap) → `db.exec`
Because PGlite is a single in-process session, both `pool.query` and the client
returned by `connect()` share one session — so pgpm's transactional deploy works
without the socket PoC's `useTransaction: false` workaround.
## Usage
```ts
import { PgpmMigrate } from '@pgpmjs/core';
import { registerPglite } from '@pgpmjs/pglite-adapter';
const { db, close } = await registerPglite();
const migrate = new PgpmMigrate({ database: 'postgres' /* ...pg config */ });
await migrate.deploy({ modulePath: './my-module' });
await migrate.verify({ modulePath: './my-module' });
await close(); // restores the previous factory and closes PGlite
```
### As a pgpm CLI engine
The package also exports the pgpm driver-plugin entrypoint (`createPgpmDriver`),
so the `pgpm` CLI can deploy into PGlite with no server once this package is
installed in the workspace being deployed:
```sh
pgpm deploy --engine pglite --package pets --database anything --yes
pgpm deploy --pglite=./.pglite --package pets --database anything --yes # persisted
```
Or make it the workspace default in `pgpm.json`:
```json
{
"packages": ["packages/*"],
"engine": "pglite",
"engines": { "pglite": { "options": { "dataDir": "./.pglite" } } }
}
```
The options are the same `PgliteAdapterOptions` as `registerPglite`. The
driver reports `createdb`/`dump`/`serverLifecycle`/`multiConnection` as false, so
pgpm skips `deploy --createdb` and refuses `pgpm dump`, `pgpm docker`, `pgpm kill`,
`pgpm tune` and `pgpm admin-users` on this engine.
### Extensions
pgpm's `cleanSql` strips `CREATE EXTENSION` from migrations, so extensions are
provisioned out-of-band — register the WASM extension at construction and run
`CREATE EXTENSION` at bootstrap:
```ts
import { vector } from '@electric-sql/pglite-pgvector';
const { db, close } = await registerPglite({
extensions: { vector },
extensionSql: ['CREATE EXTENSION IF NOT EXISTS vector;']
});
```
---
## Education and Tutorials
1. 🚀 [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
Get started with modular databases in minutes. Install prerequisites and deploy your first module.
2. 📦 [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
3. ✏️ [Authoring Database Changes](https://constructive.io/learn/authoring-database-changes)
Master the workflow for adding, organizing, and managing database changes with pgpm.
4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://constructive.io/learn/e2e-postgres-testing)
Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
5. ⚡ [Supabase Testing](https://constructive.io/learn/supabase)
Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
6. 💧 [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
7. 🔧 [Troubleshooting](https://constructive.io/learn/troubleshooting)
Common issues and solutions for pgpm, PostgreSQL, and testing.
## Related Constructive Tooling
### 📦 Package Management
* [pgpm](https://github.com/constructive-io/constructive/tree/main/pgpm/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
### 🧪 Testing
* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
* [pglite-test](https://github.com/constructive-io/constructive/tree/main/postgres/pglite-test): **🪶 Drop-in pgsql-test replacement backed by PGlite** — in-process Postgres, no server required, instance-per-suite isolation.
* [pgsql-seed](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-seed): **🌱 PostgreSQL seeding utilities** for CSV, JSON, SQL data loading, and pgpm deployment.
* [supabase-test](https://github.com/constructive-io/constructive/tree/main/postgres/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
* [graphile-test](https://github.com/constructive-io/constructive/tree/main/graphile/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/postgres/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
### 🧠 Parsing & AST
* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
* [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
* [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
### 📚 Documentation & Skills
* [constructive-skills](https://github.com/constructive-io/constructive-skills): **📖 Platform documentation and AI agent skills** — feature catalog, blueprint reference, SDK guides (i18n, billing, limits, events, uploads, security, entities, search, AI), and deployment guides.
Install skills for AI coding agents:
```bash
# All platform skills (security, blueprints, codegen, billing, etc.)
npx skills add constructive-io/constructive-skills
# Individual repo skills (pgpm, testing, CLI, search, etc.)
npx skills add https://github.com/constructive-io/constructive --skill pgpm
npx skills add https://github.com/constructive-io/constructive --skill constructive-testing
```
## Credits
**🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
## Disclaimer
AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.