@blitznocode/blitz-orm 0.14.0 → 0.14.2

package/dist/index.d.mts

@@ -1,6 +1,64 @@
 import { QueryParameters, QueryResult } from 'surrealdb';
 import { TypeDBDriver, TypeDBSession } from 'typedb-driver';
 
+type AnySurrealClient = SimpleSurrealClient | SurrealPool;
+declare class SurrealClient {
+    private db;
+    private url;
+    private username;
+    private password;
+    private namespace;
+    private database;
+    private connectionPromise;
+    private cancelScheduledConnectionCheck;
+    private cancelRetrySleep;
+    private closed;
+    constructor(params: {
+        url: string;
+        username: string;
+        password: string;
+        namespace: string;
+        database: string;
+    });
+    close(): Promise<void>;
+    connect(): Promise<void>;
+    get isClosed(): boolean;
+    /**
+     * Connect to SurrealDB if not connected and run the callback.
+     */
+    private run;
+    private scheduleConnectionCheck;
+    /**
+     * Try to run the callback until it succeeds or the maximum number of retries is reached.
+     * Retry only on engine disconnected errors.
+     */
+    private tryRun;
+    /**
+     * This method should not throw any exception.
+     */
+    private tryConnectingUntilSucceed;
+    query<T = unknown>(...args: QueryParameters): Promise<T[]>;
+    queryRaw<T = unknown>(...args: QueryParameters): Promise<QueryResult<T>[]>;
+}
+declare class SurrealPool {
+    private queue;
+    private clients;
+    private freeClients;
+    constructor(params: {
+        url: string;
+        username: string;
+        password: string;
+        namespace: string;
+        database: string;
+        totalConnections: number;
+    });
+    close(): Promise<void>;
+    private dequeue;
+    private run;
+    query<T = unknown>(...args: QueryParameters): Promise<T[]>;
+    queryRaw<T = unknown>(...args: QueryParameters): Promise<QueryResult<T>[]>;
+    useClient<T>(cb: (client: SurrealClient) => Promise<T>): Promise<T>;
+}
 declare class SimpleSurrealClient {
     private url;
     private username;
@@ -16,7 +74,7 @@ declare class SimpleSurrealClient {
     });
     private run;
     query<T = unknown>(...args: QueryParameters): Promise<T[]>;
-    query_raw<T = unknown>(...args: QueryParameters): Promise<QueryResult<T>[]>;
+    queryRaw<T = unknown>(...args: QueryParameters): Promise<QueryResult<T>[]>;
 }
 
 type SurrealDBProviderConfig = {
@@ -29,9 +87,16 @@ interface SurrealDBProviderObject extends CommonProvider {
     namespace: string;
     username: string;
     password: string;
+    /**
+     * The total number of connections to the SurrealDB server.
+     * Setting this to a higher number will increase the concurrency of the queries.
+     * totalConnections that is too high will cause the connections to drop.
+     * The default is 64.
+     */
+    totalConnections?: number;
 }
 type SurrealDBHandles = Map<string, {
-    client: SimpleSurrealClient;
+    client: AnySurrealClient;
     providerConfig: SurrealDBProviderConfig;
 }>;