@remix-run/data-table-postgres 0.1.0 → 0.3.0

package/README.md

@@ -5,12 +5,16 @@ Use this package when you want `data-table` APIs backed by `pg`.
 
 ## Features
 
-- **Native `pg` Integration**: Works with `Pool` and Postgres connection strings
+- **Native `pg` Integration**: Works with `pg` `Pool` and `PoolClient` instances
 - **Full `data-table` API Support**: Queries, relations, writes, and transactions
+- **Adapter-Owned Compiler**: SQL compilation lives in this adapter, with optional shared pure helpers from `data-table`
+- **Migration DDL Support**: Compiles and executes `DataMigrationOperation` operations for `remix/data-table/migrations`
 - **Postgres Capabilities Enabled By Default**:
   - `returning: true`
   - `savepoints: true`
   - `upsert: true`
+  - `transactionalDdl: true`
+  - `migrationLock: true`
 
 ## Installation
 
@@ -33,6 +37,7 @@ let db = createDatabase(createPostgresDatabaseAdapter(pool))
 ```
 
 Use `db.query(...)`, relation loading, and transactions from `remix/data-table`.
+Import any driver-specific types you need directly from `pg`.
 
 ## Adapter Capabilities
 
@@ -41,6 +46,8 @@ Use `db.query(...)`, relation loading, and transactions from `remix/data-table`.
 - `returning: true`
 - `savepoints: true`
 - `upsert: true`
+- `transactionalDdl: true`
+- `migrationLock: true`
 
 ## Advanced Usage
 
@@ -55,24 +62,10 @@ await db.transaction(async (txDb) => txDb.exec('select 1'), {
 })
 ```
 
