pgsql-seed 0.2.0 → 0.2.2

package/README.md

@@ -16,33 +16,83 @@
   </a>
 </p>
 
-PostgreSQL seeding utilities with pgpm integration - batteries included.
-
-This package re-exports everything from [`pg-seed`](https://www.npmjs.com/package/pg-seed) and adds pgpm deployment functionality.
+PostgreSQL seeding utilities for CSV, JSON, SQL data loading, and pgpm deployment.
 
 ## Installation
 
 ```bash
 npm install pgsql-seed
-# or
-pnpm add pgsql-seed
 ```
 
 ## Usage
 
-### All pg-seed utilities are available
+### CSV Loading (COPY protocol)
 
 ```typescript
-import { 
-  loadCsv, loadCsvMap, exportCsv,  // CSV utilities
-  insertJson, insertJsonMap,        // JSON utilities
-  loadSql, loadSqlFiles, execSql    // SQL utilities
-} from 'pgsql-seed';
+import { Client } from 'pg';
+import { loadCsv, loadCsvMap, exportCsv } from 'pgsql-seed';
+
+const client = new Client();
+await client.connect();
+
+// Load a single CSV file
+await loadCsv(client, 'users', './data/users.csv');
+
+// Load multiple CSV files
+await loadCsvMap(client, {
+  'users': './data/users.csv',
+  'orders': './data/orders.csv'
+});
+
+// Export a table to CSV
+await exportCsv(client, 'users', './backup/users.csv');
 ```
 
-See the [pg-seed documentation](https://www.npmjs.com/package/pg-seed) for details on these utilities.
+### JSON Insertion
+
+```typescript
+import { Client } from 'pg';
+import { insertJson, insertJsonMap } from 'pgsql-seed';
+
+const client = new Client();
+await client.connect();
+
+// Insert rows into a single table
+await insertJson(client, 'users', [
+  { name: 'Alice', email: 'alice@example.com' },
+  { name: 'Bob', email: 'bob@example.com' }
+]);
+
+// Insert rows into multiple tables
+await insertJsonMap(client, {
+  'users': [{ name: 'Alice', email: 'alice@example.com' }],
+  'orders': [{ user_id: 1, total: 99.99 }]
+});
+```
+
+### SQL File Execution
+
+```typescript
+import { Client } from 'pg';
+import { loadSql, loadSqlFiles, execSql } from 'pgsql-seed';
+
+const client = new Client();
+await client.connect();
+
+// Execute a single SQL file
+await loadSql(client, './migrations/001-schema.sql');
+
+// Execute multiple SQL files
+await loadSqlFiles(client, [
+  './migrations/001-schema.sql',
+  './migrations/002-data.sql'
+]);
+
+// Execute a SQL string with parameters
+await execSql(client, 'INSERT INTO users (name) VALUES ($1)', ['Alice']);
+```
 
-### pgpm Integration
+### pgpm Deployment
 
 Deploy pgpm packages directly from your code:
 
@@ -67,10 +117,19 @@ await deployPgpm(config, '/path/to/package');
 await deployPgpm(config, undefined, true);
 ```
 
-## When to use pg-seed vs pgsql-seed
+## Client Compatibility
+
+All functions accept either a raw `pg.Client`/`pg.PoolClient` or any wrapper object that exposes a `.client` property containing the underlying pg client. This makes it compatible with testing utilities like `PgTestClient`.
+
+```typescript
+// Works with raw pg.Client
+const client = new Client();
+await loadCsv(client, 'users', './data/users.csv');
 
-- Use **`pg-seed`** if you only need CSV/JSON/SQL seeding and want a lightweight package with no pgpm dependency
-- Use **`pgsql-seed`** if you need pgpm deployment functionality or want a single package with all seeding utilities
+// Works with wrappers that have a .client property
+const testClient = new PgTestClient(config);
+await loadCsv(testClient, 'users', './data/users.csv');
+```
 
 ---
 
@@ -99,9 +158,14 @@ 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.
+* [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.
@@ -115,28 +179,6 @@ Common issues and solutions for pgpm, PostgreSQL, and testing.
 * [@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.
 
-### 🚀 API & Dev Tools
-
-* [@constructive-io/graphql-server](https://github.com/constructive-io/constructive/tree/main/graphql/server): **⚡ Express-based API server** powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
-* [@constructive-io/graphql-explorer](https://github.com/constructive-io/constructive/tree/main/graphql/explorer): **🔎 Visual API explorer** with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.
-
-### 🔁 Streaming & Uploads
-
-* [etag-hash](https://github.com/constructive-io/constructive/tree/main/streaming/etag-hash): **🏷️ S3-compatible ETags** created by streaming and hashing file uploads in chunks.
-* [etag-stream](https://github.com/constructive-io/constructive/tree/main/streaming/etag-stream): **🔄 ETag computation** via Node stream transformer during upload or transfer.
-* [uuid-hash](https://github.com/constructive-io/constructive/tree/main/streaming/uuid-hash): **🆔 Deterministic UUIDs** generated from hashed content, great for deduplication and asset referencing.
-* [uuid-stream](https://github.com/constructive-io/constructive/tree/main/streaming/uuid-stream): **🌊 Streaming UUID generation** based on piped file content—ideal for upload pipelines.
-* [@constructive-io/s3-streamer](https://github.com/constructive-io/constructive/tree/main/streaming/s3-streamer): **📤 Direct S3 streaming** for large files with support for metadata injection and content validation.
-* [@constructive-io/upload-names](https://github.com/constructive-io/constructive/tree/main/streaming/upload-names): **📂 Collision-resistant filenames** utility for structured and unique file names for uploads.
-
-### 🧰 CLI & Codegen
-
-* [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.
-* [@constructive-io/cli](https://github.com/constructive-io/constructive/tree/main/packages/cli): **🖥️ Command-line toolkit** for managing Constructive projects—supports database scaffolding, migrations, seeding, code generation, and automation.
-* [@constructive-io/graphql-codegen](https://github.com/constructive-io/constructive/tree/main/graphql/codegen): **✨ GraphQL code generation** (types, operations, SDK) from schema/endpoint introspection.
-* [@constructive-io/query-builder](https://github.com/constructive-io/constructive/tree/main/packages/query-builder): **🏗️ SQL constructor** providing a robust TypeScript-based query builder for dynamic generation of `SELECT`, `INSERT`, `UPDATE`, `DELETE`, and stored procedure calls—supports advanced SQL features like `JOIN`, `GROUP BY`, and schema-qualified queries.
-* [@constructive-io/graphql-query](https://github.com/constructive-io/constructive/tree/main/graphql/query): **🧩 Fluent GraphQL builder** for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.
-
 ## 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).**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgsql-seed",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "author": "Constructive <developers@constructive.io>",
   "description": "PostgreSQL seeding utilities with pgpm integration - batteries included",
   "main": "index.js",
@@ -46,11 +46,11 @@
     "makage": "^0.1.9"
   },
   "dependencies": {
-    "@pgpmjs/core": "^4.3.0",
+    "@pgpmjs/core": "^4.5.0",
     "@pgpmjs/env": "^2.8.11",
     "pg": "^8.16.3",
     "pg-env": "^1.2.4",
-    "pg-seed": "^0.2.0"
+    "pg-seed": "^0.2.1"
   },
-  "gitHead": "7ac931c063d48e281349b748ba2eb9c9f47ffb06"
+  "gitHead": "09721f934b339bd8c55d2e633abaded6d20b0f65"
 }