stabilize-orm 1.3.9 → 2.1.0

package/dist/client.d.ts

@@ -0,0 +1,73 @@
+/**
+ * @file client.ts
+ * @description Provides a unified database client for interacting with PostgreSQL, MySQL, and SQLite.
+ * @author ElectronSz
+ */
+import { type PoolClient } from "pg";
+import mysql from "mysql2/promise";
+import { type DBConfig } from "./types";
+import { type Logger } from "./logger";
+/**
+ * Provides a unified database client for interacting with PostgreSQL, MySQL, and SQLite.
+ */
+export declare class DBClient {
+    private client;
+    private logger;
+    readonly config: DBConfig;
+    private retryAttempts;
+    private retryDelay;
+    private maxJitter;
+    private preparedStatements;
+    isTransactionClient: boolean;
+    /**
+     * Constructs a new DBClient instance.
+     * @param config The database configuration object.
+     * @param logger Optional logger instance. Uses StabilizeLogger if not provided.
+     * @param existingClient Optional existing transaction client.
+     */
+    constructor(config: DBConfig, logger?: Logger, existingClient?: PoolClient | mysql.PoolConnection | null);
+    /**
+     * Initializes the database client based on the configuration.
+     * @param config The database configuration object.
+     */
+    private initializeClient;
+    /**
+     * Returns a random jitter value for retry logic.
+     * @returns A random number up to maxJitter.
+     */
+    private getJitter;
+    /**
+     * Executes a SQL query with retries and returns the resulting rows.
+     * @param query The SQL query string.
+     * @param params Query parameters.
+     * @returns Array of resulting rows.
+     * @throws StabilizeError if all retry attempts fail.
+     */
+    query<T>(query: string, params?: any[]): Promise<T[]>;
+    /**
+     * Runs a callback within a database transaction.
+     * Handles commit/rollback and connection release.
+     * @param callback The callback to execute within the transaction context.
+     * @returns The result of the callback.
+     * @throws StabilizeError if transactions are not supported or rollback is triggered.
+     */
+    transaction<T>(callback: (txClient: DBClient) => Promise<T>): Promise<T>;
+    /**
+     * Closes the database connection.
+     * For pooled connections, ends the pool.
+     * @returns Promise that resolves once the connection is closed.
+     */
+    close(): Promise<void>;
+    queryExec(query: string, params?: any[]): Promise<{
+        affectedRows: number;
+    }>;
+    /**
+     * Executes a migration query (DDL or DML statement) without returning results.
+     * Handles parameterized queries and statement preparation.
+     * @param query The SQL query string.
+     * @param params Query parameters.
+     * @returns Promise that resolves once the query is complete.
+     */
+    migrationQuery(query: string, params?: any[]): Promise<void>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAQ,KAAK,UAAU,EAAE,MAAM,IAAI,CAAC;AAC3C,OAAO,KAAK,MAAM,gBAAgB,CAAC;AACnC,OAAO,EAAE,KAAK,QAAQ,EAA0B,MAAM,SAAS,CAAC;AAChE,OAAO,EAAE,KAAK,MAAM,EAAmB,MAAM,UAAU,CAAC;AA6BxD;;GAEG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAKW;IACzB,OAAO,CAAC,MAAM,CAAS;IACvB,SAAgB,MAAM,EAAE,QAAQ,CAAC;IACjC,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,SAAS,CAAS;IAE1B,OAAO,CAAC,kBAAkB,CAAqC;IACxD,mBAAmB,EAAE,OAAO,CAAS;IAE5C;;;;;OAKG;gBAED,MAAM,EAAE,QAAQ,EAChB,MAAM,GAAE,MAA8B,EACtC,cAAc,GAAE,UAAU,GAAG,KAAK,CAAC,cAAc,GAAG,IAAW;IAgBjE;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAaxB;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAwC;IAEzD;;;;;;OAMG;IACG,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,GAAG,EAAO,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAsD/D;;;;;;OAMG;IACG,WAAW,CAAC,CAAC,EACjB,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,GAC3C,OAAO,CAAC,CAAC,CAAC;IAoDb;;;;OAIG;IACG,KAAK;IAUL,SAAS,CACb,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,GAAG,EAAO,GACjB,OAAO,CAAC;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAyBpC;;;;;;OAMG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,GAAG,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAoBvE"}