node-firebird 2.11.0 → 2.12.0

package/lib/types.d.ts

@@ -1,4 +1,6 @@
 import type { Readable } 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;
 export type QueryCallback = (err: any, result: any[]) => void;
@@ -127,7 +129,70 @@ 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[];
+}
 export type QueryStreamOptions = QueryOptions & {
     /**
      * Rows buffered internally before fetching pauses (object-mode
@@ -138,6 +203,13 @@ export type QueryStreamOptions = QueryOptions & {
     asObject?: boolean;
 };
 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;
@@ -160,7 +232,13 @@ export interface Database {
     alterTablespace(name: string, filePath: string, callback?: QueryCallback): Database;
     dropTablespace(name: string, callback?: QueryCallback): Database;
     createSchema(schemaName: string, tablespaceName?: string | QueryCallback, callback?: QueryCallback): Database;
+    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>;
@@ -183,6 +261,14 @@ export interface Database {
     cancelAsync(kind?: number): Promise<void>;
 }
 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;
@@ -199,7 +285,13 @@ export interface Transaction {
     commitRetaining(callback?: SimpleCallback): void;
     rollback(callback?: SimpleCallback): void;
     rollbackRetaining(callback?: SimpleCallback): void;
+    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>;
@@ -276,6 +368,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.
@@ -314,6 +414,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/lib/uri.js

@@ -187,7 +187,58 @@ function parseConnectionString(str) {
  */
 function normalizeOptions(options) {
     if (typeof options === 'string') {
-        return parseConnectionString(options);
+        options = parseConnectionString(options);
     }
-    return options;
+    return applyEnvDefaults(options);
+}
+/**
+ * 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 = [
+    ['user', 'ISC_USER'],
+    ['password', 'ISC_PASSWORD'],
+    ['host', 'FIREBIRD_HOST'],
+    ['port', 'FIREBIRD_PORT'],
+    ['database', 'FIREBIRD_DATABASE'],
+    ['role', 'FIREBIRD_ROLE'],
+];
+function applyEnvDefaults(options) {
+    let out = 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.manager) {
+            continue;
+        }
+        if (out[key] === undefined || out[key] === null || out[key] === '') {
+            if (out === options) {
+                out = { ...options };
+            }
+            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/lib/wire/connection.d.ts

@@ -132,6 +132,12 @@ declare class Connection {
     /** `count` may be the callback itself when no fetch size is given. */
     fetch(statement: Statement, transaction: Transaction, count: any, callback?: QueueCallback): void;
     fetchScroll(statement: Statement, transaction: Transaction, direction: string | number, offset: any, count: any, callback?: QueueCallback): void;
+    /**
+     * Query runtime information about a prepared statement via op_info_sql
+     * (e.g. Const.RECORDS_INFO for the per-verb DML row counts). The
+     * response is a plain op_response whose buffer holds the info clusters.
+     */
+    statementInfo(statement: Statement, items: number[], callback?: QueueCallback): this | undefined;
     fetchAll(statement: Statement, transaction: Transaction, callback: Callback<any[]>): void;
     openBlob(blob: Quad, transaction: Transaction, callback: QueueCallback): void;
     closeBlob(blob: any, callback?: QueueCallback, defer?: boolean): void;

package/lib/wire/connection.js

@@ -107,31 +107,8 @@ function statementCacheLimit(options) {
     }
     return 0;
 }
