Merge pull request #180 from drizzle-team/orm-143-default-logger

Add logger shorthand and logger docs

Author: dankochetov

changelogs/drizzle-orm/0.20.1.md

@@ -0,0 +1 @@
+- 🎉 Added `{ logger: true }` shorthand to `drizzle()` to enable query logging. See [logging docs](/drizzle-orm/src/pg-core/README.md#logging) for detailed logging configuration.

drizzle-orm/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "drizzle-orm",
-	"version": "0.20.0",
+	"version": "0.20.1",
 	"description": "Drizzle ORM package for SQL databases",
 	"scripts": {
 		"build": "tsc && resolve-tspaths && cp ../README.md package.json dist/",

drizzle-orm/src/aws-data-api/pg/driver.ts

@@ -1,4 +1,4 @@
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { PgDatabase } from '~/pg-core/db';
 import { PgDialect } from '~/pg-core/dialect';
 import { AwsDataApiClient, AwsDataApiPgQueryResultHKT, AwsDataApiSession } from './session';
@@ -24,7 +24,7 @@ export class AwsDataApiDriver {
 }
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 	database: string;
 	resourceArn: string;
 	secretArn: string;
@@ -44,7 +44,13 @@ export class AwsPgDialect extends PgDialect {
 
 export function drizzle(client: AwsDataApiClient, config: DrizzleConfig): AwsDataApiPgDatabase {
 	const dialect = new AwsPgDialect();
-	const driver = new AwsDataApiDriver(client, dialect, config);
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const driver = new AwsDataApiDriver(client, dialect, { ...config, logger });
 	const session = driver.createSession();
 	return new PgDatabase(dialect, session);
 }

drizzle-orm/src/better-sqlite3/driver.ts

@@ -1,17 +1,23 @@
 import { Database, RunResult } from 'better-sqlite3';
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { BaseSQLiteDatabase } from '~/sqlite-core/db';
 import { SQLiteSyncDialect } from '~/sqlite-core/dialect';
 import { BetterSQLiteSession } from './session';
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 }
 
 export type BetterSQLite3Database = BaseSQLiteDatabase<'sync', RunResult>;
 
 export function drizzle(client: Database, config: DrizzleConfig = {}): BetterSQLite3Database {
 	const dialect = new SQLiteSyncDialect();
-	const session = new BetterSQLiteSession(client, dialect, { logger: config.logger });
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const session = new BetterSQLiteSession(client, dialect, { logger });
 	return new BaseSQLiteDatabase(dialect, session);
 }

drizzle-orm/src/bun-sqlite/driver.ts

@@ -1,19 +1,25 @@
 /// <reference types="bun-types" />
 
 import { Database } from 'bun:sqlite';
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { BaseSQLiteDatabase } from '~/sqlite-core/db';
 import { SQLiteSyncDialect } from '~/sqlite-core/dialect';
 import { SQLiteBunSession } from './session';
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 }
 
 export type BunSQLiteDatabase = BaseSQLiteDatabase<'sync', void>;
 
 export function drizzle(client: Database, config: DrizzleConfig = {}): BunSQLiteDatabase {
 	const dialect = new SQLiteSyncDialect();
-	const session = new SQLiteBunSession(client, dialect, { logger: config.logger });
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const session = new SQLiteBunSession(client, dialect, { logger });
 	return new BaseSQLiteDatabase(dialect, session);
 }

drizzle-orm/src/d1/driver.ts

@@ -1,18 +1,24 @@
 /// <reference types="@cloudflare/workers-types" />
 
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { BaseSQLiteDatabase } from '~/sqlite-core/db';
 import { SQLiteAsyncDialect } from '~/sqlite-core/dialect';
 import { SQLiteD1Session } from './session';
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 }
 
 export type DrizzleD1Database = BaseSQLiteDatabase<'async', D1Result>;
 
 export function drizzle(client: D1Database, config: DrizzleConfig = {}): DrizzleD1Database {
 	const dialect = new SQLiteAsyncDialect();
-	const session = new SQLiteD1Session(client, dialect, { logger: config.logger });
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const session = new SQLiteD1Session(client, dialect, { logger });
 	return new BaseSQLiteDatabase(dialect, session);
 }

