kysely 0.11.2 → 0.11.3

package/dist/cjs/dialect/mysql/mysql-query-compiler.d.ts

@@ -1,7 +1,5 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class MysqlQueryCompiler extends DefaultQueryCompiler {
-    protected visitReturning(): void;
-    protected getSql(): string;
     protected getCurrentParameterPlaceholder(): string;
     protected getLeftIdentifierWrapper(): string;
     protected getRightIdentifierWrapper(): string;

package/dist/cjs/dialect/mysql/mysql-query-compiler.js

@@ -3,12 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MysqlQueryCompiler = void 0;
 const default_query_compiler_js_1 = require("../../query-compiler/default-query-compiler.js");
 class MysqlQueryCompiler extends default_query_compiler_js_1.DefaultQueryCompiler {
-    visitReturning() {
-        // Do nothing.
-    }
-    getSql() {
-        return super.getSql().trimEnd();
-    }
     getCurrentParameterPlaceholder() {
         return '?';
     }

package/dist/cjs/dialect/postgres/postgres-query-compiler.d.ts

@@ -1,3 +1,6 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class PostgresQueryCompiler extends DefaultQueryCompiler {
+    protected getCurrentParameterPlaceholder(): string;
+    protected getLeftIdentifierWrapper(): string;
+    protected getRightIdentifierWrapper(): string;
 }

package/dist/cjs/dialect/postgres/postgres-query-compiler.js

@@ -2,7 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PostgresQueryCompiler = void 0;
 const default_query_compiler_js_1 = require("../../query-compiler/default-query-compiler.js");
-// The default query compiler is for PostgreSQL.
 class PostgresQueryCompiler extends default_query_compiler_js_1.DefaultQueryCompiler {
+    getCurrentParameterPlaceholder() {
+        return '$' + this.numParameters;
+    }
+    getLeftIdentifierWrapper() {
+        return '"';
+    }
+    getRightIdentifierWrapper() {
+        return '"';
+    }
 }
 exports.PostgresQueryCompiler = PostgresQueryCompiler;

package/dist/cjs/dialect/sqlite/sqlite-query-compiler.d.ts

@@ -1,7 +1,7 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class SqliteQueryCompiler extends DefaultQueryCompiler {
-    protected visitReturning(): void;
-    protected getSql(): string;
     protected getCurrentParameterPlaceholder(): string;
+    protected getLeftIdentifierWrapper(): string;
+    protected getRightIdentifierWrapper(): string;
     protected getAutoIncrement(): string;
 }

package/dist/cjs/dialect/sqlite/sqlite-query-compiler.js

@@ -3,15 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SqliteQueryCompiler = void 0;
 const default_query_compiler_js_1 = require("../../query-compiler/default-query-compiler.js");
 class SqliteQueryCompiler extends default_query_compiler_js_1.DefaultQueryCompiler {
-    visitReturning() {
-        // Do nothing.
-    }
-    getSql() {
-        return super.getSql().trimEnd();
-    }
     getCurrentParameterPlaceholder() {
         return '?';
     }
+    getLeftIdentifierWrapper() {
+        return '"';
+    }
+    getRightIdentifierWrapper() {
+        return '"';
+    }
     getAutoIncrement() {
         return 'autoincrement';
     }

package/dist/cjs/driver/runtime-driver.js

@@ -97,7 +97,7 @@ class RuntimeConnection {
     #logQuery(compiledQuery, startTime) {
         this.#log.query(() => ({
             level: 'query',
-            sql: compiledQuery.sql,
+            query: compiledQuery,
             queryDurationMillis: this.#calculateDurationMillis(startTime),
         }));
     }

package/dist/cjs/index.d.ts

@@ -127,6 +127,7 @@ export * from './operation-node/where-node.js';
 export * from './operation-node/with-node.js';
 export * from './introspection/database-introspector.js';
 export * from './util/compilable.js';
+export * from './util/log.js';
 export { AnyColumn, UnknownRow, AnyQueryBuilder } from './util/type-utils.js';
 export { SelectExpression, SelectExpressionOrList, } from './parser/select-parser.js';
 export { ReferenceExpression, ReferenceExpressionOrList, } from './parser/reference-parser.js';

package/dist/cjs/index.js

@@ -139,3 +139,4 @@ __exportStar(require("./operation-node/where-node.js"), exports);
 __exportStar(require("./operation-node/with-node.js"), exports);
 __exportStar(require("./introspection/database-introspector.js"), exports);
 __exportStar(require("./util/compilable.js"), exports);