-### Capability Overrides For Testing
-
-You can override capabilities to verify fallback paths in tests.
-
-```ts
-import { createPostgresDatabaseAdapter } from 'remix/data-table-postgres'
-
-let adapter = createPostgresDatabaseAdapter(pool, {
-  capabilities: {
-    returning: false,
-  },
-})
-```
-
 ## Related Packages
 
 - [`data-table`](https://github.com/remix-run/remix/tree/main/packages/data-table) - Core query/relations API
-- [`data-schema`](https://github.com/remix-run/remix/tree/main/packages/data-schema) - Schema definitions and validation
+- [`data-schema`](https://github.com/remix-run/remix/tree/main/packages/data-schema) - Schema parsing and validation
 - [`data-table-mysql`](https://github.com/remix-run/remix/tree/main/packages/data-table-mysql) - MySQL adapter
 - [`data-table-sqlite`](https://github.com/remix-run/remix/tree/main/packages/data-table-sqlite) - SQLite adapter
 

package/dist/index.d.ts

@@ -1,3 +1,2 @@
-export type { PostgresDatabaseAdapterOptions, PostgresDatabaseClient, PostgresDatabasePool, PostgresQueryResult, PostgresTransactionClient, } from './lib/adapter.ts';
 export { createPostgresDatabaseAdapter, PostgresDatabaseAdapter } from './lib/adapter.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,8BAA8B,EAC9B,sBAAsB,EACtB,oBAAoB,EACpB,mBAAmB,EACnB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,6BAA6B,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/lib/adapter.d.ts

@@ -1,64 +1,125 @@
-import type { AdapterCapabilityOverrides, AdapterExecuteRequest, AdapterResult, DatabaseAdapter, TransactionOptions, TransactionToken } from '@remix-run/data-table';
-type Pretty<value> = {
-    [key in keyof value]: value[key];
-} & {};
-/**
- * Result shape returned by postgres client `query()` calls.
- */
-export type PostgresQueryResult = {
-    rows: unknown[];
-    rowCount: number | null;
-};
-/**
- * Minimal postgres client contract used by this adapter.
- */
-export type PostgresDatabaseClient = {
-    query(text: string, values?: unknown[]): Promise<PostgresQueryResult>;
-};
-/**
- * Postgres transaction client with optional connection release support.
- */
-export type PostgresTransactionClient = Pretty<PostgresDatabaseClient & {
-    release?: () => void;
-}>;
-/**
- * Postgres pool-like client contract used by this adapter.
- */
-export type PostgresDatabasePool = Pretty<PostgresDatabaseClient & {
-    connect?: () => Promise<PostgresTransactionClient>;
-}>;
-/**
- * Postgres adapter configuration.
- */
-export type PostgresDatabaseAdapterOptions = {
-    capabilities?: AdapterCapabilityOverrides;
-};
+import type { DataMigrationRequest, DataManipulationRequest, DataMigrationResult, DataMigrationOperation, DataManipulationResult, DataManipulationOperation, DatabaseAdapter, SqlStatement, TableRef, TransactionOptions, TransactionToken } from '@remix-run/data-table';
+import type { Client as PostgresClient, Pool as PostgresPool, PoolClient as PostgresPoolClient } from 'pg';
+type PostgresQueryable = PostgresClient | PostgresPool | PostgresPoolClient;
 /**
  * `DatabaseAdapter` implementation for postgres-compatible clients.
  */
 export declare class PostgresDatabaseAdapter implements DatabaseAdapter {
     #private;
+    /**
+     * The SQL dialect identifier reported by this adapter.
+     */
     dialect: string;
+    /**
+     * Feature flags describing the postgres behaviors supported by this adapter.
+     */
     capabilities: {
         returning: boolean;
         savepoints: boolean;
         upsert: boolean;
+        transactionalDdl: boolean;
+        migrationLock: boolean;
     };
-    constructor(client: PostgresDatabasePool, options?: PostgresDatabaseAdapterOptions);
-    execute(request: AdapterExecuteRequest): Promise<AdapterResult>;
+    constructor(client: PostgresQueryable);
+    /**
+     * Compiles a data or migration operation to postgres SQL statements.
+     * @param operation Operation to compile.
+     * @returns Compiled SQL statements.
+     */
+    compileSql(operation: DataManipulationOperation | DataMigrationOperation): SqlStatement[];
+    /**
+     * Executes a postgres data-manipulation request.
+     * @param request Request to execute.
+     * @returns Execution result.
+     */
+    execute(request: DataManipulationRequest): Promise<DataManipulationResult>;
+    /**
+     * Executes postgres migration operations.
+     * @param request Migration request to execute.
+     * @returns Migration result.
+     */
+    migrate(request: DataMigrationRequest): Promise<DataMigrationResult>;
+    /**
+     * Checks whether a table exists in postgres.
+     * @param table Table reference to inspect.
+     * @param transaction Optional transaction token.
+     * @returns `true` when the table exists.
+     */
+    hasTable(table: TableRef, transaction?: TransactionToken): Promise<boolean>;
+    /**
+     * Checks whether a column exists in postgres.
+     * @param table Table reference to inspect.
+     * @param column Column name to look up.
+     * @param transaction Optional transaction token.
+     * @returns `true` when the column exists.
+     */
+    hasColumn(table: TableRef, column: string, transaction?: TransactionToken): Promise<boolean>;
+    /**
+     * Starts a postgres transaction.
+     * @param options Transaction options.
+     * @returns Transaction token.
+     */
     beginTransaction(options?: TransactionOptions): Promise<TransactionToken>;
+    /**
+     * Commits an open postgres transaction.
+     * @param token Transaction token to commit.
+     * @returns A promise that resolves when the transaction is committed.
+     */
     commitTransaction(token: TransactionToken): Promise<void>;
+    /**
+     * Rolls back an open postgres transaction.
+     * @param token Transaction token to roll back.
+     * @returns A promise that resolves when the transaction is rolled back.
+     */
     rollbackTransaction(token: TransactionToken): Promise<void>;
+    /**
+     * Creates a savepoint in an open postgres transaction.
+     * @param token Transaction token to use.
+     * @param name Savepoint name.
+     * @returns A promise that resolves when the savepoint is created.
+     */
     createSavepoint(token: TransactionToken, name: string): Promise<void>;
+    /**
+     * Rolls back to a savepoint in an open postgres transaction.
+     * @param token Transaction token to use.
+     * @param name Savepoint name.
+     * @returns A promise that resolves when the rollback completes.
+     */
     rollbackToSavepoint(token: TransactionToken, name: string): Promise<void>;
+    /**
+     * Releases a savepoint in an open postgres transaction.
+     * @param token Transaction token to use.
+     * @param name Savepoint name.
+     * @returns A promise that resolves when the savepoint is released.
+     */
     releaseSavepoint(token: TransactionToken, name: string): Promise<void>;
+    /**
+     * Acquires the postgres migration lock.
+     * @returns A promise that resolves when the lock is acquired.
+     */
+    acquireMigrationLock(): Promise<void>;
+    /**
+     * Releases the postgres migration lock.
+     * @returns A promise that resolves when the lock is released.
+     */
+    releaseMigrationLock(): Promise<void>;
 }
 /**
  * Creates a postgres `DatabaseAdapter`.
- * @param client Postgres pool or client.
+ * @param client `pg` pool or pool client.
  * @param options Optional adapter capability overrides.
  * @returns A configured postgres adapter.
+ * @example
+ * ```ts
+ * import { Pool } from 'pg'
+ * import { createDatabase } from 'remix/data-table'
+ * import { createPostgresDatabaseAdapter } from 'remix/data-table-postgres'
+ *
+ * let pool = new Pool({ connectionString: process.env.DATABASE_URL })
+ * let adapter = createPostgresDatabaseAdapter(pool)
+ * let db = createDatabase(adapter)
+ * ```
  */
-export declare function createPostgresDatabaseAdapter(client: PostgresDatabasePool, options?: PostgresDatabaseAdapterOptions): PostgresDatabaseAdapter;
+export declare function createPostgresDatabaseAdapter(client: PostgresQueryable): PostgresDatabaseAdapter;
 export {};
 //# sourceMappingURL=adapter.d.ts.map

package/dist/lib/adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/lib/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,qBAAqB,EACrB,aAAa,EACb,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAK9B,KAAK,MAAM,CAAC,KAAK,IAAI;KAClB,GAAG,IAAI,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC;CACjC,GAAG,EAAE,CAAA;AAEN;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,OAAO,EAAE,CAAA;IACf,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;CACtE,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAC5C,sBAAsB,GAAG;IACvB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;CACrB,CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACvC,sBAAsB,GAAG;IACvB,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC,yBAAyB,CAAC,CAAA;CACnD,CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,YAAY,CAAC,EAAE,0BAA0B,CAAA;CAC1C,CAAA;AAOD;;GAEG;AACH,qBAAa,uBAAwB,YAAW,eAAe;;IAC7D,OAAO,SAAa;IACpB,YAAY;;;;MAAA;IAMZ,YAAY,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,8BAA8B,EAOjF;IAEK,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,CAuBpE;IAEK,gBAAgB,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA0B9E;IAEK,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB9D;IAEK,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBhE;IAEK,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;IAEK,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9E;IAEK,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3E;CAmBF;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,8BAA8B,GACvC,uBAAuB,CAEzB"}
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/lib/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,uBAAuB,EACvB,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,yBAAyB,EACzB,eAAe,EAEf,YAAY,EACZ,QAAQ,EACR,kBAAkB,EAClB,gBAAgB,EACjB,MAAM,uBAAuB,CAAA;AAO9B,OAAO,KAAK,EACV,MAAM,IAAI,cAAc,EACxB,IAAI,IAAI,YAAY,EACpB,UAAU,IAAI,kBAAkB,EACjC,MAAM,IAAI,CAAA;AASX,KAAK,iBAAiB,GAAG,cAAc,GAAG,YAAY,GAAG,kBAAkB,CAAA;AAE3E;;GAEG;AACH,qBAAa,uBAAwB,YAAW,eAAe;;IAC7D;;OAEG;IACH,OAAO,SAAa;IAEpB;;OAEG;IACH,YAAY;;;;;;MAAA;IAMZ,YAAY,MAAM,EAAE,iBAAiB,EASpC;IAED;;;;OAIG;IACH,UAAU,CAAC,SAAS,EAAE,yBAAyB,GAAG,sBAAsB,GAAG,YAAY,EAAE,CAOxF;IAED;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAuB/E;IAED;;;;OAIG;IACG,OAAO,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAWzE;IAED;;;;;OAKG;IACG,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAMhF;IAED;;;;;;OAMG;IACG,SAAS,CACb,KAAK,EAAE,QAAQ,EACf,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,gBAAgB,GAC7B,OAAO,CAAC,OAAO,CAAC,CASlB;IAED;;;;OAIG;IACG,gBAAgB,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA0B9E;IAED;;;;OAIG;IACG,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB9D;IAED;;;;OAIG;IACG,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBhE;IAED;;;;;OAKG;IACG,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG1E;IAED;;;;;OAKG;IACG,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9E;IAED;;;;;OAKG;IACG,gBAAgB,CAAC,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAG3E;IAED;;;OAGG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1C;IAED;;;OAGG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1C;CAmBF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,6BAA6B,CAAC,MAAM,EAAE,iBAAiB,GAAG,uBAAuB,CAEhG"}