drizzle-orm/src/mysql-core/README.md

@@ -725,3 +725,45 @@ const db = drizzle(poolConnection);
 // this will automatically run needed migrations on the database
 await migrate(db, { migrationsFolder: './drizzle' });
 ```
+
+## Logging
+
+To enable default query logging, just pass `{ logger: true }` to the `drizzle` function:
+
+```typescript
+import { drizzle } from 'drizzle-orm/mysql2';
+
+const db = drizzle(pool, { logger: true });
+```
+
+You can change the logs destination by creating a `DefaultLogger` instance and providing a custom `writer` to it:
+
+```typescript
+import { DefaultLogger, LogWriter } from 'drizzle-orm/logger';
+import { drizzle } from 'drizzle-orm/mysql2';
+
+class MyLogWriter implements LogWriter {
+  write(message: string) {
+    // Write to file, console, etc.
+  }
+}
+
+const logger = new DefaultLogger({ writer: new MyLogWriter() });
+
+const db = drizzle(pool, { logger });
+```
+
+You can also create a custom logger:
+
+```typescript
+import { Logger } from 'drizzle-orm/logger';
+import { drizzle } from 'drizzle-orm/mysql2';
+
+class MyLogger implements Logger {
+  logQuery(query: string, params: unknown[]): void {
+    console.log({ query, params });
+  }
+}
+
+const db = drizzle(pool, { logger: new MyLogger() });
+```

drizzle-orm/src/mysql2/driver.ts

@@ -1,4 +1,4 @@
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { MySqlDialect } from '~/mysql-core/dialect';
 import { MySqlDatabase } from '.';
 import { MySql2Client, MySql2QueryResultHKT, MySql2Session } from './session';
@@ -21,7 +21,7 @@ export class MySql2Driver {
 }
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 }
 
 export { MySqlDatabase } from '~/mysql-core/db';
@@ -33,7 +33,13 @@ export function drizzle(
 	config: DrizzleConfig = {},
 ): MySql2Database {
 	const dialect = new MySqlDialect();
-	const driver = new MySql2Driver(client, dialect, { logger: config.logger });
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const driver = new MySql2Driver(client, dialect, { logger });
 	const session = driver.createSession();
-	return new MySqlDatabase(dialect, session)
+	return new MySqlDatabase(dialect, session);
 }

drizzle-orm/src/neon-serverless/driver.ts

@@ -1,5 +1,5 @@
 import { types } from '@neondatabase/serverless';
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { PgDatabase } from '~/pg-core/db';
 import { PgDialect } from '~/pg-core/dialect';
 import { NeonClient, NeonQueryResultHKT, NeonSession } from './session';
@@ -29,14 +29,20 @@ export class NeonDriver {
 }
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 }
 
 export type NeonDatabase = PgDatabase<NeonQueryResultHKT, NeonSession>;
 
 export function drizzle(client: NeonClient, config: DrizzleConfig = {}): NeonDatabase {
 	const dialect = new PgDialect();
-	const driver = new NeonDriver(client, dialect, { logger: config.logger });
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const driver = new NeonDriver(client, dialect, { logger });
 	const session = driver.createSession();
 	return new PgDatabase(dialect, session);
 }

drizzle-orm/src/node-postgres/driver.ts

@@ -1,5 +1,5 @@
 import { types } from 'pg';
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { PgDatabase } from '~/pg-core/db';
 import { PgDialect } from '~/pg-core/dialect';
 import { NodePgClient, NodePgQueryResultHKT, NodePgSession } from './session';
@@ -29,14 +29,20 @@ export class NodePgDriver {
 }
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 }
 
 export type NodePgDatabase = PgDatabase<NodePgQueryResultHKT, NodePgSession>;
 
 export function drizzle(client: NodePgClient, config: DrizzleConfig = {}): NodePgDatabase {
 	const dialect = new PgDialect();
-	const driver = new NodePgDriver(client, dialect, { logger: config.logger });
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const driver = new NodePgDriver(client, dialect, { logger });
 	const session = driver.createSession();
 	return new PgDatabase(dialect, session);
 }

drizzle-orm/src/pg-core/README.md

@@ -775,3 +775,45 @@ const db = drizzle(pool);
 // this will automatically run needed migrations on the database
 await migrate(db, { migrationsFolder: './drizzle' });
 ```
