velocious 1.0.577 → 1.0.579

package/build/src/database/drivers/base.d.ts

@@ -1,10 +1,270 @@
-export default class VelociousDatabaseDriversBase {
+export type CreateIndexSqlArgs = {
     /**
-     * Runs constructor.
-     * @param {import("../../configuration-types.js").DatabaseConfigurationType} config - Configuration object.
-     * @param {import("../../configuration.js").default} configuration - Configuration instance.
+     * - Columns to include in the index.
      */
-    constructor(config: import("../../configuration-types.js").DatabaseConfigurationType, configuration: import("../../configuration.js").default);
+    columns: Array<string | import("./../table-data/table-column.js").default>;
+    /**
+     * - Skip creation if the index already exists.
+     */
+    ifNotExists?: boolean;
+    /**
+     * - Explicit index name to use.
+     */
+    name?: string;
+    /**
+     * - Whether the index should enforce uniqueness.
+     */
+    unique?: boolean;
+    /**
+     * - Name of the table to add the index to.
+     */
+    tableName: string;
+};
+export type RemoveIndexSqlArgs = {
+    /**
+     * - Index name to drop.
+     */
+    name: string;
+    /**
+     * - Name of the table the index belongs to.
+     */
+    tableName: string;
+};
+export type DropTableSqlArgsType = {
+    /**
+     * - Whether dependent objects should be dropped too.
+     */
+    cascade?: boolean;
+    /**
+     * - Skip dropping if the table does not exist.
+     */
+    ifExists?: boolean;
+};
+export type DeleteSqlArgsType = {
+    /**
+     * - Table name to delete from.
+     */
+    tableName: string;
+    /**
+     * - Conditions used to build the delete WHERE clause.
+     */
+    conditions: {
+        [key: string]: ReturnType<typeof JSON.parse>;
+    };
+};
+export type InsertSqlArgsType = {
+    /**
+     * - Column names for `rows` inserts.
+     */
+    columns?: string[];
+    /**
+     * - Column/value pairs for a single-row insert.
+     */
+    data?: {
+        [key: string]: ReturnType<typeof JSON.parse>;
+    };
+    /**
+     * - Whether this insert should be treated as multi-row.
+     */
+    multiple?: boolean;
+    /**
+     * - Column names to return after insert.
+     */
+    returnLastInsertedColumnNames?: string[];
+    /**
+     * - Row values for a multi-row insert.
+     */
+    rows?: Array<Array<ReturnType<typeof JSON.parse>>>;
+    /**
+     * - Table name to insert into.
+     */
+    tableName: string;
+};
+export type QueryRowType = Record<string, ReturnType<typeof JSON.parse>>;
+export type QueryResultType = Array<QueryRowType>;
+export type TransactionCallbackFrame = {
+    /**
+     * - Callbacks to merge or run after commit.
+     */
+    afterCommitCallbacks: Array<() => void | Promise<void>>;
+    /**
+     * - Guards to run before this frame completes.
+     */
+    beforeCommitCallbacks: Array<() => void | Promise<void>>;
+};
+export type RetryableDatabaseErrorResult = {
+    /**
+     * - Whether the error should be retried.
+     */
+    retry: boolean;
+    /**
+     * - Whether to reconnect before retrying.
+     */
+    reconnect: boolean;
+    /**
+     * - Whether the error is a transaction deadlock/lock-wait-timeout that should retry the whole transaction.
+     */
+    deadlock?: boolean;
+    /**
+     * - Override the max retry attempts.
+     */
+    maxTries?: number;
+    /**
+     * - Wait time before retrying in milliseconds.
+     */
+    waitMs?: number;
+};
+export type QueryOptions = {
+    /**
+     * - Query log subject.
+     */
+    logName?: string;
+    /**
+     * - Whether to log the query.
+     */
+    logQuery?: boolean;
+    /**
+     * - Whether to add process-list comments to the query.
+     */
+    processListComment?: boolean;
+    /**
+     * - Whether retryable errors may retry the query; defaults to true.
+     */
+    retry?: boolean;
+    /**
+     * - Whether to ensure the configured database session time zone before the query.
+     */
+    sessionTimeZone?: boolean;
+    /**
+     * - Aborts the in-flight query (destroying its connection) when it fires.
+     */
+    signal?: AbortSignal;
+    /**
+     * - Stack captured at the caller boundary.
+     */
+    sourceStack?: string;
+    /**
+     * - Opaque owner for an operation-leased connection.
+     */
+    operationOwner?: symbol;
+};
+export type ActiveQueryDebugSnapshot = {
+    /**
+     * - Database annotations active when the query started.
+     */
+    annotations: string[];
+    /**
+     * - Query log name.
+     */
+    logName: string;
+    /**
+     * - Query start timestamp.
+     */
+    startedAtUnixMs: number;
+    /**
+     * - Query runtime in milliseconds.
+     */
+    runningMs: number;
+    /**
+     * - Truncated SQL preview.
+     */
+    sqlPreview: string;
+};
+export type DatabaseConnectionDebugSnapshot = {
+    /**
+     * - Currently running query, if any.
+     */
+    activeQuery: ActiveQueryDebugSnapshot | null;
+    /**
+     * - Checkout start timestamp for active checkouts.
+     */
+    checkedOutAtUnixMs: number | undefined;
+    /**
+     * - Active checkout age in milliseconds.
+     */
+    checkoutAgeMs: number | undefined;
+    /**
+     * - Human-readable checkout name.
+     */
+    checkoutName: string | undefined;
+    /**
+     * - Driver class name.
+     */
+    driverClass: string;
+    /**
+     * - Pool checkout ID sequence.
+     */
+    idSeq: number | undefined;
+    /**
+     * - Number of open transaction frames.
+     */
+    openTransactions: number;
+    /**
+     * - Number of cached schema metadata entries.
+     */
+    schemaCacheEntries: number;
+};
+export type ActiveQueryState = {
+    /**
+     * - Database annotations active when the query started.
+     */
+    annotations: string[];
+    /**
+     * - Query log name.
+     */
+    logName: string;
+    /**
+     * - Query start timestamp.
+     */
+    startedAtUnixMs: number;
+    /**
+     * - Truncated SQL preview.
+     */
+    sqlPreview: string;
+};
+export type UpdateSqlArgsType = {
+    /**
+     * - Conditions used to build the update WHERE clause.
+     */
+    conditions: object;
+    /**
+     * - Column/value pairs to update.
+     */
+    data: object;
+    /**
+     * - Table name to update.
+     */
+    tableName: string;
+};
+export type UpsertSqlArgsType = {
+    /**
+     * - Columns that define a conflict.
+     */
+    conflictColumns: string[];
+    /**
+     * - Column/value pairs to insert.
+     */
+    data: object;
+    /**
+     * - Table name to upsert into.
+     */
+    tableName: string;
+    /**
+     * - Columns to update on conflict.
+     */
+    updateColumns: string[];
+};
+import Logger from "../../logger.js";
+import Query from "../query/index.js";
+import Mutex from "epic-locks/build/mutex.js";
+export default class VelociousDatabaseDriversBase {
+    _args: import("../../configuration-types.js").DatabaseConfigurationType;
+    configuration: import("../../configuration.js").default;
+    mutex: Mutex;
+    logger: Logger;
+    _transactionsCount: number;
+    _transactionsActionsMutex: Mutex;
+    _connectionCheckedOutAtUnixMs: number | undefined;
     /**
      * Id seq.
      * @type {number | undefined} */
@@ -15,8 +275,8 @@ export default class VelociousDatabaseDriversBase {
     _transactionCallbackFrames: TransactionCallbackFrame[];
     /**
      * Narrows the runtime value to the documented type.
-     * @type {Map<string, Promise<?>>} */
-    _schemaCache: Map<string, Promise<unknown>>;
+     * @type {Map<string, Promise<ReturnType<typeof JSON.parse>>>} */
+    _schemaCache: Map<string, Promise<ReturnType<typeof JSON.parse>>>;
     /**
      * Narrows the runtime value to the documented type.
      * @type {(() => void) | undefined} */
@@ -36,12 +296,12 @@ export default class VelociousDatabaseDriversBase {
      * @type {import("../operation-lease.js").default | undefined}
      */
     _operationLease: import("../operation-lease.js").default | undefined;
-    _args: import("../../configuration-types.js").DatabaseConfigurationType;
-    configuration: import("../../configuration.js").default;
-    mutex: Mutex;
-    logger: Logger;
-    _transactionsCount: number;
-    _transactionsActionsMutex: Mutex;
+    /**
+     * Runs constructor.
+     * @param {import("../../configuration-types.js").DatabaseConfigurationType} config - Configuration object.
+     * @param {import("../../configuration.js").default} configuration - Configuration instance.
+     */
+    constructor(config: import("../../configuration-types.js").DatabaseConfigurationType, configuration: import("../../configuration.js").default);
     /**
      * Runs add foreign key.
      * @param {string} tableName - Table name.
@@ -93,7 +353,6 @@ export default class VelociousDatabaseDriversBase {
      * @returns {Promise<void>} - Resolves when complete.
      */
     setConnectionCheckoutName(name: string | undefined): Promise<void>;
-    _connectionCheckedOutAtUnixMs: number | undefined;
     /**
      * Runs clear connection checkout name.
      * @returns {Promise<void>} - Resolves when complete.
@@ -115,9 +374,9 @@ export default class VelociousDatabaseDriversBase {
      * @returns {string[]} - SQL statements.
      */
     createDatabaseSql(databaseName: string, args?: {
-        ifNotExists?: boolean | undefined;
-        databaseCharset?: string | undefined;
-        databaseCollation?: string | undefined;
+        ifNotExists?: boolean;
+        databaseCharset?: string;
+        databaseCollation?: string;
     }): string[];
     /**
      * Runs drop database sql.
@@ -128,7 +387,7 @@ export default class VelociousDatabaseDriversBase {
      * @returns {string[]} - SQL statements.
      */
     dropDatabaseSql(databaseName: string, args?: {
-        ifExists?: boolean | undefined;
+        ifExists?: boolean;
     }): string[];
     /**
      * Runs create index sqls.
@@ -188,10 +447,10 @@ export default class VelociousDatabaseDriversBase {
     /**
      * Runs escape.
      * @abstract
-     * @param {?} value - Value to use.
-     * @returns {?} - The escape.
+     * @param {ReturnType<typeof JSON.parse>} value - Value to use.
+     * @returns {ReturnType<typeof JSON.parse>} - The escape.
      */
-    escape(value: unknown): unknown;
+    escape(value: ReturnType<typeof JSON.parse>): ReturnType<typeof JSON.parse>;
     /**
      * Runs get args.
      * @returns {import("../../configuration-types.js").DatabaseConfigurationType} - The args.
@@ -270,10 +529,10 @@ export default class VelociousDatabaseDriversBase {
     _cachedTableSchemaMetadata<T>(tableName: string, metadataName: string, callback: () => Promise<T>): Promise<T>;
     /**
      * Runs schema cache return value.
-     * @param {?} value - Cached value.
-     * @returns {?} - Value returned to callers.
+     * @param {ReturnType<typeof JSON.parse>} value - Cached value.
+     * @returns {ReturnType<typeof JSON.parse>} - Value returned to callers.
      */
-    _schemaCacheReturnValue(value: unknown): unknown;
+    _schemaCacheReturnValue(value: ReturnType<typeof JSON.parse>): ReturnType<typeof JSON.parse>;
     /**
      * Runs get tables.
      * @abstract
@@ -333,10 +592,10 @@ export default class VelociousDatabaseDriversBase {
      * Runs insert multiple.
      * @param {string} tableName - Table name.
      * @param {Array<string>} columns - Column names.
-     * @param {Array<Array<?>>} rows - Rows to insert.
+     * @param {Array<Array<ReturnType<typeof JSON.parse>>>} rows - Rows to insert.
      * @returns {Promise<void>} - Resolves when complete.
      */
-    insertMultiple(tableName: string, columns: Array<string>, rows: Array<Array<unknown>>): Promise<void>;
+    insertMultiple(tableName: string, columns: Array<string>, rows: Array<Array<ReturnType<typeof JSON.parse>>>): Promise<void>;
     /**
      * Runs insert sql.
      * @abstract
@@ -359,17 +618,17 @@ export default class VelociousDatabaseDriversBase {
     lastInsertID(_options?: QueryOptions): Promise<number>;
     /**
      * Runs convert value.
-     * @param {?} value - Value to use.
-     * @returns {?} - The convert value.
+     * @param {ReturnType<typeof JSON.parse>} value - Value to use.
+     * @returns {ReturnType<typeof JSON.parse>} - The convert value.
      */
-    _convertValue(value: unknown): unknown;
+    _convertValue(value: ReturnType<typeof JSON.parse>): ReturnType<typeof JSON.parse>;
     /**
      * Whether a value is a plain object or array that should be JSON-encoded for a
      * JSON/text column. Excludes Buffers and class instances (e.g. model records).
-     * @param {?} value - Value to test.
+     * @param {ReturnType<typeof JSON.parse>} value - Value to test.
      * @returns {boolean} - Whether to JSON-encode the value.
      */
-    _isJsonEncodableValue(value: unknown): boolean;
+    _isJsonEncodableValue(value: ReturnType<typeof JSON.parse>): boolean;
     /**
      * Runs options.
      * @abstract
@@ -378,10 +637,10 @@ export default class VelociousDatabaseDriversBase {
     options(): import("../query-parser/options.js").default;
     /**
      * Runs quote.
-     * @param {?} value - Value to use.
+     * @param {ReturnType<typeof JSON.parse>} value - Value to use.
      * @returns {number | string} - The quote.
      */
-    quote(value: unknown): number | string;
+    quote(value: ReturnType<typeof JSON.parse>): number | string;
     /**
      * Runs quote column.
      * @param {string} columnName - Column name.
@@ -493,9 +752,9 @@ export default class VelociousDatabaseDriversBase {
      * @template T
      * @param {() => Promise<T>} callback - Callback function.
      * @param {Pick<QueryOptions, "operationOwner">} options - Transaction ownership.
-     * @returns {Promise<?>} - Resolves with the transaction result.
+     * @returns {Promise<ReturnType<typeof JSON.parse>>} - Resolves with the transaction result.
      */
-    _runTransactionAttempt<T>(callback: () => Promise<T>, options: Pick<QueryOptions, "operationOwner">): Promise<unknown>;
+    _runTransactionAttempt<T>(callback: () => Promise<T>, options: Pick<QueryOptions, "operationOwner">): Promise<ReturnType<typeof JSON.parse>>;
     /**
      * Registers a guard to run after the current transaction callback succeeds and before its
      * outer commit or nested savepoint release.
@@ -823,10 +1082,10 @@ export default class VelociousDatabaseDriversBase {
     enableForeignKeys(): Promise<void>;
     /**
      * Runs with disabled foreign keys.
-     * @param {function() : void} callback - Callback function.
-     * @returns {Promise<?>} - Resolves with the with disabled foreign keys.
+     * @param {() => void} callback - Callback function.
+     * @returns {Promise<ReturnType<typeof JSON.parse>>} - Resolves with the with disabled foreign keys.
      */
-    withDisabledForeignKeys(callback: () => void): Promise<unknown>;
+    withDisabledForeignKeys(callback: () => void): Promise<ReturnType<typeof JSON.parse>>;
     /**
      * Blocks until a named advisory lock is acquired on this connection.
      * Advisory locks are connection-scoped and do not interact with row or
@@ -903,308 +1162,4 @@ export default class VelociousDatabaseDriversBase {
      */
     isAdvisoryLockHeld(name: string): Promise<boolean>;
 }
-/**
- * CreateIndexSqlArgs type.
- */
-export type CreateIndexSqlArgs = {
-    /**
-     * - Columns to include in the index.
-     */
-    columns: Array<string | import("./../table-data/table-column.js").default>;
-    /**
-     * - Skip creation if the index already exists.
-     */
-    ifNotExists?: boolean | undefined;
-    /**
-     * - Explicit index name to use.
-     */
-    name?: string | undefined;
-    /**
-     * - Whether the index should enforce uniqueness.
-     */
-    unique?: boolean | undefined;
-    /**
-     * - Name of the table to add the index to.
-     */
-    tableName: string;
-};
-/**
- * RemoveIndexSqlArgs type.
- */
-export type RemoveIndexSqlArgs = {
-    /**
-     * - Index name to drop.
-     */
-    name: string;
-    /**
-     * - Name of the table the index belongs to.
-     */
-    tableName: string;
-};
-/**
- * DropTableSqlArgsType type.
- */
-export type DropTableSqlArgsType = {
-    /**
-     * - Whether dependent objects should be dropped too.
-     */
-    cascade?: boolean | undefined;
-    /**
-     * - Skip dropping if the table does not exist.
-     */
-    ifExists?: boolean | undefined;
-};
-/**
- * DeleteSqlArgsType type.
- */
-export type DeleteSqlArgsType = {
-    /**
-     * - Table name to delete from.
-     */
-    tableName: string;
-    /**
-     * - Conditions used to build the delete WHERE clause.
-     */
-    conditions: {
-        [key: string]: unknown;
-    };
-};
-/**
- * InsertSqlArgsType type.
- */
-export type InsertSqlArgsType = {
-    /**
-     * - Column names for `rows` inserts.
-     */
-    columns?: string[] | undefined;
-    /**
-     * - Column/value pairs for a single-row insert.
-     */
-    data?: {
-        [key: string]: any;
-    } | undefined;
-    /**
-     * - Whether this insert should be treated as multi-row.
-     */
-    multiple?: boolean | undefined;
-    /**
-     * - Column names to return after insert.
-     */
-    returnLastInsertedColumnNames?: string[] | undefined;
-    /**
-     * - Row values for a multi-row insert.
-     */
-    rows?: any[][] | undefined;
-    /**
-     * - Table name to insert into.
-     */
-    tableName: string;
-};
-/**
- * QueryRowType type.
- */
-export type QueryRowType = Record<string, unknown>;
-/**
- * QueryRowType type.
- */
-export type QueryResultType = Array<QueryRowType>;
-/**
- * TransactionCallbackFrame type.
- */
-export type TransactionCallbackFrame = {
-    /**
-     * - Callbacks to merge or run after commit.
-     */
-    afterCommitCallbacks: Array<() => void | Promise<void>>;
-    /**
-     * - Guards to run before this frame completes.
-     */
-    beforeCommitCallbacks: Array<() => void | Promise<void>>;
-};
-/**
- * RetryableDatabaseErrorResult type.
- */
-export type RetryableDatabaseErrorResult = {
-    /**
-     * - Whether the error should be retried.
-     */
-    retry: boolean;
-    /**
-     * - Whether to reconnect before retrying.
-     */
-    reconnect: boolean;
-    /**
-     * - Whether the error is a transaction deadlock/lock-wait-timeout that should retry the whole transaction.
-     */
-    deadlock?: boolean | undefined;
-    /**
-     * - Override the max retry attempts.
-     */
-    maxTries?: number | undefined;
-    /**
-     * - Wait time before retrying in milliseconds.
-     */
-    waitMs?: number | undefined;
-};
-/**
- * QueryOptions type.
- */
-export type QueryOptions = {
-    /**
-     * - Query log subject.
-     */
-    logName?: string | undefined;
-    /**
-     * - Whether to log the query.
-     */
-    logQuery?: boolean | undefined;
-    /**
-     * - Whether to add process-list comments to the query.
-     */
-    processListComment?: boolean | undefined;
-    /**
-     * - Whether retryable errors may retry the query; defaults to true.
-     */
-    retry?: boolean | undefined;
-    /**
-     * - Whether to ensure the configured database session time zone before the query.
-     */
-    sessionTimeZone?: boolean | undefined;
-    /**
-     * - Aborts the in-flight query (destroying its connection) when it fires.
-     */
-    signal?: AbortSignal | undefined;
-    /**
-     * - Stack captured at the caller boundary.
-     */
-    sourceStack?: string | undefined;
-    /**
-     * - Opaque owner for an operation-leased connection.
-     */
-    operationOwner?: symbol | undefined;
-};
-/**
- * ActiveQueryDebugSnapshot type.
- */
-export type ActiveQueryDebugSnapshot = {
-    /**
-     * - Database annotations active when the query started.
-     */
-    annotations: string[];
-    /**
-     * - Query log name.
-     */
-    logName: string;
-    /**
-     * - Query start timestamp.
-     */
-    startedAtUnixMs: number;
-    /**
-     * - Query runtime in milliseconds.
-     */
-    runningMs: number;
-    /**
-     * - Truncated SQL preview.
-     */
-    sqlPreview: string;
-};
-/**
- * DatabaseConnectionDebugSnapshot type.
- */
-export type DatabaseConnectionDebugSnapshot = {
-    /**
-     * - Currently running query, if any.
-     */
-    activeQuery: ActiveQueryDebugSnapshot | null;
-    /**
-     * - Checkout start timestamp for active checkouts.
-     */
-    checkedOutAtUnixMs: number | undefined;
-    /**
-     * - Active checkout age in milliseconds.
-     */
-    checkoutAgeMs: number | undefined;
-    /**
-     * - Human-readable checkout name.
-     */
-    checkoutName: string | undefined;
-    /**
-     * - Driver class name.
-     */
-    driverClass: string;
-    /**
-     * - Pool checkout ID sequence.
-     */
-    idSeq: number | undefined;
-    /**
-     * - Number of open transaction frames.
-     */
-    openTransactions: number;
-    /**
-     * - Number of cached schema metadata entries.
-     */
-    schemaCacheEntries: number;
-};
-/**
- * ActiveQueryState type.
- */
-export type ActiveQueryState = {
-    /**
-     * - Database annotations active when the query started.
-     */
-    annotations: string[];
-    /**
-     * - Query log name.
-     */
-    logName: string;
-    /**
-     * - Query start timestamp.
-     */
-    startedAtUnixMs: number;
-    /**
-     * - Truncated SQL preview.
-     */
-    sqlPreview: string;
-};
-/**
- * UpdateSqlArgsType type.
- */
-export type UpdateSqlArgsType = {
-    /**
-     * - Conditions used to build the update WHERE clause.
-     */
-    conditions: object;
-    /**
-     * - Column/value pairs to update.
-     */
-    data: object;
-    /**
-     * - Table name to update.
-     */
-    tableName: string;
-};
-/**
- * UpsertSqlArgsType type.
- */
-export type UpsertSqlArgsType = {
-    /**
-     * - Columns that define a conflict.
-     */
-    conflictColumns: string[];
-    /**
-     * - Column/value pairs to insert.
-     */
-    data: object;
-    /**
-     * - Table name to upsert into.
-     */
-    tableName: string;
-    /**
-     * - Columns to update on conflict.
-     */
-    updateColumns: string[];
-};
-import Mutex from "epic-locks/build/mutex.js";
-import Logger from "../../logger.js";
-import Query from "../query/index.js";
 //# sourceMappingURL=base.d.ts.map