linkgress-orm 0.0.1 → 0.0.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Linkgress ORM Contributors
-
-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.
+MIT License
+
+Copyright (c) 2025 Linkgress ORM Contributors
+
+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

@@ -1,196 +1,196 @@
-# Linkgress ORM
-
-[![npm version](https://img.shields.io/npm/v/linkgress-orm.svg)](https://www.npmjs.com/package/linkgress-orm)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
-[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-12+-blue.svg)](https://www.postgresql.org/)
-
-A type-safe ORM for PostgreSQL and TypeScript with automatic type inference and powerful query capabilities.
-
-**LINQ-Inspired Query Syntax:** The query API is designed to feel familiar to developers coming from C# LINQ, with chainable methods like `select()`, `where()`, `orderBy()`, and `groupBy()`. You also get magic SQL string interpolation for when you need raw SQL power without sacrificing type safety.
-
-**PostgreSQL-First Philosophy:** While other ORMs aim high and try to support all platforms, Linkgress is built exclusively for PostgreSQL. This allows it to leverage PostgreSQL's advanced features to the maximum—particularly in how collections and aggregations are retrieved using CTEs, JSON aggregations, and native PostgreSQL optimizations.
-
-## Features
-
-- **Entity-First Approach** - Define entities with `DbColumn<T>`, no decorators needed
-- **Fluent Configuration API** - Intuitive `DbContext` pattern with method chaining
-- **Automatic Type Inference** - Full TypeScript support without manual type annotations
-- **Nested Collection Queries** - Query one-to-many relationships with automatic CTE optimization
-- **Type-Safe Aggregations** - `count()`, `sum()`, `max()`, `min()` return proper types
-- **Powerful Filtering** - Type-checked query conditions
-- **Transaction Support** - Safe, type-checked transactions
-- **Multiple Clients** - Works with both `pg` and `postgres` npm packages
-
-## Table of Contents
-
-- [Quick Start](#quick-start)
-- [Features](#features)
-- [Documentation](#documentation)
-- [Requirements](#requirements)
-- [Contributing](#contributing)
-- [License](#license)
-- [Support](#support)
-
-## Quick Start
-
-### Installation
-
-```bash
-npm install linkgress-orm postgres
-```
-
-See [Installation Guide](./docs/installation.md) for detailed setup.
-
-### Define Entities
-
-```typescript
-import { DbEntity, DbColumn } from 'linkgress-orm';
-
-export class User extends DbEntity {
-  id!: DbColumn<number>;
-  username!: DbColumn<string>;
-  email!: DbColumn<string>;
-  posts?: Post[];  // Navigation property
-}
-
-export class Post extends DbEntity {
-  id!: DbColumn<number>;
-  title!: DbColumn<string>;
-  userId!: DbColumn<number>;
-  views!: DbColumn<number>;
-  user?: User;  // Navigation property
-}
-```
-
-### Create DbContext
-
-```typescript
-import { DbContext, DbEntityTable, DbModelConfig, integer, varchar } from 'linkgress-orm';
-
-export class AppDatabase extends DbContext {
-  get users(): DbEntityTable<User> {
-    return this.table(User);
-  }
-
-  get posts(): DbEntityTable<Post> {
-    return this.table(Post);
-  }
-
-  protected override setupModel(model: DbModelConfig): void {
-    model.entity(User, entity => {
-      entity.toTable('users');
-      entity.property(e => e.id).hasType(integer('id').primaryKey().generatedAlwaysAsIdentity({ name: 'users_id_seq' }));
-      entity.property(e => e.username).hasType(varchar('username', 100)).isRequired();
-      entity.property(e => e.email).hasType(varchar('email', 255)).isRequired();
-
-      entity.hasMany(e => e.posts, () => Post)
-        .withForeignKey(p => p.userId)
-        .withPrincipalKey(u => u.id);
-    });
-
-    model.entity(Post, entity => {
-      entity.toTable('posts');
-      entity.property(e => e.id).hasType(integer('id').primaryKey().generatedAlwaysAsIdentity({ name: 'posts_id_seq' }));
-      entity.property(e => e.title).hasType(varchar('title', 200)).isRequired();
-      entity.property(e => e.userId).hasType(integer('user_id')).isRequired();
-      entity.property(e => e.views).hasType(integer('views')).hasDefaultValue(0);
-
-      entity.hasOne(e => e.user, () => User)
-        .withForeignKey(p => p.userId)
-        .withPrincipalKey(u => u.id);
-    });
-  }
-}
-```
-
-### Query with Type Safety
-
-```typescript
-import { eq, gt } from 'linkgress-orm';
-import { PostgresClient } from 'linkgress-orm';
-
-// Create a database client with connection pooling
-const client = new PostgresClient('postgres://user:pass@localhost/db');
-
-// Create a DbContext instance - reuse this across your application!
-const db = new AppDatabase(client);
-
-// Create schema
-await db.ensureCreated();
-
-// Insert
-await db.users.insert({ username: 'alice', email: 'alice@example.com' });
-
-// Query with filters
-const activeUsers = await db.users
-  .where(u => eq(u.username, 'alice'))
-  .toList();
-
-// Nested collection query with aggregations
-const usersWithStats = await db.users
-  .select(u => ({
-    username: u.username,
-    postCount: u.posts.count(),  // Automatic type inference - no casting!
-    maxViews: u.posts.max(p => p.views),  // Returns number | null
-    posts: u.posts
-      .select(p => ({ title: p.title, views: p.views }))
-      .where(p => gt(p.views, 10))
-      .toList('posts'),
-  }))
-  .toList();
-
-// Note: Only call dispose() when shutting down your application
-// For long-running apps (servers), keep the db instance alive
-// and dispose on process exit (see Connection Lifecycle docs)
-```
-
-**Result is fully typed:**
-```typescript
-Array<{
-  username: string;
-  postCount: number;
-  maxViews: number | null;
-  posts: Array<{ title: string; views: number }>;
-}>
-```
-
-## Documentation
-
-### Getting Started
-- **[Getting Started Guide](./docs/getting-started.md)** - Complete walkthrough for beginners
-- **[Installation](./docs/installation.md)** - Setup and installation instructions
-- **[Database Clients](./docs/database-clients.md)** - Choose between `pg` and `postgres`, connection pooling, and lifecycle management
-
-### Guides
-- **[Schema Configuration](./docs/guides/schema-configuration.md)** - Entity configuration, relationships, and indexes
-- **[Querying](./docs/guides/querying.md)** - Query data with type-safe filters, joins, aggregations, and more
-- **[Insert/Update/Upsert/BULK](./docs/guides/insert-update-guide.md)** - Insert, update, delete, and bulk operations
-
-### Advanced
-- **[Collection Strategies](./docs/collection-strategies.md)** - JSONB vs temp table strategies, performance optimization, and multi-statement execution
-- **[Subqueries](./docs/guides/subquery-guide.md)** - Using subqueries in your queries
-- **[Custom Types](./docs/guides/schema-configuration.md#custom-types)** - Create custom type mappers
-
-## Requirements
-
-- Node.js 16+
-- TypeScript 5.0+
-- PostgreSQL 12+
-
-## Contributing
-
-Contributions are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
-
-## Support
-
-- **[GitHub Issues](https://github.com/brunolau/linkgress-orm/issues)** - Report bugs or request features
-- **[Discussions](https://github.com/brunolau/linkgress-orm/discussions)** - Ask questions and share ideas
-
----
-
-Crafted with ❤️ for developers who love type safety and clean APIs.
+# Linkgress ORM
+
+[![npm version](https://img.shields.io/npm/v/linkgress-orm.svg)](https://www.npmjs.com/package/linkgress-orm)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg)](https://www.typescriptlang.org/)
+[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-12+-blue.svg)](https://www.postgresql.org/)
+
+A type-safe ORM for PostgreSQL and TypeScript with automatic type inference and powerful query capabilities.
+
+**LINQ-Inspired Query Syntax:** The query API is designed to feel familiar to developers coming from C# LINQ, with chainable methods like `select()`, `where()`, `orderBy()`, and `groupBy()`. You also get magic SQL string interpolation for when you need raw SQL power without sacrificing type safety.
+
+**PostgreSQL-First Philosophy:** While other ORMs aim high and try to support all platforms, Linkgress is built exclusively for PostgreSQL. This allows it to leverage PostgreSQL's advanced features to the maximum—particularly in how collections and aggregations are retrieved using CTEs, JSON aggregations, and native PostgreSQL optimizations.
+
+## Features
+
+- **Entity-First Approach** - Define entities with `DbColumn<T>`, no decorators needed
+- **Fluent Configuration API** - Intuitive `DbContext` pattern with method chaining
+- **Automatic Type Inference** - Full TypeScript support without manual type annotations
+- **Nested Collection Queries** - Query one-to-many relationships with automatic CTE optimization
+- **Type-Safe Aggregations** - `count()`, `sum()`, `max()`, `min()` return proper types
+- **Powerful Filtering** - Type-checked query conditions
+- **Transaction Support** - Safe, type-checked transactions
+- **Multiple Clients** - Works with both `pg` and `postgres` npm packages
+
+## Table of Contents
+
+- [Quick Start](#quick-start)
+- [Features](#features)
+- [Documentation](#documentation)
+- [Requirements](#requirements)
+- [Contributing](#contributing)
+- [License](#license)
+- [Support](#support)
+
+## Quick Start
+
+### Installation
+
+```bash
+npm install linkgress-orm postgres
+```
+
+See [Installation Guide](./docs/installation.md) for detailed setup.
+
+### Define Entities
+
+```typescript
+import { DbEntity, DbColumn } from 'linkgress-orm';
+
+export class User extends DbEntity {
+  id!: DbColumn<number>;
+  username!: DbColumn<string>;
+  email!: DbColumn<string>;
+  posts?: Post[];  // Navigation property
+}
+
+export class Post extends DbEntity {
+  id!: DbColumn<number>;
+  title!: DbColumn<string>;
+  userId!: DbColumn<number>;
+  views!: DbColumn<number>;
+  user?: User;  // Navigation property
+}
+```
+
+### Create DbContext
+
+```typescript
+import { DbContext, DbEntityTable, DbModelConfig, integer, varchar } from 'linkgress-orm';
+
+export class AppDatabase extends DbContext {
+  get users(): DbEntityTable<User> {
+    return this.table(User);
+  }
+
+  get posts(): DbEntityTable<Post> {
+    return this.table(Post);
+  }
+
+  protected override setupModel(model: DbModelConfig): void {
+    model.entity(User, entity => {
+      entity.toTable('users');
+      entity.property(e => e.id).hasType(integer('id').primaryKey().generatedAlwaysAsIdentity({ name: 'users_id_seq' }));
+      entity.property(e => e.username).hasType(varchar('username', 100)).isRequired();
+      entity.property(e => e.email).hasType(varchar('email', 255)).isRequired();
+
+      entity.hasMany(e => e.posts, () => Post)
+        .withForeignKey(p => p.userId)
+        .withPrincipalKey(u => u.id);
+    });
+
+    model.entity(Post, entity => {
+      entity.toTable('posts');
+      entity.property(e => e.id).hasType(integer('id').primaryKey().generatedAlwaysAsIdentity({ name: 'posts_id_seq' }));
+      entity.property(e => e.title).hasType(varchar('title', 200)).isRequired();
+      entity.property(e => e.userId).hasType(integer('user_id')).isRequired();
+      entity.property(e => e.views).hasType(integer('views')).hasDefaultValue(0);
+
+      entity.hasOne(e => e.user, () => User)
+        .withForeignKey(p => p.userId)
+        .withPrincipalKey(u => u.id);
+    });
+  }
+}
+```
+
+### Query with Type Safety
+
+```typescript
+import { eq, gt } from 'linkgress-orm';
+import { PostgresClient } from 'linkgress-orm';
+
+// Create a database client with connection pooling
+const client = new PostgresClient('postgres://user:pass@localhost/db');
+
+// Create a DbContext instance - reuse this across your application!
+const db = new AppDatabase(client);
+
+// Create schema
+await db.ensureCreated();
+
+// Insert
+await db.users.insert({ username: 'alice', email: 'alice@example.com' });
+
+// Query with filters
+const activeUsers = await db.users
+  .where(u => eq(u.username, 'alice'))
+  .toList();
+
+// Nested collection query with aggregations
+const usersWithStats = await db.users
+  .select(u => ({
+    username: u.username,
+    postCount: u.posts.count(),  // Automatic type inference - no casting!
+    maxViews: u.posts.max(p => p.views),  // Returns number | null
+    posts: u.posts
+      .select(p => ({ title: p.title, views: p.views }))
+      .where(p => gt(p.views, 10))
+      .toList('posts'),
+  }))
+  .toList();
+
+// Note: Only call dispose() when shutting down your application
+// For long-running apps (servers), keep the db instance alive
+// and dispose on process exit (see Connection Lifecycle docs)
+```
+
+**Result is fully typed:**
+```typescript
+Array<{
+  username: string;
+  postCount: number;
+  maxViews: number | null;
+  posts: Array<{ title: string; views: number }>;
+}>
+```
+
+## Documentation
+
+### Getting Started
+- **[Getting Started Guide](./docs/getting-started.md)** - Complete walkthrough for beginners
+- **[Installation](./docs/installation.md)** - Setup and installation instructions
+- **[Database Clients](./docs/database-clients.md)** - Choose between `pg` and `postgres`, connection pooling, and lifecycle management
+
+### Guides
+- **[Schema Configuration](./docs/guides/schema-configuration.md)** - Entity configuration, relationships, and indexes
+- **[Querying](./docs/guides/querying.md)** - Query data with type-safe filters, joins, aggregations, and more
+- **[Insert/Update/Upsert/BULK](./docs/guides/insert-update-guide.md)** - Insert, update, delete, and bulk operations
+
+### Advanced
+- **[Collection Strategies](./docs/collection-strategies.md)** - JSONB vs temp table strategies, performance optimization, and multi-statement execution
+- **[Subqueries](./docs/guides/subquery-guide.md)** - Using subqueries in your queries
+- **[Custom Types](./docs/guides/schema-configuration.md#custom-types)** - Create custom type mappers
+
+## Requirements
+
+- Node.js 16+
+- TypeScript 5.0+
+- PostgreSQL 12+
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+## Support
+
+- **[GitHub Issues](https://github.com/brunolau/linkgress-orm/issues)** - Report bugs or request features
+- **[Discussions](https://github.com/brunolau/linkgress-orm/discussions)** - Ask questions and share ideas
+
+---
+
+Crafted with ❤️ for developers who love type safety and clean APIs.

package/dist/database/database-client.interface.d.ts

@@ -5,12 +5,23 @@ export interface QueryResult<T = any> {
     rows: T[];
     rowCount: number | null;
 }
+/**
+ * Query execution options
+ */
+export interface QueryExecutionOptions {
+    /**
+     * Use binary protocol for data transfer (when supported by driver).
+     * Binary protocol can improve performance by avoiding string conversions.
+     * Default: false (uses text protocol)
+     */
+    useBinaryProtocol?: boolean;
+}
 /**
  * Database-agnostic pooled client/connection interface
  * Represents a single connection from the pool for transactions
  */
 export interface PooledConnection {
-    query<T = any>(sql: string, params?: any[]): Promise<QueryResult<T>>;
+    query<T = any>(sql: string, params?: any[], options?: QueryExecutionOptions): Promise<QueryResult<T>>;
     release(): void;
 }
 /**
@@ -18,9 +29,9 @@ export interface PooledConnection {
  */
 export declare abstract class DatabaseClient {
     /**
-     * Execute a query with optional parameters
+     * Execute a query with optional parameters and execution options
      */
-    abstract query<T = any>(sql: string, params?: any[]): Promise<QueryResult<T>>;
+    abstract query<T = any>(sql: string, params?: any[], options?: QueryExecutionOptions): Promise<QueryResult<T>>;
     /**
      * Get a connection from the pool for transactions
      */
@@ -41,5 +52,10 @@ export declare abstract class DatabaseClient {
      * Default: false for safety
      */
     supportsMultiStatementQueries(): boolean;
+    /**
+     * Check if the driver supports binary protocol for improved performance.
+     * Default: false
+     */
+    supportsBinaryProtocol(): boolean;
 }
 //# sourceMappingURL=database-client.interface.d.ts.map

package/dist/database/database-client.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"database-client.interface.d.ts","sourceRoot":"","sources":["../../src/database/database-client.interface.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACrE,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,8BAAsB,cAAc;IAClC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAE7E;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAE7C;;OAEG;IACH,QAAQ,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,aAAa,IAAI,MAAM;IAEhC;;;;;;OAMG;IACH,6BAA6B,IAAI,OAAO;CAGzC"}
+{"version":3,"file":"database-client.interface.d.ts","sourceRoot":"","sources":["../../src/database/database-client.interface.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACtG,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,8BAAsB,cAAc;IAClC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAE9G;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAE7C;;OAEG;IACH,QAAQ,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,aAAa,IAAI,MAAM;IAEhC;;;;;;OAMG;IACH,6BAA6B,IAAI,OAAO;IAIxC;;;OAGG;IACH,sBAAsB,IAAI,OAAO;CAGlC"}

package/dist/database/database-client.interface.js

@@ -15,6 +15,13 @@ class DatabaseClient {
     supportsMultiStatementQueries() {
         return false;
     }
+    /**
+     * Check if the driver supports binary protocol for improved performance.
+     * Default: false
+     */
+    supportsBinaryProtocol() {
+        return false;
+    }
 }
 exports.DatabaseClient = DatabaseClient;
 //# sourceMappingURL=database-client.interface.js.map

package/dist/database/database-client.interface.js.map

@@ -1 +1 @@
-{"version":3,"file":"database-client.interface.js","sourceRoot":"","sources":["../../src/database/database-client.interface.ts"],"names":[],"mappings":";;;AAiBA;;GAEG;AACH,MAAsB,cAAc;IAqBlC;;;;;;OAMG;IACH,6BAA6B;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA/BD,wCA+BC"}
+{"version":3,"file":"database-client.interface.js","sourceRoot":"","sources":["../../src/database/database-client.interface.ts"],"names":[],"mappings":";;;AA6BA;;GAEG;AACH,MAAsB,cAAc;IAqBlC;;;;;;OAMG;IACH,6BAA6B;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,sBAAsB;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAvCD,wCAuCC"}

package/dist/database/pg-client.d.ts

@@ -1,4 +1,4 @@
-import { DatabaseClient, PooledConnection, QueryResult } from './database-client.interface';
+import { DatabaseClient, PooledConnection, QueryResult, QueryExecutionOptions } from './database-client.interface';
 import type { PoolConfig } from './types';
 type Pool = any;
 /**
@@ -10,8 +10,13 @@ type Pool = any;
  */
 export declare class PgClient extends DatabaseClient {
     private pool;
-    constructor(config: PoolConfig);
-    query<T = any>(sql: string, params?: any[]): Promise<QueryResult<T>>;
+    private ownsConnection;
+    /**
+     * Create a PgClient
+     * @param config - Either a PoolConfig object or an existing pg.Pool instance
+     */
+    constructor(config: PoolConfig | Pool);
+    query<T = any>(sql: string, params?: any[], options?: QueryExecutionOptions): Promise<QueryResult<T>>;
     connect(): Promise<PooledConnection>;
     end(): Promise<void>;
     getDriverName(): string;
@@ -21,6 +26,10 @@ export declare class PgClient extends DatabaseClient {
      * Use PostgresClient (postgres library) for true single-roundtrip multi-statement support
      */
     supportsMultiStatementQueries(): boolean;
+    /**
+     * pg library supports binary protocol via rowMode option
+     */
+    supportsBinaryProtocol(): boolean;
     /**
      * Get access to the underlying pg Pool for advanced use cases
      */

package/dist/database/pg-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pg-client.d.ts","sourceRoot":"","sources":["../../src/database/pg-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG1C,KAAK,IAAI,GAAG,GAAG,CAAC;AAuBhB;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,cAAc;IAC1C,OAAO,CAAC,IAAI,CAAO;gBAEP,MAAM,EAAE,UAAU;IAcxB,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IASpE,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAKpC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1B,aAAa,IAAI,MAAM;IAIvB;;;;OAIG;IACH,6BAA6B,IAAI,OAAO;IAIxC;;OAEG;IACH,OAAO,IAAI,IAAI;CAGhB"}
+{"version":3,"file":"pg-client.d.ts","sourceRoot":"","sources":["../../src/database/pg-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACnH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG1C,KAAK,IAAI,GAAG,GAAG,CAAC;AAmChB;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,cAAc;IAC1C,OAAO,CAAC,IAAI,CAAO;IACnB,OAAO,CAAC,cAAc,CAAU;IAEhC;;;OAGG;gBACS,MAAM,EAAE,UAAU,GAAG,IAAI;IAsB/B,KAAK,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAcrG,OAAO,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAKpC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAO1B,aAAa,IAAI,MAAM;IAIvB;;;;OAIG;IACH,6BAA6B,IAAI,OAAO;IAIxC;;OAEG;IACH,sBAAsB,IAAI,OAAO;IAIjC;;OAEG;IACH,OAAO,IAAI,IAAI;CAGhB"}

package/dist/database/pg-client.js

@@ -2,6 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PgClient = void 0;
 const database_client_interface_1 = require("./database-client.interface");
+/**
+ * Check if a value is a pg.Pool instance
+ */
+function isPgPoolInstance(value) {
+    return value && typeof value === 'object' && typeof value.query === 'function' && typeof value.connect === 'function' && typeof value.end === 'function';
+}
 /**
  * Wrapper for the pooled connection from pg library
  */
@@ -9,8 +15,12 @@ class PgPooledConnection {
     constructor(client) {
         this.client = client;
     }
-    async query(sql, params) {
-        const result = await this.client.query(sql, params);
+    async query(sql, params, options) {
+        // pg library supports binary protocol via types option
+        const queryConfig = options?.useBinaryProtocol
+            ? { text: sql, values: params, rowMode: 'array' }
+            : { text: sql, values: params };
+        const result = await this.client.query(queryConfig);
         return {
             rows: result.rows,
             rowCount: result.rowCount,
@@ -28,20 +38,36 @@ class PgPooledConnection {
  * npm install pg
  */
 class PgClient extends database_client_interface_1.DatabaseClient {
+    /**
+     * Create a PgClient
+     * @param config - Either a PoolConfig object or an existing pg.Pool instance
+     */
     constructor(config) {
         super();
-        try {
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
-            const { Pool } = require('pg');
-            this.pool = new Pool(config);
+        // Check if config is an existing pg.Pool instance
+        if (isPgPoolInstance(config)) {
+            this.pool = config;
+            this.ownsConnection = false;
         }
-        catch (error) {
-            throw new Error('PgClient requires the "pg" package to be installed. ' +
-                'Install it with: npm install pg');
+        else {
+            try {
+                // eslint-disable-next-line @typescript-eslint/no-var-requires
+                const { Pool } = require('pg');
+                this.pool = new Pool(config);
+                this.ownsConnection = true;
+            }
+            catch (error) {
+                throw new Error('PgClient requires the "pg" package to be installed. ' +
+                    'Install it with: npm install pg');
+            }
         }
     }
-    async query(sql, params) {
-        const result = await this.pool.query(sql, params);
+    async query(sql, params, options) {
+        // pg library supports binary protocol via types option
+        const queryConfig = options?.useBinaryProtocol
+            ? { text: sql, values: params, rowMode: 'array' }
+            : { text: sql, values: params };
+        const result = await this.pool.query(queryConfig);
         return {
             rows: result.rows,
             rowCount: result.rowCount,
@@ -52,7 +78,10 @@ class PgClient extends database_client_interface_1.DatabaseClient {
         return new PgPooledConnection(client);
     }
     async end() {
-        await this.pool.end();
+        // Only close the pool if we created it
+        if (this.ownsConnection) {
+            await this.pool.end();
+        }
     }
     getDriverName() {
         return 'pg';
@@ -65,6 +94,12 @@ class PgClient extends database_client_interface_1.DatabaseClient {
     supportsMultiStatementQueries() {
         return false;
     }
+    /**
+     * pg library supports binary protocol via rowMode option
+     */
+    supportsBinaryProtocol() {
+        return true;
+    }
     /**
      * Get access to the underlying pg Pool for advanced use cases
      */