@dbsp/adapter-pgsql 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Olivier Orabona
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# @dbsp/adapter-pgsql
+
+[![npm version](https://img.shields.io/npm/v/@dbsp/adapter-pgsql.svg)](https://www.npmjs.com/package/@dbsp/adapter-pgsql)
+[![license](https://img.shields.io/npm/l/@dbsp/adapter-pgsql.svg)](LICENSE)
+
+PostgreSQL adapter for `@dbsp/core` — compiles semantic plan reports to parameterized SQL and executes against a `pg.Pool`.
+
+## Installation
+
+```bash
+pnpm add @dbsp/adapter-pgsql pg
+```
+
+## Quick Start
+
+```typescript
+import { createOrm } from '@dbsp/core';
+import { createPgsqlAdapter } from '@dbsp/adapter-pgsql';
+import { Pool } from 'pg';
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+
+const orm = createOrm({
+  schema: db,
+  adapter: createPgsqlAdapter(pool),
+});
+
+const rows = await orm.select('users').where(eq('active', true)).all();
+```
+
+## Compile-only mode
+
+Compile SQL without a database connection — useful for CLI tooling, CI plan inspection, and testing:
+
+```typescript
+import { createOrm, eq } from '@dbsp/core';
+import { createPgsqlCompileOnlyAdapter } from '@dbsp/adapter-pgsql';
+
+const adapter = createPgsqlCompileOnlyAdapter();
+const orm = createOrm({ schema: db, adapter });
+const { sql, params } = orm.select('users').where(eq('active', true)).dump();
+// sql, params — no Pool needed
+```
+
+## Key features
+
+- **Parameterized queries** — All user values use `$N` positional parameters; no SQL injection surface
+- **Identifier quoting** — All table/column/schema names are double-quoted automatically
+- **AST-based compiler** — SQL is built from the plan AST, never from string templates
+- **DDL provisioning** — `compareSchemata()` + `generateDDL()` with 12-phase topological sort
+- **Schema migrations** — `generateMigrationSQL()` with UP/DOWN sections and destructive-change safety gate
+- **Schema introspection** — Reflect live database structure back into `ModelIR`
+- **Row-Level Security** — `rlsEnabled` + `policies[]` on `TableIR`, compiled to `CREATE POLICY` DDL
+- **Streaming & cursors** — `orm.select(...).stream()` and server-side cursor support
+- **Indexes** — Create/drop/list indexes including GIN, HNSW, BM25 via `orm.tables.<name>.indexes`
+- **Runtime DDL helpers** — `truncate()`, `vacuum()`, `storageSize()`, `alterColumn()`
+- **Multi-tenant** — Respects `orm.withSchema(schemaName)` for all operations
+
+## Documentation
+
+- [Guides](https://oorabona.github.io/db-semantic-planner/guide/)
+- [DDL helpers guide](https://oorabona.github.io/db-semantic-planner/guide/ddl-helpers)
+- [RLS policies guide](https://oorabona.github.io/db-semantic-planner/guide/rls-policies)
+- [Schema versioning guide](https://oorabona.github.io/db-semantic-planner/guide/schema-versioning)
+
+## License
+
+MIT