+__exportStar(require("./util/log.js"), exports);

package/dist/cjs/kysely.d.ts

@@ -10,7 +10,7 @@ import { DatabaseIntrospector } from './introspection/database-introspector.js';
 import { Driver, IsolationLevel } from './driver/driver.js';
 import { ParseContext } from './parser/parse-context.js';
 import { FunctionBuilder } from './query-builder/function-builder.js';
-import { LogLevel } from './util/log.js';
+import { LogConfig } from './util/log.js';
 /**
  * The main Kysely class.
  *
@@ -235,17 +235,33 @@ export interface KyselyConfig {
     readonly dialect: Dialect;
     readonly plugins?: KyselyPlugin[];
     /**
-     * A list of log levels to log.
+     * A list of log levels to log or a custom logger function.
      *
      * Currently there's only two levels: `query` and `error`.
      * This will be expanded based on user feedback later.
      *
-     * Log levels:
+     * @example
+     * ```ts
+     * const db = new Kysely<Database>({
+     *   dialect: new PostgresDialect(postgresConfig),
+     *   log: ['query', 'error']
+     * })
+     * ```
      *
-     *  - query: Log each query's SQL and duration using console.log
-     *  - error: Log all query errors using console.error
+     * @example
+     * ```ts
+     * const db = new Kysely<Database>({
+     *   dialect: new PostgresDialect(postgresConfig),
+     *   log(event): void {
+     *     if (event.level === 'query') {
+     *       console.log(event.query.sql)
+     *       console.log(event.query.parameters)
+     *     }
+     *   }
+     * })
+     * ```
      */
-    readonly log?: ReadonlyArray<LogLevel>;
+    readonly log?: LogConfig;
 }
 export declare class ConnectionBuilder<DB> {
     #private;

package/dist/cjs/util/log.d.ts

@@ -1,19 +1,21 @@
+import { CompiledQuery } from '../index.js';
 import { ArrayItemType } from './type-utils.js';
 export declare const LOG_LEVELS: readonly ["query", "error"];
 export declare type LogLevel = ArrayItemType<typeof LOG_LEVELS>;
-export declare class Log {
-    #private;
-    constructor(levels: ReadonlyArray<LogLevel>);
-    query(getEvent: () => QueryLogEvent): void;
-    error(getEvent: () => ErrorLogEvent): void;
-}
-export declare type LogEvent = QueryLogEvent | ErrorLogEvent;
 export interface QueryLogEvent {
     readonly level: 'query';
-    readonly sql: string;
+    readonly query: CompiledQuery;
     readonly queryDurationMillis: number;
 }
 export interface ErrorLogEvent {
     readonly level: 'error';
     readonly error: unknown;
 }
+export declare type LogEvent = QueryLogEvent | ErrorLogEvent;
+export declare type LogConfig = ReadonlyArray<LogLevel> | ((event: LogEvent) => void);
+export declare class Log {
+    #private;
+    constructor(config: LogConfig);
+    query(getEvent: () => QueryLogEvent): void;
+    error(getEvent: () => ErrorLogEvent): void;
+}

package/dist/cjs/util/log.js

@@ -2,27 +2,47 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Log = exports.LOG_LEVELS = void 0;
 const object_utils_js_1 = require("./object-utils.js");
-exports.LOG_LEVELS = ['query', 'error'];
+exports.LOG_LEVELS = (0, object_utils_js_1.freeze)(['query', 'error']);
 class Log {
     #levels;
-    constructor(levels) {
-        this.#levels = (0, object_utils_js_1.freeze)({
-            query: levels.includes('query'),
-            error: levels.includes('error'),
-        });
+    #logger;
+    constructor(config) {
+        if ((0, object_utils_js_1.isFunction)(config)) {
+            this.#logger = config;
+            this.#levels = (0, object_utils_js_1.freeze)({
+                query: true,
+                error: true,
+            });
+        }
+        else {
+            this.#levels = (0, object_utils_js_1.freeze)({
+                query: config.includes('query'),
+                error: config.includes('error'),
+            });
+        }
     }
     query(getEvent) {
         if (this.#levels.query) {
-            this.#defaultQuery(getEvent());
+            if (this.#logger) {
+                this.#logger(getEvent());
+            }
+            else {
+                this.#defaultQuery(getEvent());
+            }
         }
     }
     error(getEvent) {
         if (this.#levels.error) {
-            this.#defaultError(getEvent());
+            if (this.#logger) {
+                this.#logger(getEvent());
+            }
+            else {
+                this.#defaultError(getEvent());
+            }
         }
     }
     #defaultQuery(event) {
