add queryId to CompiledQuery to allow async communication between…

… more components. (#176)
kysely-org · Jan 26, 2025 · 3b753c7 · 3b753c7
1 parent 5af5f80
commit 3b753c7
Show file tree

Hide file tree

Showing 28 changed files with 740 additions and 458 deletions.
diff --git a/src/dialect/mssql/mssql-driver.ts b/src/dialect/mssql/mssql-driver.ts
@@ -339,7 +339,6 @@ class MssqlRequest<O> {
     (event: 'completed' | 'chunkReady' | 'error', error?: unknown) => void
   >
   readonly #tedious: Tedious
-  #error: Error | any[] | undefined
   #rowCount: number | undefined
 
   constructor(props: MssqlRequestProps<O>) {

diff --git a/src/dialect/mysql/mysql-driver.ts b/src/dialect/mysql/mysql-driver.ts
@@ -7,6 +7,7 @@ import { parseSavepointCommand } from '../../parser/savepoint-parser.js'
 import { CompiledQuery } from '../../query-compiler/compiled-query.js'
 import { QueryCompiler } from '../../query-compiler/query-compiler.js'
 import { isFunction, isObject, freeze } from '../../util/object-utils.js'
+import { createQueryId } from '../../util/query-id.js'
 import { extendStackTrace } from '../../util/stack-trace-utils.js'
 import {
   MysqlDialectConfig,
@@ -98,7 +99,10 @@ export class MysqlDriver implements Driver {
     compileQuery: QueryCompiler['compileQuery'],
   ): Promise<void> {
     await connection.executeQuery(
-      compileQuery(parseSavepointCommand('savepoint', savepointName)),
+      compileQuery(
+        parseSavepointCommand('savepoint', savepointName),
+        createQueryId(),
+      ),
     )
   }
 
@@ -108,7 +112,10 @@ export class MysqlDriver implements Driver {
     compileQuery: QueryCompiler['compileQuery'],
   ): Promise<void> {
     await connection.executeQuery(
-      compileQuery(parseSavepointCommand('rollback to', savepointName)),
+      compileQuery(
+        parseSavepointCommand('rollback to', savepointName),
+        createQueryId(),
+      ),
     )
   }
 
@@ -118,7 +125,10 @@ export class MysqlDriver implements Driver {
     compileQuery: QueryCompiler['compileQuery'],
   ): Promise<void> {
     await connection.executeQuery(
-      compileQuery(parseSavepointCommand('release savepoint', savepointName)),
+      compileQuery(
+        parseSavepointCommand('release savepoint', savepointName),
+        createQueryId(),
+      ),
     )
   }
 
@@ -157,27 +167,21 @@ class MysqlConnection implements DatabaseConnection {
       if (isOkPacket(result)) {
         const { insertId, affectedRows, changedRows } = result
 
-        const numAffectedRows =
-          affectedRows !== undefined && affectedRows !== null
-            ? BigInt(affectedRows)
-            : undefined
-
-        const numChangedRows =
-          changedRows !== undefined && changedRows !== null
-            ? BigInt(changedRows)
-            : undefined
-
         return {
           insertId:
             insertId !== undefined &&
             insertId !== null &&
             insertId.toString() !== '0'
               ? BigInt(insertId)
               : undefined,
-          // TODO: remove.
-          numUpdatedOrDeletedRows: numAffectedRows,
-          numAffectedRows,
-          numChangedRows,
+          numAffectedRows:
+            affectedRows !== undefined && affectedRows !== null
+              ? BigInt(affectedRows)
+              : undefined,
+          numChangedRows:
+            changedRows !== undefined && changedRows !== null
+              ? BigInt(changedRows)
+              : undefined,
           rows: [],
         }
       } else if (Array.isArray(result)) {

diff --git a/src/dialect/postgres/postgres-driver.ts b/src/dialect/postgres/postgres-driver.ts
@@ -3,15 +3,11 @@ import {
   QueryResult,
 } from '../../driver/database-connection.js'
 import { Driver, TransactionSettings } from '../../driver/driver.js'
-import { IdentifierNode } from '../../operation-node/identifier-node.js'
-import { RawNode } from '../../operation-node/raw-node.js'
 import { parseSavepointCommand } from '../../parser/savepoint-parser.js'
 import { CompiledQuery } from '../../query-compiler/compiled-query.js'
-import {
-  QueryCompiler,
-  RootOperationNode,
-} from '../../query-compiler/query-compiler.js'
+import { QueryCompiler } from '../../query-compiler/query-compiler.js'
 import { isFunction, freeze } from '../../util/object-utils.js'
+import { createQueryId } from '../../util/query-id.js'
 import { extendStackTrace } from '../../util/stack-trace-utils.js'
 import {
   PostgresCursorConstructor,
@@ -91,7 +87,10 @@ export class PostgresDriver implements Driver {
     compileQuery: QueryCompiler['compileQuery'],
   ): Promise<void> {
     await connection.executeQuery(
-      compileQuery(parseSavepointCommand('savepoint', savepointName)),
+      compileQuery(
+        parseSavepointCommand('savepoint', savepointName),
+        createQueryId(),
+      ),
     )
   }
 
@@ -101,7 +100,10 @@ export class PostgresDriver implements Driver {
     compileQuery: QueryCompiler['compileQuery'],
   ): Promise<void> {
     await connection.executeQuery(
-      compileQuery(parseSavepointCommand('rollback to', savepointName)),
+      compileQuery(
+        parseSavepointCommand('rollback to', savepointName),
+        createQueryId(),
+      ),
     )
   }
 
@@ -111,7 +113,10 @@ export class PostgresDriver implements Driver {
     compileQuery: QueryCompiler['compileQuery'],
   ): Promise<void> {
     await connection.executeQuery(
-      compileQuery(parseSavepointCommand('release', savepointName)),
+      compileQuery(
+        parseSavepointCommand('release', savepointName),
+        createQueryId(),
+      ),
     )
   }
 
@@ -143,28 +148,20 @@ class PostgresConnection implements DatabaseConnection {
 
   async executeQuery<O>(compiledQuery: CompiledQuery): Promise<QueryResult<O>> {
     try {
-      const result = await this.#client.query<O>(compiledQuery.sql, [
-        ...compiledQuery.parameters,
-      ])
-
-      if (
-        result.command === 'INSERT' ||
-        result.command === 'UPDATE' ||
-        result.command === 'DELETE' ||
-        result.command === 'MERGE'
-      ) {
-        const numAffectedRows = BigInt(result.rowCount)
-
-        return {
-          // TODO: remove.
-          numUpdatedOrDeletedRows: numAffectedRows,
-          numAffectedRows,
-          rows: result.rows ?? [],
-        }
-      }
+      const { command, rowCount, rows } = await this.#client.query<O>(
+        compiledQuery.sql,
+        [...compiledQuery.parameters],
+      )
 
       return {
-        rows: result.rows ?? [],
+        numAffectedRows:
+          command === 'INSERT' ||
+          command === 'UPDATE' ||
+          command === 'DELETE' ||
+          command === 'MERGE'
+            ? BigInt(rowCount)
+            : undefined,
+        rows: rows ?? [],
       }
     } catch (err) {
       throw extendStackTrace(err, new Error())

diff --git a/src/dialect/sqlite/sqlite-driver.ts b/src/dialect/sqlite/sqlite-driver.ts
@@ -8,6 +8,7 @@ import { parseSavepointCommand } from '../../parser/savepoint-parser.js'
 import { CompiledQuery } from '../../query-compiler/compiled-query.js'
 import { QueryCompiler } from '../../query-compiler/query-compiler.js'
 import { freeze, isFunction } from '../../util/object-utils.js'
+import { createQueryId } from '../../util/query-id.js'
 import { SqliteDatabase, SqliteDialectConfig } from './sqlite-dialect-config.js'
 
 export class SqliteDriver implements Driver {
@@ -58,7 +59,10 @@ export class SqliteDriver implements Driver {
     compileQuery: QueryCompiler['compileQuery'],
   ): Promise<void> {
     await connection.executeQuery(
-      compileQuery(parseSavepointCommand('savepoint', savepointName)),
+      compileQuery(
+        parseSavepointCommand('savepoint', savepointName),
+        createQueryId(),
+      ),
     )
   }
 
@@ -68,7 +72,10 @@ export class SqliteDriver implements Driver {
     compileQuery: QueryCompiler['compileQuery'],
   ): Promise<void> {
     await connection.executeQuery(
-      compileQuery(parseSavepointCommand('rollback to', savepointName)),
+      compileQuery(
+        parseSavepointCommand('rollback to', savepointName),
+        createQueryId(),
+      ),
     )
   }
 
@@ -78,7 +85,10 @@ export class SqliteDriver implements Driver {
     compileQuery: QueryCompiler['compileQuery'],
   ): Promise<void> {
     await connection.executeQuery(
-      compileQuery(parseSavepointCommand('release', savepointName)),
+      compileQuery(
+        parseSavepointCommand('release', savepointName),
+        createQueryId(),
+      ),
     )
   }
 
@@ -106,23 +116,19 @@ class SqliteConnection implements DatabaseConnection {
       return Promise.resolve({
         rows: stmt.all(parameters) as O[],
       })
-    } else {
-      const { changes, lastInsertRowid } = stmt.run(parameters)
+    }
 
-      const numAffectedRows =
-        changes !== undefined && changes !== null ? BigInt(changes) : undefined
+    const { changes, lastInsertRowid } = stmt.run(parameters)
 
-      return Promise.resolve({
-        // TODO: remove.
-        numUpdatedOrDeletedRows: numAffectedRows,
-        numAffectedRows,
-        insertId:
-          lastInsertRowid !== undefined && lastInsertRowid !== null
-            ? BigInt(lastInsertRowid)
-            : undefined,
-        rows: [],
-      })
-    }
+    return Promise.resolve({
+      numAffectedRows:
+        changes !== undefined && changes !== null ? BigInt(changes) : undefined,
+      insertId:
+        lastInsertRowid !== undefined && lastInsertRowid !== null
+          ? BigInt(lastInsertRowid)
+          : undefined,
+      rows: [],
+    })
   }
 
   async *streamQuery<R>(

diff --git a/src/driver/database-connection.ts b/src/driver/database-connection.ts
@@ -14,12 +14,6 @@ export interface DatabaseConnection {
 }
 
 export interface QueryResult<O> {
-  /**
-   * @deprecated use {@link QueryResult.numAffectedRows} instead.
-   */
-  // TODO: remove.
-  readonly numUpdatedOrDeletedRows?: bigint
-
   /**
    * This is defined for insert, update, delete and merge queries and contains
    * the number of rows the query inserted/updated/deleted.

diff --git a/src/index.ts b/src/index.ts
@@ -238,6 +238,7 @@ export {
 } from './util/type-utils.js'
 export * from './util/infer-result.js'
 export { logOnce } from './util/log-once.js'
+export { createQueryId, QueryId } from './util/query-id.js'
 
 export {
   SelectExpression,