beta.10 (#5230)

* Tagged effect errors for effect drivers, fixed kit `bun-sql` `sqlite`, `mysql` driver variants using `pg` functions

* Typo fix

* Extended type tests for columns with `strictNullChecks: false`

* Fixed broken type inferrence of `PgColumn`s with `"strictNullChecks": false` typescript option caused by updates in `1.0.0-beta.9`

Author: Sukairo-02

changelogs/drizzle-kit/1.0.0-beta.10.md

@@ -0,0 +1,3 @@
+## Bug fixes
+
+- Fixed usage of `pg` dialect functions while using `bun-sql` with `sqlite`, `mysql` dialects  

changelogs/drizzle-orm/1.0.0-beta.10.md

@@ -0,0 +1,2 @@
+- Tagged `DrizzleError`, `DrizzleQueryError`, `TransactionRollbackError` error variants for `Effect` drivers for usage with `Effect.catchTag('DrizzleQueryError', (e: TaggedDrizzleQueryError) => { ... })`  
+- Fixed broken type inferrence of `PgColumn`s with `"strictNullChecks": false` typescript option caused by updates in `1.0.0-beta.9`  

drizzle-arktype/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "drizzle-arktype",
-	"version": "1.0.0-beta.9",
+	"version": "1.0.0-beta.10",
 	"description": "Generate arktype schemas from Drizzle ORM schemas",
 	"type": "module",
 	"scripts": {

drizzle-kit/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "drizzle-kit",
-	"version": "1.0.0-beta.9",
+	"version": "1.0.0-beta.10",
 	"homepage": "https://orm.drizzle.team",
 	"keywords": [
 		"drizzle",

drizzle-kit/src/cli/connections.ts

@@ -735,8 +735,8 @@ export const preparePostgresDB = async (
 	if (await checkPackage('bun')) {
 		console.log(withStyle.info(`Using 'bun' driver for database querying`));
 		const { SQL } = await import('bun');
-		const { drizzle } = await import('drizzle-orm/bun-sql');
-		const { migrate } = await import('drizzle-orm/bun-sql/migrator');
+		const { drizzle } = await import('drizzle-orm/bun-sql/postgres');
+		const { migrate } = await import('drizzle-orm/bun-sql/postgres/migrator');
 
 		const ssl = 'ssl' in credentials
 			? credentials.ssl === 'prefer'
@@ -1546,8 +1546,8 @@ export const connectToMySQL = async (
 	if (await checkPackage('bun')) {
 		console.log(withStyle.info(`Using 'bun' driver for database querying`));
 		const { SQL } = await import('bun');
-		const { drizzle } = await import('drizzle-orm/bun-sql');
-		const { migrate } = await import('drizzle-orm/bun-sql/migrator');
+		const { drizzle } = await import('drizzle-orm/bun-sql/mysql');
+		const { migrate } = await import('drizzle-orm/bun-sql/mysql/migrator');
 
 		const ssl = result.credentials && 'ssl' in result.credentials
 			? result.credentials.ssl === 'prefer'
@@ -2174,8 +2174,8 @@ export const connectToSQLite = async (
 	if (await checkPackage('bun')) {
 		console.log(withStyle.info(`Using 'bun' driver for database querying`));
 		const { SQL } = await import('bun');
-		const { drizzle } = await import('drizzle-orm/bun-sql');
-		const { migrate } = await import('drizzle-orm/bun-sql/migrator');
+		const { drizzle } = await import('drizzle-orm/bun-sql/sqlite');
+		const { migrate } = await import('drizzle-orm/bun-sql/sqlite/migrator');
 
 		const client = new SQL({
 			adapter: 'sqlite',

drizzle-orm/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "drizzle-orm",
-	"version": "1.0.0-beta.9",
+	"version": "1.0.0-beta.10",
 	"description": "Drizzle ORM package for SQL databases",
 	"type": "module",
 	"scripts": {

drizzle-orm/src/effect-core/errors.ts

@@ -0,0 +1,41 @@
+import { TaggedError } from 'effect/Data';
+import { entityKind } from '~/entity.ts';
+
+export class TaggedDrizzleError extends TaggedError('DrizzleError') {
+	static readonly [entityKind]: string = 'TaggedDrizzleError';
+
+	override readonly message: string;
+	override readonly cause?: unknown;
+
+	constructor({ message, cause }: { message?: string; cause?: unknown }) {
+		super();
+		this.name = 'TaggedDrizzleError';
+		this.message = message ?? '';
+		this.cause = cause;
+	}
+}
+
+export class TaggedDrizzleQueryError extends TaggedError('DrizzleQueryError') {
+	static readonly [entityKind]: string = 'TaggedDrizzleQueryError';
+
+	override readonly message: string;
+
+	constructor(
+		public readonly query: string,
+		public readonly params: any[],
+		public override cause?: Error,
+	) {
+		super();
+		this.message = `Failed query: ${query}\nparams: ${params}`;
+		Error.captureStackTrace(this, TaggedDrizzleQueryError);
+
+		// ES2022+: preserves original error on `.cause`
+		if (cause) (this as any).cause = cause;
+	}
+}
+
+export class TaggedTransactionRollbackError extends TaggedError('TransactionRollbackError') {
+	static readonly [entityKind]: string = 'TaggedTransactionRollbackError';
+
+	override readonly message = 'Rollback';
+}

drizzle-orm/src/effect-core/index.ts

@@ -0,0 +1,2 @@
+export * from './errors.ts';
+export * from './query-effect.ts';

drizzle-orm/src/effect-core/query-effect.ts

@@ -1,18 +1,18 @@
 import { Effect } from 'effect';
 import type { Pipeable } from 'effect/Pipeable';
 import { entityKind } from '~/entity.ts';
-import type { DrizzleQueryError } from '~/errors.ts';
 import { applyMixins } from '~/utils.ts';
+import type { TaggedDrizzleQueryError } from './errors.ts';
 
-export interface QueryEffect<Succes = never, Failure = DrizzleQueryError, Context = never>
-	extends Effect.Effect<Succes, Failure, Context>
+export interface QueryEffect<Success = never, Failure = TaggedDrizzleQueryError, Context = never>
+	extends Effect.Effect<Success, Failure, Context>
 {
 }
 
-export abstract class QueryEffect<Succes = never, Failure = DrizzleQueryError, Context = never> {
+export abstract class QueryEffect<Success = never, Failure = TaggedDrizzleQueryError, Context = never> {
 	static readonly [entityKind]: string = 'EffectWrapper';
 
-	protected _effect!: Effect.Effect<Succes, Failure, Context>;
+	protected _effect!: Effect.Effect<Success, Failure, Context>;
 	protected get effect() {
 		this._effect = Effect.suspend(() => this.execute());
 
@@ -40,7 +40,7 @@ export abstract class QueryEffect<Succes = never, Failure = DrizzleQueryError, C
 		return this._pipe;
 	}
 
-	abstract execute(...args: any[]): Effect.Effect<Succes, Failure, Context>;
+	abstract execute(...args: any[]): Effect.Effect<Success, Failure, Context>;
 
 	get [Effect.EffectTypeId]() {
 		return this.effect[Effect.EffectTypeId];

drizzle-orm/src/effect-postgres/session.ts

@@ -3,8 +3,8 @@ import { Effect } from 'effect';
 import type * as V1 from '~/_relations.ts';
 import type { EffectCache } from '~/cache/core/cache-effect.ts';
 import type { WithCacheConfig } from '~/cache/core/types.ts';
+import { TaggedDrizzleQueryError, type TaggedTransactionRollbackError } from '~/effect-core/errors.ts';
 import { entityKind } from '~/entity.ts';
-import { DrizzleQueryError, type TransactionRollbackError } from '~/errors.ts';
 import { type Logger, NoopLogger } from '~/logger.ts';
 import type { PgDialect } from '~/pg-core/dialect.ts';
 import { PgEffectPreparedQuery, PgEffectSession, PgEffectTransaction } from '~/pg-core/effect/session.ts';
@@ -46,7 +46,7 @@ export class EffectPgPreparedQuery<T extends PreparedQueryConfig, TIsRqbV2 exten
 		super({ sql: queryString, params }, cache, queryMetadata, cacheConfig);
 	}
 
-	execute(placeholderValues?: Record<string, unknown>): Effect.Effect<T['execute'], DrizzleQueryError> {
+	execute(placeholderValues?: Record<string, unknown>): Effect.Effect<T['execute'], TaggedDrizzleQueryError> {
 		if (this.isRqbV2Query) return this.executeRqbV2(placeholderValues);
 
 		const { query, logger, customResultMapper, fields, joinsNotNullableMap, client } = this;
@@ -82,7 +82,7 @@ export class EffectPgPreparedQuery<T extends PreparedQueryConfig, TIsRqbV2 exten
 
 	private executeRqbV2(
 		placeholderValues?: Record<string, unknown>,
-	): Effect.Effect<T['execute'], DrizzleQueryError> {
+	): Effect.Effect<T['execute'], TaggedDrizzleQueryError> {
 		const { query, logger, customResultMapper, client } = this;
 		const params = fillPlaceholders(query.params, placeholderValues ?? {});
 
@@ -97,12 +97,12 @@ export class EffectPgPreparedQuery<T extends PreparedQueryConfig, TIsRqbV2 exten
 				),
 			).pipe(Effect.catchAll((e) => {
 				// eslint-disable-next-line @drizzle-internal/no-instanceof
-				return Effect.fail(new DrizzleQueryError(query.sql, params, e instanceof Error ? e : undefined));
+				return Effect.fail(new TaggedDrizzleQueryError(query.sql, params, e instanceof Error ? e : undefined));
 			}))
 		);
 	}
 
-	override all(placeholderValues?: Record<string, unknown>): Effect.Effect<T['all'], DrizzleQueryError, never> {
+	override all(placeholderValues?: Record<string, unknown>): Effect.Effect<T['all'], TaggedDrizzleQueryError, never> {
 		const { query, logger, client } = this;
 		const params = fillPlaceholders(query.params, placeholderValues ?? {});
 
@@ -194,7 +194,7 @@ export class EffectPgSession<
 		);
 	}
 
-	override execute<T>(query: SQL): Effect.Effect<T, DrizzleQueryError> {
+	override execute<T>(query: SQL): Effect.Effect<T, TaggedDrizzleQueryError> {
 		return this.prepareQuery<PreparedQueryConfig & { execute: T }>(
 			this.dialect.sqlToQuery(query),
 			undefined,
@@ -203,7 +203,7 @@ export class EffectPgSession<
 		).execute();
 	}
 
-	override all<T>(query: SQL): Effect.Effect<T, DrizzleQueryError> {
+	override all<T>(query: SQL): Effect.Effect<T, TaggedDrizzleQueryError> {
 		return this.prepareQuery<PreparedQueryConfig & { all: T }>(
 			this.dialect.sqlToQuery(query),
 			undefined,
@@ -224,8 +224,8 @@ export class EffectPgSession<
 				TRelations,
 				TSchema
 			>,
-		) => Effect.Effect<T, DrizzleQueryError | TransactionRollbackError, never>,
-	): Effect.Effect<T, DrizzleQueryError | TransactionRollbackError, never> {
+		) => Effect.Effect<T, TaggedDrizzleQueryError | TaggedTransactionRollbackError, never>,
+	): Effect.Effect<T, TaggedDrizzleQueryError | TaggedTransactionRollbackError, never> {
 		const { dialect, relations, schema } = this;
 		const session = this;
 
@@ -238,7 +238,7 @@ export class EffectPgSession<
 			);
 
 			return yield* transaction(tx);
-		}));
+		})) as Effect.Effect<T, TaggedDrizzleQueryError | TaggedTransactionRollbackError, never>;
 	}
 }
 
@@ -253,8 +253,8 @@ export class EffectPgTransaction<
 	override transaction<T>(
 		transaction: (
 			tx: PgEffectTransaction<TQueryResult, TFullSchema, TRelations, TSchema>,
-		) => Effect.Effect<T, DrizzleQueryError | TransactionRollbackError, never>,
-	): Effect.Effect<T, DrizzleQueryError | TransactionRollbackError, never> {
+		) => Effect.Effect<T, TaggedDrizzleQueryError | TaggedTransactionRollbackError, never>,
+	): Effect.Effect<T, TaggedDrizzleQueryError | TaggedTransactionRollbackError, never> {
 		return this.session.transaction(transaction);
 	}
 }