-        console.log(`kysely:query: ${event.sql}`);
+        console.log(`kysely:query: ${event.query.sql}`);
         console.log(`kysely:query: duration: ${event.queryDurationMillis.toFixed(1)}ms`);
     }
     #defaultError(event) {

package/dist/esm/dialect/mysql/mysql-query-compiler.d.ts

@@ -1,7 +1,5 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class MysqlQueryCompiler extends DefaultQueryCompiler {
-    protected visitReturning(): void;
-    protected getSql(): string;
     protected getCurrentParameterPlaceholder(): string;
     protected getLeftIdentifierWrapper(): string;
     protected getRightIdentifierWrapper(): string;

package/dist/esm/dialect/mysql/mysql-query-compiler.js

@@ -1,11 +1,5 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export class MysqlQueryCompiler extends DefaultQueryCompiler {
-    visitReturning() {
-        // Do nothing.
-    }
-    getSql() {
-        return super.getSql().trimEnd();
-    }
     getCurrentParameterPlaceholder() {
         return '?';
     }

package/dist/esm/dialect/postgres/postgres-query-compiler.d.ts

@@ -1,3 +1,6 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class PostgresQueryCompiler extends DefaultQueryCompiler {
+    protected getCurrentParameterPlaceholder(): string;
+    protected getLeftIdentifierWrapper(): string;
+    protected getRightIdentifierWrapper(): string;
 }

package/dist/esm/dialect/postgres/postgres-query-compiler.js

@@ -1,4 +1,12 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
-// The default query compiler is for PostgreSQL.
 export class PostgresQueryCompiler extends DefaultQueryCompiler {
+    getCurrentParameterPlaceholder() {
+        return '$' + this.numParameters;
+    }
+    getLeftIdentifierWrapper() {
+        return '"';
+    }
+    getRightIdentifierWrapper() {
+        return '"';
+    }
 }

package/dist/esm/dialect/sqlite/sqlite-query-compiler.d.ts

@@ -1,7 +1,7 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export declare class SqliteQueryCompiler extends DefaultQueryCompiler {
-    protected visitReturning(): void;
-    protected getSql(): string;
     protected getCurrentParameterPlaceholder(): string;
+    protected getLeftIdentifierWrapper(): string;
+    protected getRightIdentifierWrapper(): string;
     protected getAutoIncrement(): string;
 }

package/dist/esm/dialect/sqlite/sqlite-query-compiler.js

@@ -1,14 +1,14 @@
 import { DefaultQueryCompiler } from '../../query-compiler/default-query-compiler.js';
 export class SqliteQueryCompiler extends DefaultQueryCompiler {
-    visitReturning() {
-        // Do nothing.
-    }
-    getSql() {
-        return super.getSql().trimEnd();
-    }
     getCurrentParameterPlaceholder() {
         return '?';
     }
+    getLeftIdentifierWrapper() {
+        return '"';
+    }
+    getRightIdentifierWrapper() {
+        return '"';
+    }
     getAutoIncrement() {
         return 'autoincrement';
     }

package/dist/esm/driver/runtime-driver.js

@@ -93,7 +93,7 @@ class RuntimeConnection {
     #logQuery(compiledQuery, startTime) {
         this.#log.query(() => ({
             level: 'query',
-            sql: compiledQuery.sql,
+            query: compiledQuery,
             queryDurationMillis: this.#calculateDurationMillis(startTime),
         }));
     }

package/dist/esm/index.d.ts

@@ -127,6 +127,7 @@ export * from './operation-node/where-node.js';
 export * from './operation-node/with-node.js';
 export * from './introspection/database-introspector.js';
 export * from './util/compilable.js';
+export * from './util/log.js';
 export { AnyColumn, UnknownRow, AnyQueryBuilder } from './util/type-utils.js';
 export { SelectExpression, SelectExpressionOrList, } from './parser/select-parser.js';
 export { ReferenceExpression, ReferenceExpressionOrList, } from './parser/reference-parser.js';

package/dist/esm/index.js

@@ -127,3 +127,4 @@ export * from './operation-node/where-node.js';
 export * from './operation-node/with-node.js';
 export * from './introspection/database-introspector.js';
 export * from './util/compilable.js';
+export * from './util/log.js';

package/dist/esm/kysely.d.ts

