node-firebird 2.11.0 → 2.13.0

package/src/pool.ts

@@ -26,7 +26,12 @@ type AttachFn = (options: any, callback: Callback) => void;
  *
  * Options: max (factory argument), options.min (floor the reaper never
  * shrinks below), options.idleTimeoutMillis (close idle connections after
- * this many ms; 0/absent = never), options.connectTimeout.
+ * this many ms; 0/absent = never), options.connectTimeout,
+ * options.maxUses (retire a connection after this many checkouts — pg's
+ * maxUses), options.maxLifetimeMillis (retire a connection this many ms
+ * after it was created — Postgres.js's max_lifetime). Retirement happens
+ * when the connection is returned to the pool, and the sweep also closes
+ * over-lifetime idle connections; a replacement is created on demand.
  */
 class Pool extends Events.EventEmitter {
     attach: AttachFn;
@@ -37,6 +42,8 @@ class Pool extends Events.EventEmitter {
     max: number;
     min: number;
     idleTimeoutMillis: number;
+    maxUses: number;
+    maxLifetimeMillis: number;
     pending: Callback[];
     options: any;
     _destroyed: boolean;
@@ -52,22 +59,50 @@ class Pool extends Events.EventEmitter {
         this.max       = max || 4;
         this.min       = (options && options.min > 0) ? Math.min(options.min, this.max) : 0;
         this.idleTimeoutMillis = (options && options.idleTimeoutMillis > 0) ? options.idleTimeoutMillis : 0;
+        this.maxUses = (options && options.maxUses > 0) ? options.maxUses : 0;
+        this.maxLifetimeMillis = (options && options.maxLifetimeMillis > 0) ? options.maxLifetimeMillis : 0;
         this.pending   = []; // callbacks waiting for a free slot
         this.options   = options;
         this._destroyed = false; // true after destroy() — prevents further use
         this._reaper   = null;
 
-        if (this.idleTimeoutMillis) {
+        // the sweep serves both idle eviction and lifetime retirement of
+        // idle connections; base its cadence on the tightest configured limit
+        var sweepBasis = Math.min(this.idleTimeoutMillis || Infinity, this.maxLifetimeMillis || Infinity);
+        if (sweepBasis !== Infinity) {
             var self = this;
-            // Sweep at half the idle timeout (bounded to 100ms..30s) so a
-            // connection lives at most ~1.5x idleTimeoutMillis. unref() keeps
+            // Sweep at half the basis (bounded to 100ms..30s) so a
+            // connection lives at most ~1.5x its limit. unref() keeps
             // the timer from holding the process open.
-            var interval = Math.min(Math.max(this.idleTimeoutMillis / 2, 100), 30000);
+            var interval = Math.min(Math.max(sweepBasis / 2, 100), 30000);
             this._reaper = setInterval(function() { self._reap(); }, interval);
             if (this._reaper.unref) this._reaper.unref();
         }
     }
 
+    /** True when the connection exceeded maxUses / maxLifetimeMillis.
+     *  Both stamps are set unconditionally when the pool creates the
+     *  connection, so they can be read bare here. */
+    _isExpired(db: any): boolean {
+        if (this.maxUses > 0 && db.__poolUseCount >= this.maxUses) return true;
+        if (this.maxLifetimeMillis > 0 && Date.now() - db.__poolCreatedAt >= this.maxLifetimeMillis) return true;
+        return false;
+    }
+
+    /** Close a healthy pooled connection for good (reaper/retirement path). */
+    _retire(db: any): void {
+        var self = this;
+        this._forget(db);
+        db.connection._pooled = false;
+        try {
+            db.detach(function(err?: any) {
+                if (err) self._emitError(err, db);
+            });
+        } catch (e) {
+            self._emitError(e, db);
+        }
+    }
+
     /** Physical connections owned by the pool (idle + in use). */
     get totalCount(): number {
         return this.internaldb.length;
@@ -124,19 +159,18 @@ class Pool extends Events.EventEmitter {
                 self._forget(db);
                 return;
             }
+            // lifetime retirement applies even below min — recycling is the
+            // point; replacements are created on demand
+            if (self._isExpired(db)) {
+                self._retire(db);
+                return;
+            }
+            if (!self.idleTimeoutMillis) return;
             if (self.internaldb.length <= self.min) return;
             var idleSince = typeof db.__poolIdleSince === 'number' ? db.__poolIdleSince : now;
             if (now - idleSince < self.idleTimeoutMillis) return;
 
-            self._forget(db);
-            db.connection._pooled = false;
-            try {
-                db.detach(function(err?: any) {
-                    if (err) self._emitError(err, db);
-                });
-            } catch (e) {
-                self._emitError(e, db);
-            }
+            self._retire(db);
         });
     }
 
@@ -175,6 +209,7 @@ class Pool extends Events.EventEmitter {
             }
             // Idle connection available — hand it out immediately.
             self.dbinuse++;
+            db.__poolUseCount = (db.__poolUseCount || 0) + 1;
             self.emit('acquire', db);
             cb(null, db);
         } else {
@@ -235,6 +270,8 @@ class Pool extends Events.EventEmitter {
 
                 if (!err) {
                     self.dbinuse++;
+                    db.__poolCreatedAt = Date.now();
+                    db.__poolUseCount = 1;
                     self.internaldb.push(db);
                     db.on('detach', function () {
                         // also in pool (could be a twice call to detach)
@@ -244,6 +281,12 @@ class Pool extends Events.EventEmitter {
                         if (db.connection._isClosed || db.connection._isDetach || db.connection._pooled === false) {
                             self.internaldb.splice(self.internaldb.indexOf(db), 1);
                             self.emit('remove', db);
+                        } else if (self._isExpired(db)) {
+                            // worn out (maxUses / maxLifetimeMillis): close it
+                            // for good instead of returning it to the idle
+                            // pool. The re-fired detach event exits early via
+                            // the internaldb guard above.
+                            self._retire(db);
                         } else {
                             db.__poolIdleSince = Date.now();
                             self.pooldb.push(db);

package/src/sql-template.ts

@@ -0,0 +1,196 @@
+/***************************************
+ *
+ *   Tagged-template query API (Postgres.js-style)
+ *
+ *   db.sql`SELECT * FROM EMP WHERE ID = ${id}`   →  lazy thenable query
+ *   db.sql('COLUMN NAME')                        →  quoted identifier
+ *
+ *   Interpolated values become positional `?` parameters — never string
+ *   concatenation — so the API is injection-safe by construction. A query
+ *   embedded inside another tag is treated as a fragment: its text and
+ *   parameters are spliced in place. Arrays expand to `?, ?, ?` lists for
+ *   IN clauses. Execution is lazy (on await/then) and happens exactly once.
+ *
+ ***************************************/
+
+import type { QueryOptions, QueryResult } from './types';
+
+/** Executor provided by Database/Transaction: runs text+params, resolves rows
+ *  (or the full QueryResult when options.withMeta is set). */
+export type SqlExecutor = (text: string, params: any[], options?: QueryOptions) => Promise<any>;
+
+/** A dynamically quoted identifier produced by sql('name'). */
+export class SqlIdentifier {
+    name: string;
+    constructor(name: string) {
+        this.name = name;
+    }
+}
+
+/**
+ * Quote a (possibly dot-qualified) identifier for dialect 3: each part is
+ * wrapped in double quotes with embedded quotes doubled, so user input can
+ * never break out of the identifier position.
+ */
+export function quoteIdentifier(name: string): string {
+    return String(name)
+        .split('.')
+        .map((part) => '"' + part.replace(/"/g, '""') + '"')
+        .join('.');
+}
+
+/** Compiled form of a tagged query: SQL text with `?` placeholders + params. */
+export interface CompiledQuery {
+    text: string;
+    params: any[];
+}
+
+function compile(strings: readonly string[], values: any[], active?: Set<any>): CompiledQuery {
+    let text = '';
+    const params: any[] = [];
+
+    for (let i = 0; i < strings.length; i++) {
+        text += strings[i];
+        if (i >= values.length) {
+            continue;
+        }
+        const value = values[i];
+
+        if (value instanceof SqlIdentifier) {
+            text += quoteIdentifier(value.name);
+        } else if (value instanceof SqlQuery) {
+            // embedded fragment: splice its text and params in place. The
+            // same fragment may appear several times (a DAG), but a fragment
+            // containing itself would recurse forever — track the expansion
+            // stack and reject cycles with a diagnosable error.
+            active = active || new Set();
+            if (active.has(value)) {
+                throw new Error('circular sql fragment: a query is embedded (transitively) inside itself');
+            }
+            active.add(value);
+            const inner = compile(value.strings, value.values, active);
+            active.delete(value);
+            text += inner.text;
+            params.push(...inner.params);
+        } else if (Array.isArray(value)) {
+            // IN (${[1, 2, 3]}) → IN (?, ?, ?)
+            if (!value.length) {
+                // '' would compile to `IN ()` — invalid SQL raising a server
+                // syntax error the caller never wrote; fail early instead
+                throw new Error('cannot interpolate an empty array (would compile to invalid SQL like "IN ()")');
+            }
+            text += value.map(() => '?').join(', ');
+            params.push(...value);
+        } else {
+            text += '?';
+            params.push(value);
+        }
+    }
+
+    return { text, params };
+}
+
+/**
+ * A lazily executed tagged query. Awaiting it (or calling then/catch/
+ * finally) runs it through the owning Database/Transaction exactly once;
+ * embedding it in another tag uses it as a fragment instead and never
+ * executes it.
+ */
+export class SqlQuery<T = any> implements PromiseLike<T[]> {
+    readonly strings: readonly string[];
+    readonly values: any[];
+    private executor: SqlExecutor;
+    private queryOptions?: QueryOptions;
+    private executed?: Promise<any>;
+    private executedMeta?: boolean;
+
+    constructor(executor: SqlExecutor, strings: readonly string[], values: any[]) {
+        this.executor = executor;
+        this.strings = strings;
+        this.values = values;
+    }
+
+    /** The compiled SQL text (`?` placeholders) and parameter array. */
+    toQuery(): CompiledQuery {
+        return compile(this.strings, this.values);
+    }
+
+    /**
+     * Attach per-query options (timeout, signal, nestTables, …). Must be
+     * called before the query executes — options attached afterwards would
+     * be silently ignored, so that throws instead.
+     */
+    options(queryOptions: QueryOptions): this {
+        if (this.executed) {
+            throw new Error('sql query already executed — call .options() before awaiting it');
+        }
+        this.queryOptions = { ...this.queryOptions, ...queryOptions };
+        return this;
+    }
+
+    /** Execute resolving the full { rows, fields, affectedRows, … } result. */
+    withMeta(): Promise<QueryResult<T>> {
+        return this.run(true);
+    }
+
+    /**
+     * A query executes exactly once, in the shape of its first consumer
+     * (plain rows via then/await, or the full result via withMeta).
+     * Consuming it again in the OTHER shape cannot be honoured from the
+     * cached promise, so it throws rather than silently returning the
+     * wrong shape.
+     */
+    private run(withMeta: boolean): Promise<any> {
+        if (this.executed) {
+            if (withMeta !== this.executedMeta) {
+                throw new Error(this.executedMeta
+                    ? 'sql query already executed via .withMeta() — await that result instead of the query'
+                    : 'sql query already executed as plain rows — call .withMeta() first, or build a new query');
+            }
+            return this.executed;
+        }
+        this.executedMeta = withMeta;
+        const { text, params } = compile(this.strings, this.values);
+        const options = withMeta ? { ...this.queryOptions, withMeta: true } : this.queryOptions;
+        this.executed = this.executor(text, params, options);
+        return this.executed;
+    }
+
+    then<R1 = T[], R2 = never>(
+        onfulfilled?: ((value: T[]) => R1 | PromiseLike<R1>) | null,
+        onrejected?: ((reason: any) => R2 | PromiseLike<R2>) | null
+    ): Promise<R1 | R2> {
+        return this.run(false).then(onfulfilled, onrejected);
+    }
+
+    catch<R = never>(onrejected?: ((reason: any) => R | PromiseLike<R>) | null): Promise<T[] | R> {
+        return this.then(undefined, onrejected);
+    }
+
+    finally(onfinally?: (() => void) | null): Promise<T[]> {
+        return this.run(false).finally(onfinally) as Promise<T[]>;
+    }
+}
+
+/** The dual-use tag: template tag executes, string call quotes an identifier. */
+export interface SqlTag {
+    <T = any>(strings: TemplateStringsArray, ...values: any[]): SqlQuery<T>;
+    (identifier: string): SqlIdentifier;
+}
+
+/**
+ * Build the `sql` tag for a Database/Transaction. `executor` receives the
+ * compiled text, params and per-query options and must return a promise
+ * (Database/Transaction pass their queryAsync).
+ */
+export function makeSqlTag(executor: SqlExecutor): SqlTag {
+    return function sql(first: any, ...values: any[]): any {
+        if (Array.isArray(first) && Object.prototype.hasOwnProperty.call(first, 'raw')) {
+            return new SqlQuery(executor, first, values);
+        }
+        if (typeof first === 'string') {
+            return new SqlIdentifier(first);
+        }
+        throw new Error('sql must be used as a template tag (sql`...`) or called with an identifier string (sql(\'NAME\'))');
+    } as SqlTag;
+}

package/src/types.ts

@@ -5,7 +5,10 @@
 // They now live in the TypeScript source tree and are compiled into the
 // published declaration files.
 
-import type { Readable } from 'stream';
+import type { Readable, Writable } from 'stream';
+import type { SqlTag } from './sql-template';
+
+export type { SqlTag, SqlQuery, SqlIdentifier, CompiledQuery } from './sql-template';
 
 export type DatabaseCallback = (err: any, db: Database) => void;
 export type TransactionCallback = (err: any, transaction: Transaction) => void;
@@ -139,6 +142,89 @@ export type QueryOptions = {
      * unaffected.
      */
     nestTables?: boolean | string;
+    /**
+     * Per-query override of the `transformKeys` connection option: rewrite
+     * object-row keys — `'camel'` turns `FIRST_NAME` into `firstName`, or
+     * pass a custom `(key) => key` mapper. Applied after `lowercase_keys`
+     * and to both parts of `nestTables` keys. Column metadata (`fields`,
+     * typeCast) keeps the raw server aliases.
+     */
+    transformKeys?: 'camel' | ((key: string) => string);
+    /**
+     * Deliver a full result object `{ rows, fields, affectedRows,
+     * recordCounts, warnings }` instead of the bare rows (callback and
+     * promise APIs). For DML, `affectedRows` is what the server actually
+     * changed (`isc_info_sql_records`, one extra lightweight info request
+     * per statement — hence opt-in) and `recordCounts` breaks it down per
+     * verb; for SELECT it is the number of rows returned (pg's `rowCount`
+     * convention) with no extra round-trip. `warnings` carries any
+     * `isc_arg_warning` entries from the execute response. Honoured by
+     * query/execute and their *Async wrappers only — ignored by the
+     * streaming APIs (sequentially/queryStream, where rows bypass the
+     * result) and executeBatch (which has its own completion shape).
+     */
+    withMeta?: boolean;
+}
+
+/** Column metadata delivered in withMeta results (`fields`) — the same
+ *  vocabulary the typeCast hook receives, plus nullable and the relation
+ *  alias/schema. */
+export interface FieldMetadata {
+    type: number;
+    typeName: string;
+    subType?: number;
+    scale?: number;
+    length?: number;
+    nullable?: boolean;
+    field?: string;
+    relation?: string;
+    relationAlias?: string;
+    relationSchema?: string;
+    alias?: string;
+}
+
+/** Per-verb server row counts of an executed DML statement. */
+export interface RecordCounts {
+    selectCount: number;
+    insertCount: number;
+    updateCount: number;
+    deleteCount: number;
+}
+
+/** An isc_arg_warning entry from a server response ('warning' driver event
+ *  and withMeta `warnings`). */
+export interface ServerWarning {
+    gdscode: number;
+    params?: (string | number)[];
+    message: string;
+}
+
+/** Full result shape delivered when `withMeta: true` is set. */
+export interface QueryResult<T = any> {
+    /** Rows array (SELECT), single row object (RETURNING / procedures), or undefined (plain DML). */
+    rows: T[] | T | undefined;
+    fields: FieldMetadata[];
+    /** DML: rows the server changed; SELECT: rows returned. */
+    affectedRows: number;
+    /** Set for DML statements only. */
+    recordCounts?: RecordCounts;
+    warnings: ServerWarning[];
+}
+
+/** Options for batchStream: the executeBatch options plus stream tuning. */
+export type BatchStreamOptions = BatchOptions & {
+    /** Rows buffered per executeBatch flush (default 1000). */
+    flushRows?: number;
+    /** Writable highWaterMark in rows (default: flushRows). */
+    highWaterMark?: number;
+};
+
+/** The Writable returned by batchStream, with totals valid after 'finish'. */
+export interface BatchStream extends Writable {
+    /** Records the server processed so far. */
+    recordCount: number;
+    /** Sum of per-record update counts so far. */
+    affectedRows: number;
 }
 
 export type QueryStreamOptions = QueryOptions & {
@@ -152,11 +238,18 @@ export type QueryStreamOptions = QueryOptions & {
 }
 
 export interface Database {
+    /**
+     * Tagged-template query API (Postgres.js-style): interpolated values
+     * become positional parameters, `sql('NAME')` quotes an identifier,
+     * embedded `sql` fragments compose, arrays expand to `?, ?, ?` lists.
+     * The returned query is a lazy thenable — it executes once, on await.
+     */
+    sql: SqlTag;
     detach(callback?: SimpleCallback): Database;
     transaction(options: TransactionOptions|Isolation|TransactionCallback, callback?: TransactionCallback): Database;
     newStatement(query: string, callback: (err: Error | null, statement: Statement) => void): Database;
-    query(query: string, params: QueryParams, callback: QueryCallback, options?: QueryOptions): Database;
-    execute(query: string, params: QueryParams, callback: QueryCallback, options?: QueryOptions): Database;
+    query<T = any>(query: string, params: QueryParams, callback: (err: any, result: T[], meta?: any[], isSelect?: boolean) => void, options?: QueryOptions): Database;
+    execute<T = any>(query: string, params: QueryParams, callback: (err: any, result: T[], meta?: any[], isSelect?: boolean) => void, options?: QueryOptions): Database;
     /** Bulk-execute in its own transaction, all-or-nothing (Firebird 4.0+). */
     executeBatch(query: string, rows: QueryParams[], callback?: (err: any, result: BatchResult) => void, options?: BatchOptions): Database;
     sequentially(query: string, params: QueryParams, rowCallback: SequentialCallback, callback: SimpleCallback, options?: QueryOptions | boolean): Database;
@@ -167,6 +260,13 @@ export interface Database {
      * fetch and releases the statement.
      */
     queryStream(query: string, params?: QueryParams, options?: QueryStreamOptions): Readable;
+    /**
+     * Bulk-insert Writable (COPY FROM analogue, Firebird 4.0+): write
+     * parameter-array rows; they are flushed in chunks through the batch
+     * API. Runs its own transaction — committed on finish, rolled back on
+     * error/destroy. BLOB columns accept Buffers/strings.
+     */
+    batchStream(query: string, options?: BatchStreamOptions): BatchStream;
     drop(callback: SimpleCallback): void;
     escape(value: any): string;
     attachEvent(callback: any): this;
@@ -176,8 +276,11 @@ export interface Database {
     createSchema(schemaName: string, tablespaceName?: string | QueryCallback, callback?: QueryCallback): Database;
 
     // Promise / async-await API (see README § Promises / async–await).
-    // Result metadata is only available through the callback API.
+    // Pass { withMeta: true } to resolve with the full QueryResult
+    // (rows + fields + affectedRows + warnings) instead of bare rows.
+    queryAsync<T = any>(query: string, params: QueryParams | undefined, options: QueryOptions & { withMeta: true }): Promise<QueryResult<T>>;
     queryAsync<T = any>(query: string, params?: QueryParams, options?: QueryOptions): Promise<T[]>;
+    executeAsync<T = any>(query: string, params: QueryParams | undefined, options: QueryOptions & { withMeta: true }): Promise<QueryResult<T>>;
     executeAsync<T = any>(query: string, params?: QueryParams, options?: QueryOptions): Promise<T[]>;
     executeBatchAsync(query: string, rows: QueryParams[], options?: BatchOptions): Promise<BatchResult>;
     sequentiallyAsync(query: string, params: QueryParams | undefined, rowCallback: SequentialCallback, options?: QueryOptions | boolean): Promise<void>;
@@ -201,9 +304,17 @@ export interface Database {
 }
 
 export interface Transaction {
+    /** Tagged-template query API running inside this transaction (see Database.sql). */
+    sql: SqlTag;
+    /**
+     * Run `work` inside a savepoint: released on resolve, rolled back TO
+     * (undoing only work's changes) on reject — the transaction stays
+     * usable either way. Nestable.
+     */
+    savepoint<T>(work: (transaction: Transaction) => Promise<T> | T): Promise<T>;
     newStatement(query: string, callback: (err: Error | null, statement: Statement) => void): void;
-    query(query: string, params: QueryParams, callback: QueryCallback, options?: QueryOptions): void;
-    execute(query: string, params: QueryParams, callback: QueryCallback, options?: QueryOptions): void;
+    query<T = any>(query: string, params: QueryParams, callback: (err: any, result: T[], meta?: any[], isSelect?: boolean) => void, options?: QueryOptions): void;
+    execute<T = any>(query: string, params: QueryParams, callback: (err: any, result: T[], meta?: any[], isSelect?: boolean) => void, options?: QueryOptions): void;
     /** Bulk-execute within this transaction; per-record failures do not roll back (Firebird 4.0+). */
     executeBatch(query: string, rows: QueryParams[], callback?: (err: any, result: BatchResult) => void, options?: BatchOptions): void;
     sequentially(query: string, params: QueryParams, rowCallback: SequentialCallback, callback: SimpleCallback, options?: QueryOptions | boolean): Database;
@@ -213,13 +324,20 @@ export interface Transaction {
      * transaction is NOT committed when the stream ends.
      */
     queryStream(query: string, params?: QueryParams, options?: QueryStreamOptions): Readable;
+    /**
+     * Bulk-insert Writable inside this transaction (see
+     * Database.batchStream); commit/rollback stays with the caller.
+     */
+    batchStream(query: string, options?: BatchStreamOptions): BatchStream;
     commit(callback?: SimpleCallback): void;
     commitRetaining(callback?: SimpleCallback): void;
     rollback(callback?: SimpleCallback): void;
     rollbackRetaining(callback?: SimpleCallback): void;
 
     // Promise / async-await API
+    queryAsync<T = any>(query: string, params: QueryParams | undefined, options: QueryOptions & { withMeta: true }): Promise<QueryResult<T>>;
     queryAsync<T = any>(query: string, params?: QueryParams, options?: QueryOptions): Promise<T[]>;
+    executeAsync<T = any>(query: string, params: QueryParams | undefined, options: QueryOptions & { withMeta: true }): Promise<QueryResult<T>>;
     executeAsync<T = any>(query: string, params?: QueryParams, options?: QueryOptions): Promise<T[]>;
     executeBatchAsync(query: string, rows: QueryParams[], options?: BatchOptions): Promise<BatchResult>;
     sequentiallyAsync(query: string, params: QueryParams | undefined, rowCallback: SequentialCallback, options?: QueryOptions | boolean): Promise<void>;
@@ -326,6 +444,13 @@ export interface Options {
      * per-query `namedPlaceholders: false` override.
      */
     namedPlaceholders?: boolean;
+    /**
+     * Default character set of a NEWLY CREATED database (create /
+     * attachOrCreate only). Falls back to the connection `encoding`, then
+     * UTF8 — pass e.g. `defaultCharset: 'UTF8'` to keep a modern database
+     * default while connecting with a legacy codepage `encoding`.
+     */
+    defaultCharset?: string;
     /**
      * Qualify object-row keys by source table (same option as mysql2), so
      * JOINed columns with the same name stop overwriting each other:
@@ -336,6 +461,14 @@ export interface Options {
      * array rows (execute) are unaffected. Overridable per query.
      */
     nestTables?: boolean | string;
+    /**
+     * Rewrite object-row keys (Postgres.js `transform` counterpart):
+     * `'camel'` turns `FIRST_NAME` into `firstName`, or pass a custom
+     * `(key) => key` mapper. Applied after `lowercase_keys` and to both
+     * parts of `nestTables` keys; column metadata keeps raw aliases.
+     * Overridable per query.
+     */
+    transformKeys?: 'camel' | ((key: string) => string);
     /**
      * TCP keepalive probing to detect dead/stale connections (same option
      * names as mysql2). On by default; set false to disable.
@@ -374,6 +507,20 @@ export interface Options {
      * Default 0 (idle connections are kept forever).
      */
     idleTimeoutMillis?: number;
+    /**
+     * Pool only: retire a physical connection after this many checkouts
+     * (pg's `maxUses`) — it is closed for good when returned to the pool
+     * and replaced on demand. Bounds server-side resource drift on
+     * long-lived connections. Default 0 (unlimited uses).
+     */
+    maxUses?: number;
+    /**
+     * Pool only: retire a physical connection this many milliseconds after
+     * it was created (Postgres.js's `max_lifetime`), on return to the pool
+     * or by the idle sweep — even below `min`; replacements are created on
+     * demand. Default 0 (unlimited lifetime).
+     */
+    maxLifetimeMillis?: number;
     /**
      * **Firebird 6.0+ only (Protocol 20+)**
      *

package/src/uri.ts

@@ -198,7 +198,59 @@ export function parseConnectionString(str: string): Options {
  */
 export function normalizeOptions<T>(options: T | string): T {
     if (typeof options === 'string') {
-        return parseConnectionString(options) as T;
+        options = parseConnectionString(options) as T;
     }
-    return options;
+    return applyEnvDefaults(options as any);
+}
+
+/**
+ * Fall back to environment variables for connection settings the caller
+ * did not provide — the pg-style convention using Firebird's own names:
+ * ISC_USER / ISC_PASSWORD (honoured by isql and every official tool) plus
+ * FIREBIRD_HOST / FIREBIRD_PORT / FIREBIRD_DATABASE / FIREBIRD_ROLE.
+ * Explicit options always win; the driver's built-in defaults (SYSDBA /
+ * masterkey / 127.0.0.1) still apply when neither is set. A fresh object
+ * is returned so caller-owned options objects are never mutated.
+ */
+const ENV_FALLBACKS: [string, string][] = [
+    ['user', 'ISC_USER'],
+    ['password', 'ISC_PASSWORD'],
+    ['host', 'FIREBIRD_HOST'],
+    ['port', 'FIREBIRD_PORT'],
+    ['database', 'FIREBIRD_DATABASE'],
+    ['role', 'FIREBIRD_ROLE'],
+];
+
+function applyEnvDefaults<T extends Record<string, any>>(options: T): T {
+    let out: any = options;
+    for (const [key, envName] of ENV_FALLBACKS) {
+        const value = process.env[envName];
+        // empty-string env vars (common in CI: `export ISC_PASSWORD=`)
+        // count as unset
+        if (value === undefined || value === '') {
+            continue;
+        }
+        // a service-manager connection's `database` selects the TARGET of
+        // backup/restore — never let a leftover env var pick that silently
+        if (key === 'database' && (options as any).manager) {
+            continue;
+        }
+        if (out[key] === undefined || out[key] === null || out[key] === '') {
+            if (out === options) {
+                out = { ...(options as any) };
+            }
+            if (key === 'port') {
+                const port = Number(value);
+                if (!Number.isFinite(port) || port <= 0) {
+                    // NaN is falsy: it would silently fall back to 3050
+                    // downstream instead of surfacing the typo
+                    throw new Error('Invalid FIREBIRD_PORT environment variable: ' + value);
+                }
+                out[key] = port;
+            } else {
+                out[key] = value;
+            }
+        }
+    }
+    return out;
 }

package/src/utils.ts

@@ -108,6 +108,21 @@ export const parseDate = (str: string): Date => {
 /**
  * Get Error Message per gdscode
  */
+/**
+ * Turn a failed executeBatch completion into the all-or-nothing error
+ * shape shared by database.executeBatch and batchStream: the first
+ * record's own error (or a synthesized summary), with the full
+ * completion attached as err.batchCompletion.
+ */
+export const batchResultToError = (result: { errors: { error: any }[]; errorRecordNumbers: number[] }): any => {
+    const first = result.errors.length ? result.errors[0] : null;
+    const err: any = first
+        ? first.error
+        : new Error('Batch failed for record(s) ' + result.errorRecordNumbers.join(', '));
+    err.batchCompletion = result;
+    return err;
+};
+
 export const lookupMessages = (status: FbStatusItem[]): string => {
     const messages = status.map((item) => {
         let text = MessagesError[item.gdscode];
@@ -143,7 +158,10 @@ export const escape = function(value: any, protocolVersion?: number): string {
         case 'number':
             return value.toString();
         case 'string':
-            return "'" + value.replace(/'/g, "''").replace(/\\/g, '\\\\') + "'";
+            // Firebird string literals have NO backslash escapes — only the
+            // quote is doubled. Doubling backslashes corrupted the data
+            // (issue #156: '\' arrived as '\\').
+            return "'" + value.replace(/'/g, "''") + "'";
     }
 
     if (value instanceof Date)