+
+## Logging
+
+To enable default query logging, just pass `{ logger: true }` to the `drizzle` function:
+
+```typescript
+import { drizzle } from 'drizzle-orm/node-postgres';
+
+const db = drizzle(pool, { logger: true });
+```
+
+You can change the logs destination by creating a `DefaultLogger` instance and providing a custom `writer` to it:
+
+```typescript
+import { DefaultLogger, LogWriter } from 'drizzle-orm/logger';
+import { drizzle } from 'drizzle-orm/node-postgres';
+
+class MyLogWriter implements LogWriter {
+  write(message: string) {
+    // Write to file, console, etc.
+  }
+}
+
+const logger = new DefaultLogger({ writer: new MyLogWriter() });
+
+const db = drizzle(pool, { logger });
+```
+
+You can also create a custom logger:
+
+```typescript
+import { Logger } from 'drizzle-orm/logger';
+import { drizzle } from 'drizzle-orm/node-postgres';
+
+class MyLogger implements Logger {
+  logQuery(query: string, params: unknown[]): void {
+    console.log({ query, params });
+  }
+}
+
+const db = drizzle(pool, { logger: new MyLogger() });
+```

drizzle-orm/src/planetscale-serverless/driver.ts

@@ -1,5 +1,5 @@
 import { Connection } from '@planetscale/database';
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { MySqlDatabase } from '~/mysql-core/db';
 import { MySqlDialect } from '~/mysql-core/dialect';
 import { PlanetscaleQueryResultHKT, PlanetscaleSession } from './session';
@@ -22,7 +22,7 @@ export class PlanetscaleDriver {
 }
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 }
 
 export type PlanetScaleDatabase = MySqlDatabase<PlanetscaleQueryResultHKT, PlanetscaleSession>;
@@ -32,7 +32,13 @@ export function drizzle(
 	config: DrizzleConfig = {},
 ): PlanetScaleDatabase {
 	const dialect = new MySqlDialect();
-	const driver = new PlanetscaleDriver(client, dialect, { logger: config.logger });
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const driver = new PlanetscaleDriver(client, dialect, { logger });
 	const session = driver.createSession();
 	return new MySqlDatabase(dialect, session);
 }

drizzle-orm/src/postgres-js/driver.ts

@@ -1,17 +1,23 @@
 import { Sql } from 'postgres';
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { PgDatabase } from '~/pg-core/db';
 import { PgDialect } from '~/pg-core/dialect';
 import { PostgresJsQueryResultHKT, PostgresJsSession } from './session';
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 }
 
 export type PostgresJsDatabase = PgDatabase<PostgresJsQueryResultHKT, PostgresJsSession>;
 
 export function drizzle(client: Sql, config: DrizzleConfig = {}): PostgresJsDatabase {
 	const dialect = new PgDialect();
-	const session = new PostgresJsSession(client, dialect, { logger: config.logger });
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const session = new PostgresJsSession(client, dialect, { logger });
 	return new PgDatabase(dialect, session);
 }

drizzle-orm/src/sql-js/driver.ts

@@ -1,17 +1,23 @@
 import { Database } from 'sql.js';
-import { Logger } from '~/logger';
+import { DefaultLogger, Logger } from '~/logger';
 import { BaseSQLiteDatabase } from '~/sqlite-core/db';
 import { SQLiteSyncDialect } from '~/sqlite-core/dialect';
 import { SQLJsSession } from './session';
 
 export interface DrizzleConfig {
-	logger?: Logger;
+	logger?: boolean | Logger;
 }
 
 export type SQLJsDatabase = BaseSQLiteDatabase<'sync', void>;
 
 export function drizzle(client: Database, config: DrizzleConfig = {}): SQLJsDatabase {
 	const dialect = new SQLiteSyncDialect();
-	const session = new SQLJsSession(client, dialect, { logger: config.logger });
+	let logger;
+	if (config.logger === true) {
+		logger = new DefaultLogger();
+	} else if (config.logger !== false) {
+		logger = config.logger;
+	}
+	const session = new SQLJsSession(client, dialect, { logger });
 	return new BaseSQLiteDatabase(dialect, session);
 }