@@ -10,7 +10,7 @@ import { DatabaseIntrospector } from './introspection/database-introspector.js';
 import { Driver, IsolationLevel } from './driver/driver.js';
 import { ParseContext } from './parser/parse-context.js';
 import { FunctionBuilder } from './query-builder/function-builder.js';
-import { LogLevel } from './util/log.js';
+import { LogConfig } from './util/log.js';
 /**
  * The main Kysely class.
  *
@@ -235,17 +235,33 @@ export interface KyselyConfig {
     readonly dialect: Dialect;
     readonly plugins?: KyselyPlugin[];
     /**
-     * A list of log levels to log.
+     * A list of log levels to log or a custom logger function.
      *
      * Currently there's only two levels: `query` and `error`.
      * This will be expanded based on user feedback later.
      *
-     * Log levels:
+     * @example
+     * ```ts
+     * const db = new Kysely<Database>({
+     *   dialect: new PostgresDialect(postgresConfig),
+     *   log: ['query', 'error']
+     * })
+     * ```
      *
-     *  - query: Log each query's SQL and duration using console.log
-     *  - error: Log all query errors using console.error
+     * @example
+     * ```ts
+     * const db = new Kysely<Database>({
+     *   dialect: new PostgresDialect(postgresConfig),
+     *   log(event): void {
+     *     if (event.level === 'query') {
+     *       console.log(event.query.sql)
+     *       console.log(event.query.parameters)
+     *     }
+     *   }
+     * })
+     * ```
      */
-    readonly log?: ReadonlyArray<LogLevel>;
+    readonly log?: LogConfig;
 }
 export declare class ConnectionBuilder<DB> {
     #private;

package/dist/esm/util/log.d.ts

@@ -1,19 +1,21 @@
+import { CompiledQuery } from '../index.js';
 import { ArrayItemType } from './type-utils.js';
 export declare const LOG_LEVELS: readonly ["query", "error"];
 export declare type LogLevel = ArrayItemType<typeof LOG_LEVELS>;
-export declare class Log {
-    #private;
-    constructor(levels: ReadonlyArray<LogLevel>);
-    query(getEvent: () => QueryLogEvent): void;
-    error(getEvent: () => ErrorLogEvent): void;
-}
-export declare type LogEvent = QueryLogEvent | ErrorLogEvent;
 export interface QueryLogEvent {
     readonly level: 'query';
-    readonly sql: string;
+    readonly query: CompiledQuery;
     readonly queryDurationMillis: number;
 }
 export interface ErrorLogEvent {
     readonly level: 'error';
     readonly error: unknown;
 }
+export declare type LogEvent = QueryLogEvent | ErrorLogEvent;
+export declare type LogConfig = ReadonlyArray<LogLevel> | ((event: LogEvent) => void);
+export declare class Log {
+    #private;
+    constructor(config: LogConfig);
+    query(getEvent: () => QueryLogEvent): void;
+    error(getEvent: () => ErrorLogEvent): void;
+}

package/dist/esm/util/log.js

@@ -1,25 +1,45 @@
-import { freeze } from './object-utils.js';
-export const LOG_LEVELS = ['query', 'error'];
+import { freeze, isFunction } from './object-utils.js';
+export const LOG_LEVELS = freeze(['query', 'error']);
 export class Log {
     #levels;
-    constructor(levels) {
-        this.#levels = freeze({
-            query: levels.includes('query'),
-            error: levels.includes('error'),
-        });
+    #logger;
+    constructor(config) {
+        if (isFunction(config)) {
+            this.#logger = config;
+            this.#levels = freeze({
+                query: true,
+                error: true,
+            });
+        }
+        else {
+            this.#levels = freeze({
+                query: config.includes('query'),
+                error: config.includes('error'),
+            });
+        }
     }
     query(getEvent) {
         if (this.#levels.query) {
-            this.#defaultQuery(getEvent());
+            if (this.#logger) {
+                this.#logger(getEvent());
+            }
+            else {
+                this.#defaultQuery(getEvent());
+            }
         }
     }
     error(getEvent) {
         if (this.#levels.error) {
-            this.#defaultError(getEvent());
+            if (this.#logger) {
+                this.#logger(getEvent());
+            }
+            else {
+                this.#defaultError(getEvent());
+            }
         }
     }
     #defaultQuery(event) {
-        console.log(`kysely:query: ${event.sql}`);
+        console.log(`kysely:query: ${event.query.sql}`);
         console.log(`kysely:query: duration: ${event.queryDurationMillis.toFixed(1)}ms`);
     }
     #defaultError(event) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",