-const SQL_TYPE_NAMES = {
-    [const_1.default.SQL_TEXT]: 'TEXT',
-    [const_1.default.SQL_VARYING]: 'VARYING',
-    [const_1.default.SQL_SHORT]: 'SHORT',
-    [const_1.default.SQL_LONG]: 'LONG',
-    [const_1.default.SQL_FLOAT]: 'FLOAT',
-    [const_1.default.SQL_DOUBLE]: 'DOUBLE',
-    [const_1.default.SQL_D_FLOAT]: 'D_FLOAT',
-    [const_1.default.SQL_TIMESTAMP]: 'TIMESTAMP',
-    [const_1.default.SQL_BLOB]: 'BLOB',
-    [const_1.default.SQL_ARRAY]: 'ARRAY',
-    [const_1.default.SQL_QUAD]: 'QUAD',
-    [const_1.default.SQL_TYPE_TIME]: 'TIME',
-    [const_1.default.SQL_TYPE_DATE]: 'DATE',
-    [const_1.default.SQL_INT64]: 'INT64',
-    [const_1.default.SQL_INT128]: 'INT128',
-    [const_1.default.SQL_TIMESTAMP_TZ]: 'TIMESTAMP_TZ',
-    [const_1.default.SQL_TIMESTAMP_TZ_EX]: 'TIMESTAMP_TZ_EX',
-    [const_1.default.SQL_TIME_TZ]: 'TIME_TZ',
-    [const_1.default.SQL_TIME_TZ_EX]: 'TIME_TZ_EX',
-    [const_1.default.SQL_DEC16]: 'DEC16',
-    [const_1.default.SQL_DEC34]: 'DEC34',
-    [const_1.default.SQL_BOOLEAN]: 'BOOLEAN',
-    [const_1.default.SQL_NULL]: 'NULL',
-};
+// SQL type-code names live in xsqlvar.ts alongside the descriptors
+const SQL_TYPE_NAMES = Xsql.SQL_TYPE_NAMES;
 /**
  * Run the user's typeCast hook (options.typeCast) for one column value.
  * The hook receives the column metadata and a next() returning the value
@@ -145,16 +122,7 @@ function applyTypeCast(options, meta, defaultValue) {
     if (typeof typeCast !== 'function') {
         return defaultValue;
     }
-    const column = {
-        type: meta.type,
-        typeName: SQL_TYPE_NAMES[meta.type] || 'UNKNOWN',
-        subType: meta.subType,
-        scale: meta.scale,
-        length: meta.length,
-        field: meta.field,
-        relation: meta.relation,
-        alias: meta.alias,
-    };
+    const column = Xsql.describeField(meta);
     // A hook exception must never escape into the row-decode loop: there it
     // would be mistaken for an incomplete packet and desync the response
     // queue (the same failure mode as issue #341). Fall back to the default
@@ -396,6 +364,30 @@ class Connection {
                     if (process.env.FIREBIRD_DEBUG) {
                         console.log('[fb-debug] response dispatched: queue remaining=%d pending remaining=%d xdr.pos=%d', self._queue.length, self._pending.length, xdr.pos);
                     }
+                    // Surface isc_arg_warning entries (parsed since 2.10.0 but
+                    // dropped here): resolve their message text and emit them on
+                    // the Database on the next tick, so a listener registered
+                    // inside this very response's callback (e.g. right after
+                    // attach) still receives them.
+                    if (obj && obj.warnings && obj.warnings.length && self.db && typeof self.db.emit === 'function') {
+                        const warnings = obj.warnings;
+                        for (const w of warnings) {
+                            if (w.message === undefined) {
+                                w.message = (0, utils_1.lookupMessages)([w]);
+                                if (!w.message || w.message === 'Unknow error') {
+                                    // codes newer than the bundled firebird.msg:
+                                    // still say something actionable
+                                    w.message = 'Firebird warning ' + w.gdscode +
+                                        (w.params && w.params.length ? ': ' + w.params.join(', ') : '');
+                                }
+                            }
+                        }
+                        process.nextTick(function () {
+                            for (const w of warnings) {
+                                self.db.emit('warning', w);
+                            }
+                        });
+                    }
                     if (obj && obj.status) {
                         obj.message = (0, utils_1.lookupMessages)(obj.status);
                         (0, callback_1.doCallback)(obj, cb);
@@ -1670,6 +1662,27 @@ class Connection {
         callback.statement = statement;
         this._queueEvent(callback);
     }
+    /**
+     * Query runtime information about a prepared statement via op_info_sql
+     * (e.g. Const.RECORDS_INFO for the per-verb DML row counts). The
+     * response is a plain op_response whose buffer holds the info clusters.
+     */
+    statementInfo(statement, items, callback) {
+        if (this._isClosed)
+            return this.throwClosed(callback);
+        this._pending.push('statementInfo');
+        var msg = this._msg;
+        var blr = this._blr;
+        msg.pos = 0;
+        blr.pos = 0;
+        blr.addBytes(items);
+        msg.addInt(const_1.default.op_info_sql);
+        msg.addInt(statement.handle);
+        msg.addInt(0); // incarnation
+        msg.addBlr(blr);
+        msg.addInt(65535); // buffer_length
+        this._queueEvent(callback);
+    }
     fetchAll(statement, transaction, callback) {
         const self = this;
         const custom = statement.options || {};
@@ -2106,7 +2119,8 @@ function decodeResponse(data, callback, cnx, lowercase_keys, cb) {
                 data.frows = data.frows || [];
                 if (custom.asObject && !data.fcols) {
                     const nest = Xsql.resolveNestTables(custom, cnx.options);
-                    const columnKeys = Xsql.computeColumnKeys(output, nest, lowercase_keys);
+                    const transform = Xsql.resolveKeyTransform(custom, cnx.options);
+                    const columnKeys = Xsql.computeColumnKeys(output, nest, lowercase_keys, transform);
                     data.fcols = columnKeys.map((k) => k.key);
                     if (nest === true) {
                         // computeColumnKeys always sets table when nesting

package/lib/wire/const.d.ts

@@ -404,6 +404,10 @@ declare const Const: Readonly<{
     isc_info_sql_stmt_type: number;
     isc_info_sql_get_plan: number;
     isc_info_sql_records: number;
+    isc_info_req_select_count: number;
+    isc_info_req_insert_count: number;
+    isc_info_req_update_count: number;
+    isc_info_req_delete_count: number;
     isc_info_sql_batch_fetch: number;
     isc_info_sql_relation_alias: number;
     isc_info_sql_explain_plan: number;
@@ -589,6 +593,7 @@ declare const Const: Readonly<{
     isc_spb_trc_cfg: number;
     DESCRIBE: number[];
     DESCRIBE_WITH_SCHEMA: number[];
+    RECORDS_INFO: number[];
     SUPPORTED_PROTOCOL: number[][];
 }>;
 export = Const;

package/lib/wire/const.js

@@ -540,6 +540,12 @@ const sqlInfo = {
     isc_info_sql_stmt_type: 21,
     isc_info_sql_get_plan: 22,
     isc_info_sql_records: 23,
+    // per-verb row counts nested inside an isc_info_sql_records cluster
+    // (inf_pub.h isc_info_req_*)
+    isc_info_req_select_count: 13,
+    isc_info_req_insert_count: 14,
+    isc_info_req_update_count: 15,
+    isc_info_req_delete_count: 16,
     isc_info_sql_batch_fetch: 24,
     isc_info_sql_relation_alias: 25, // >: 2.0
     isc_info_sql_explain_plan: 26, // >= 3.0
@@ -618,6 +624,11 @@ const DESCRIBE_WITH_SCHEMA = [
     sqlInfo.isc_info_sql_length,
     sqlInfo.isc_info_sql_describe_end
 ];
+// op_info_sql request for the per-verb DML row counts of an executed
+// statement (withMeta / affectedRows).
+const RECORDS_INFO = [
+    sqlInfo.isc_info_sql_records,
+];
 /***********************/
 /*   ISC Services      */
 /***********************/
@@ -843,6 +854,7 @@ const Const = Object.freeze({
     ...defaultOptions,
     DESCRIBE,
     DESCRIBE_WITH_SCHEMA,
+    RECORDS_INFO,
     ...dpb,
     ...dsql,
     ...fetchOp,

package/lib/wire/database.d.ts

@@ -1,5 +1,6 @@
 import Events from 'events';
 import { type Callback, type SimpleCallback } from '../callback';
+import { type SqlTag } from '../sql-template';
 import FbEventManager from './fbEventManager';
 import type Connection from './connection';
 import type Transaction from './transaction';
@@ -15,7 +16,15 @@ type TransactionArg = TransactionOptions | Isolation | TransactionCb | undefined
 declare class Database extends Events.EventEmitter {
     connection: Connection;
     eventid: number;
+    private _sql?;
     constructor(connection: Connection);
+    /**
+     * Tagged-template query API: db.sql`SELECT ... ${value}` (see README).
+     * Built lazily on first access; the compiled text is positional-only,
+     * so the namedPlaceholders rewriter is disabled — any `:token` in the
+     * template is PSQL (EXECUTE BLOCK), not a placeholder.
+     */
+    get sql(): SqlTag;
     escape(value: any): string;
     detach(callback?: Callback, force?: boolean): this;
     transaction(options: TransactionArg, callback?: TransactionCb): this;

package/lib/wire/database.js

@@ -6,6 +6,7 @@ const events_1 = __importDefault(require("events"));
 const callback_1 = require("../callback");
 const utils_1 = require("../utils");
 const const_1 = __importDefault(require("./const"));
+const sql_template_1 = require("../sql-template");
 const xsqlvar_1 = require("./xsqlvar");
 const eventConnection_1 = __importDefault(require("./eventConnection"));
 const fbEventManager_1 = __importDefault(require("./fbEventManager"));
@@ -76,7 +77,7 @@ function readblob(blob, callback) {
         });
     });
 }
-function fetchBlobSyncRow(row, meta, nestTables, lowercaseKeys, callback) {
+function fetchBlobSyncRow(row, meta, nestTables, lowercaseKeys, transform, callback) {
     if (!row || !meta || !meta.length || !meta.some((m) => m && m.type === const_1.default.SQL_BLOB)) {
         callback(null, row);
         return;
@@ -86,7 +87,7 @@ function fetchBlobSyncRow(row, meta, nestTables, lowercaseKeys, callback) {
     // duplicate JOIN column names (and nested rows) break that alignment.
     // Array rows (sequentially's legacy boolean form) are keyed by index.
     const isArrayRow = Array.isArray(row);
-    const keys = isArrayRow ? null : (0, xsqlvar_1.computeColumnKeys)(meta, nestTables, lowercaseKeys);
+    const keys = isArrayRow ? null : (0, xsqlvar_1.computeColumnKeys)(meta, nestTables, lowercaseKeys, transform);
     const blobCells = [];
     for (let i = 0; i < meta.length; i++) {
         if (!meta[i] || meta[i].type !== const_1.default.SQL_BLOB) {
@@ -126,6 +127,15 @@ class Database extends events_1.default.EventEmitter {
         connection.db = this;
         this.eventid = 1;
     }
+    /**
+     * Tagged-template query API: db.sql`SELECT ... ${value}` (see README).
+     * Built lazily on first access; the compiled text is positional-only,
+     * so the namedPlaceholders rewriter is disabled — any `:token` in the
+     * template is PSQL (EXECUTE BLOCK), not a placeholder.
+     */
+    get sql() {
+        return this._sql || (this._sql = (0, sql_template_1.makeSqlTag)((text, params, options) => this.queryAsync(text, params, { ...options, namedPlaceholders: false })));
+    }
     escape(value) {
         return (0, utils_1.escape)(value, this.connection.accept.protocolVersion);
     }
@@ -263,6 +273,9 @@ class Database extends events_1.default.EventEmitter {
             callback = undefined;
         }
         var self = this;
+        var keyResolutionDone = false;
+        var resolvedNest;
+        var resolvedTransform;
         var _on = function (row, i, meta, next) {
             var done = false;
             var finish = function (err) {
@@ -272,9 +285,15 @@ class Database extends events_1.default.EventEmitter {
                 done = true;
                 next(err);
             };
-            // options is read at call time, after the normalization below
-            const nest = (0, xsqlvar_1.resolveNestTables)(options, self.connection.options);
-            fetchBlobSyncRow(row, meta, nest, self.connection._lowercase_keys, function (blobErr) {
+            // options is read at call time, after the normalization below;
+            // both values are query-invariant, so resolve them once on the
+            // first row instead of allocating per row
+            if (!keyResolutionDone) {
+                resolvedNest = (0, xsqlvar_1.resolveNestTables)(options, self.connection.options);
+                resolvedTransform = (0, xsqlvar_1.resolveKeyTransform)(options, self.connection.options);
+                keyResolutionDone = true;
+            }
+            fetchBlobSyncRow(row, meta, resolvedNest, self.connection._lowercase_keys, resolvedTransform, function (blobErr) {
                 if (blobErr) {
                     finish(blobErr);
                     return;
@@ -468,8 +487,9 @@ class Database extends events_1.default.EventEmitter {
     /*
      * Promise / async-await API.
      * Each *Async method wraps its callback counterpart; the callback API
-     * stays untouched. Result metadata is only available through the
-     * callback API — the promises resolve with the rows alone.
+     * stays untouched. The promises resolve with the rows alone unless
+     * { withMeta: true } is passed, which resolves the full
+     * { rows, fields, affectedRows, recordCounts, warnings } result.
      */
     queryAsync(query, params, options) {
         var self = this;

package/lib/wire/serialize.js

@@ -160,6 +160,10 @@ class BlrReader {
                 break;
             case 4:
                 value = this.buffer.readInt32LE(this.pos);
+                break;
+            case 8:
+                // e.g. record counts above 2^31 (isc_info_sql_records)
+                value = Number(this.buffer.readBigInt64LE(this.pos));
         }
         this.pos += len;
         return value;

package/lib/wire/transaction.d.ts

@@ -1,4 +1,5 @@
 import { type Callback, type SimpleCallback } from '../callback';
+import { type SqlTag } from '../sql-template';
 import type Connection from './connection';
 import type Database from './database';
 import type Statement from './statement';
@@ -8,7 +9,33 @@ declare class Transaction {
     connection: Connection;
     db: Database;
     handle: number;
+    private _sql?;
     constructor(connection: Connection);
+    /**
+     * Tagged-template query API: tx.sql`SELECT ... ${value}` (see README).
+     * Built lazily — transactions are created per-query internally, and
+     * those throwaway instances must not pay for the tag. The compiled text
+     * is positional-only, so the namedPlaceholders rewriter is disabled:
+     * any `:token` in the template is PSQL (EXECUTE BLOCK), not a
+     * placeholder.
+     */
+    get sql(): SqlTag;
+    /** Current savepoint nesting depth (names savepoints, see savepoint()). */
+    private _savepointDepth;
+    /**
+     * Run `work` inside a savepoint (Firebird 1.5+): on resolve the
+     * savepoint is released, on reject the transaction rolls back TO the
+     * savepoint — undoing only work's changes — and the error is rethrown,
+     * leaving the transaction itself usable. Nestable (each call generates
+     * a fresh NF_SP_n name), mirroring db.withTransaction's style and
+     * Postgres.js's sql.savepoint().
+     *
+     * Do NOT run sibling savepoints concurrently on one transaction
+     * (Promise.all): Firebird's RELEASE SAVEPOINT also releases every
+     * savepoint created after it, so interleaved siblings release each
+     * other. Nested (awaited) savepoints are fine.
+     */
+    savepoint<T>(work: (transaction: this) => Promise<T> | T): Promise<T>;
     /** Per-call options.namedPlaceholders overrides the connection option. */
     private namedPlaceholdersEnabled;
     newStatement(query: string, callback: StatementCb, options?: InternalQueryOptions): void;