Merge pull request #1471 from Angelelz/feat-generated-columns

Feat: Drizzle-ORM support for Generated columns
drizzle-team · Jun 27, 2024 · 3245641 · 3245641
2 parents 4ecfe1f + 6b0a11e
commit 3245641
Show file tree

Hide file tree

Showing 97 changed files with 1,647 additions and 432 deletions.
diff --git a/changelogs/drizzle-orm/0.30.5.md b/changelogs/drizzle-orm/0.30.5.md
@@ -22,4 +22,4 @@ const usersOnUpdate = pgTable('users_on_update', {
 
 - [BUG]: insertions on columns with the smallserial datatype are not optional - #1848
 
-Thanks @Angelelz and @gabrielDonnantuoni!
+Thanks @Angelelz and @gabrielDonnantuoni!
diff --git a/changelogs/drizzle-orm/0.30.7-preview.md b/changelogs/drizzle-orm/0.30.7-preview.md
@@ -0,0 +1,10 @@
+- 🎉 Added custom schema support to enums in Postgres:
+  ```ts
+  import { pgSchema } from 'drizzle-orm/pg-core';
+
+  const mySchema = pgSchema('mySchema');
+  const colors = mySchema.enum('colors', ['red', 'green', 'blue']);
+  ```
+
+- 🐛 Split `where` clause in Postgres `.onConflictDoUpdate` method into `setWhere` and `targetWhere` clauses, to support both `where` cases in `on conflict ...` clause (#1628, #1302)
+- 🐛 Fix query generation for `where` clause in Postgres `.onConflictDoNothing` method, as it was placed in a wrong spot (#1628)
diff --git a/drizzle-orm/package.json b/drizzle-orm/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "drizzle-orm",
-	"version": "0.31.2",
+	"version": "0.32.0",
 	"description": "Drizzle ORM package for SQL databases",
 	"type": "module",
 	"scripts": {

diff --git a/drizzle-orm/src/column-builder.ts b/drizzle-orm/src/column-builder.ts
@@ -1,7 +1,7 @@
 import { entityKind } from '~/entity.ts';
 import type { Column } from './column.ts';
 import type { MySqlColumn } from './mysql-core/index.ts';
-import type { ExtraConfigColumn, PgColumn } from './pg-core/index.ts';
+import type { ExtraConfigColumn, PgColumn, PgSequenceOptions } from './pg-core/index.ts';
 import type { SQL } from './sql/sql.ts';
 import type { SQLiteColumn } from './sqlite-core/index.ts';
 import type { Simplify } from './utils.ts';
@@ -19,30 +19,49 @@ export type ColumnDataType =
 
 export type Dialect = 'pg' | 'mysql' | 'sqlite' | 'common';
 
+export type GeneratedStorageMode = 'virtual' | 'stored';
+
+export type GeneratedType = 'always' | 'byDefault';
+
+export type GeneratedColumnConfig<TDataType> = {
+	as: TDataType | SQL | (() => SQL);
+	type?: GeneratedType;
+	mode?: GeneratedStorageMode;
+};
+
+export type GeneratedIdentityConfig = {
+	sequenceName?: string;
+	sequenceOptions?: PgSequenceOptions;
+	type: 'always' | 'byDefault';
+};
+
 export interface ColumnBuilderBaseConfig<TDataType extends ColumnDataType, TColumnType extends string> {
 	name: string;
 	dataType: TDataType;
 	columnType: TColumnType;
 	data: unknown;
 	driverParam: unknown;
 	enumValues: string[] | undefined;
+	generated: GeneratedColumnConfig<unknown> | undefined;
 }
 
 export type MakeColumnConfig<
 	T extends ColumnBuilderBaseConfig<ColumnDataType, string>,
 	TTableName extends string,
+	TData = T extends { $type: infer U } ? U : T['data'],
 > = {
 	name: T['name'];
 	tableName: TTableName;
 	dataType: T['dataType'];
 	columnType: T['columnType'];
-	data: T extends { $type: infer U } ? U : T['data'];
+	data: TData;
 	driverParam: T['driverParam'];
 	notNull: T extends { notNull: true } ? true : false;
 	hasDefault: T extends { hasDefault: true } ? true : false;
 	enumValues: T['enumValues'];
 	baseColumn: T extends { baseBuilder: infer U extends ColumnBuilderBase } ? BuildColumn<TTableName, U, 'common'>
 		: never;
+	generated: T['generated'] extends object ? T['generated'] : undefined;
 } & {};
 
 export type ColumnBuilderTypeConfig<
@@ -60,6 +79,7 @@ export type ColumnBuilderTypeConfig<
 		notNull: T extends { notNull: infer U } ? U : boolean;
 		hasDefault: T extends { hasDefault: infer U } ? U : boolean;
 		enumValues: T['enumValues'];
+		generated: GeneratedColumnConfig<T['data']> | undefined;
 	}
 	& TTypeConfig
 >;
@@ -77,6 +97,8 @@ export type ColumnBuilderRuntimeConfig<TData, TRuntimeConfig extends object = ob
 	uniqueType: string | undefined;
 	dataType: string;
 	columnType: string;
+	generated: GeneratedColumnConfig<TData> | undefined;
+	generatedIdentity: GeneratedIdentityConfig | undefined;
 } & TRuntimeConfig;
 
 export interface ColumnBuilderExtraConfig {
@@ -101,6 +123,24 @@ export type $Type<T extends ColumnBuilderBase, TType> = T & {
 	};
 };
 
+export type HasGenerated<T extends ColumnBuilderBase, TGenerated extends {} = {}> = T & {
+	_: {
+		hasDefault: true;
+		generated: TGenerated;
+	};
+};
+
+export type IsIdentityByDefault<
+	T extends ColumnBuilderBase,
+	TType extends 'always' | 'byDefault',
+> = T & {
+	_: {
+		notNull: true;
+		hasDefault: true;
+		generated: { as: any; type: TType };
+	};
+};
+
 export interface ColumnBuilderBase<
 	T extends ColumnBuilderBaseConfig<ColumnDataType, string> = ColumnBuilderBaseConfig<ColumnDataType, string>,
 	TTypeConfig extends object = object,
@@ -133,6 +173,7 @@ export abstract class ColumnBuilder<
 			uniqueType: undefined,
 			dataType,
 			columnType,
+			generated: undefined,
 		} as ColumnBuilderRuntimeConfig<T['data'], TRuntimeConfig>;
 	}
 
@@ -223,6 +264,11 @@ export abstract class ColumnBuilder<
 		this.config.notNull = true;
 		return this as TExtraConfig['primaryKeyHasDefault'] extends true ? HasDefault<NotNull<this>> : NotNull<this>;
 	}
+
+	abstract generatedAlwaysAs(
+		as: SQL | T['data'] | (() => SQL),
+		config?: Partial<GeneratedColumnConfig<unknown>>,
+	): HasGenerated<this>;
 }
 
 export type BuildColumn<

diff --git a/drizzle-orm/src/column.ts b/drizzle-orm/src/column.ts
@@ -1,4 +1,10 @@
-import type { ColumnBuilderBaseConfig, ColumnBuilderRuntimeConfig, ColumnDataType } from './column-builder.ts';
+import type {
+	ColumnBuilderBaseConfig,
+	ColumnBuilderRuntimeConfig,
+	ColumnDataType,
+	GeneratedColumnConfig,
+	GeneratedIdentityConfig,
+} from './column-builder.ts';
 import { entityKind } from './entity.ts';
 import type { DriverValueMapper, SQL, SQLWrapper } from './sql/sql.ts';
 import type { Table } from './table.ts';
@@ -25,6 +31,7 @@ export type ColumnTypeConfig<T extends ColumnBaseConfig<ColumnDataType, string>,
 	hasDefault: T['hasDefault'];
 	enumValues: T['enumValues'];
 	baseColumn: T extends { baseColumn: infer U } ? U : unknown;
+	generated: GeneratedColumnConfig<T['data']> | undefined;
 } & TTypeConfig;
 
 export type ColumnRuntimeConfig<TData, TRuntimeConfig extends object> = ColumnBuilderRuntimeConfig<
@@ -68,6 +75,8 @@ export abstract class Column<
 	readonly dataType: T['dataType'];
 	readonly columnType: T['columnType'];
 	readonly enumValues: T['enumValues'] = undefined;
+	readonly generated: GeneratedColumnConfig<T['data']> | undefined = undefined;
+	readonly generatedIdentity: GeneratedIdentityConfig | undefined = undefined;
 
 	protected config: ColumnRuntimeConfig<T['data'], TRuntimeConfig>;
 
@@ -88,6 +97,8 @@ export abstract class Column<
 		this.uniqueType = config.uniqueType;
 		this.dataType = config.dataType as T['dataType'];
 		this.columnType = config.columnType;
+		this.generated = config.generated;
+		this.generatedIdentity = config.generatedIdentity;
 	}
 
 	abstract getSQLType(): string;
@@ -99,6 +110,11 @@ export abstract class Column<
 	mapToDriverValue(value: unknown): unknown {
 		return value;
 	}
+
+	// ** @internal */
+	shouldDisableInsert(): boolean {
+		return this.config.generatedIdentity !== undefined && this.config.generatedIdentity.type !== 'byDefault';
+	}
 }
 
 export type UpdateColConfig<

diff --git a/drizzle-orm/src/mysql-core/columns/bigint.ts b/drizzle-orm/src/mysql-core/columns/bigint.ts
@@ -11,6 +11,7 @@ export type MySqlBigInt53BuilderInitial<TName extends string> = MySqlBigInt53Bui
 	data: number;
 	driverParam: number | string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlBigInt53Builder<T extends ColumnBuilderBaseConfig<'number', 'MySqlBigInt53'>>
@@ -58,6 +59,7 @@ export type MySqlBigInt64BuilderInitial<TName extends string> = MySqlBigInt64Bui
 	data: bigint;
 	driverParam: string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlBigInt64Builder<T extends ColumnBuilderBaseConfig<'bigint', 'MySqlBigInt64'>>

diff --git a/drizzle-orm/src/mysql-core/columns/binary.ts b/drizzle-orm/src/mysql-core/columns/binary.ts
@@ -11,6 +11,7 @@ export type MySqlBinaryBuilderInitial<TName extends string> = MySqlBinaryBuilder
 	data: string;
 	driverParam: string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlBinaryBuilder<T extends ColumnBuilderBaseConfig<'string', 'MySqlBinary'>> extends MySqlColumnBuilder<

diff --git a/drizzle-orm/src/mysql-core/columns/boolean.ts b/drizzle-orm/src/mysql-core/columns/boolean.ts
@@ -11,6 +11,7 @@ export type MySqlBooleanBuilderInitial<TName extends string> = MySqlBooleanBuild
 	data: boolean;
 	driverParam: number | boolean;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlBooleanBuilder<T extends ColumnBuilderBaseConfig<'boolean', 'MySqlBoolean'>>

diff --git a/drizzle-orm/src/mysql-core/columns/char.ts b/drizzle-orm/src/mysql-core/columns/char.ts
@@ -12,6 +12,7 @@ export type MySqlCharBuilderInitial<TName extends string, TEnum extends [string,
 	data: TEnum[number];
 	driverParam: number | string;
 	enumValues: TEnum;
+	generated: undefined;
 }>;
 
 export class MySqlCharBuilder<T extends ColumnBuilderBaseConfig<'string', 'MySqlChar'>> extends MySqlColumnBuilder<

diff --git a/drizzle-orm/src/mysql-core/columns/common.ts b/drizzle-orm/src/mysql-core/columns/common.ts
@@ -6,6 +6,7 @@ import type {
 	ColumnBuilderRuntimeConfig,
 	ColumnDataType,
 	HasDefault,
+	HasGenerated,
 	MakeColumnConfig,
 } from '~/column-builder.ts';
 import type { ColumnBaseConfig } from '~/column.ts';
@@ -14,6 +15,7 @@ import { entityKind } from '~/entity.ts';
 import type { ForeignKey, UpdateDeleteAction } from '~/mysql-core/foreign-keys.ts';
 import { ForeignKeyBuilder } from '~/mysql-core/foreign-keys.ts';
 import type { AnyMySqlTable, MySqlTable } from '~/mysql-core/table.ts';
+import type { SQL } from '~/sql/sql.ts';
 import type { Update } from '~/utils.ts';
 import { uniqueKeyName } from '../unique-constraint.ts';
 
@@ -30,6 +32,10 @@ export interface MySqlColumnBuilderBase<
 	TTypeConfig extends object = object,
 > extends ColumnBuilderBase<T, TTypeConfig & { dialect: 'mysql' }> {}
 
+export interface MySqlGeneratedColumnConfig {
+	mode?: 'virtual' | 'stored';
+}
+
 export abstract class MySqlColumnBuilder<
 	T extends ColumnBuilderBaseConfig<ColumnDataType, string> = ColumnBuilderBaseConfig<ColumnDataType, string> & {
 		data: any;
@@ -55,6 +61,15 @@ export abstract class MySqlColumnBuilder<
 		return this;
 	}
 
+	generatedAlwaysAs(as: SQL | T['data'] | (() => SQL), config?: MySqlGeneratedColumnConfig): HasGenerated<this> {
+		this.config.generated = {
+			as,
+			type: 'always',
+			mode: config?.mode ?? 'virtual',
+		};
+		return this as any;
+	}
+
 	/** @internal */
 	buildForeignKeys(column: MySqlColumn, table: MySqlTable): ForeignKey[] {
 		return this.foreignKeyConfigs.map(({ ref, actions }) => {

diff --git a/drizzle-orm/src/mysql-core/columns/custom.ts b/drizzle-orm/src/mysql-core/columns/custom.ts
@@ -14,6 +14,7 @@ export type ConvertCustomConfig<TName extends string, T extends Partial<CustomTy
 		data: T['data'];
 		driverParam: T['driverData'];
 		enumValues: undefined;
+		generated: undefined;
 	}
 	& (T['notNull'] extends true ? { notNull: true } : {})
 	& (T['default'] extends true ? { hasDefault: true } : {});

diff --git a/drizzle-orm/src/mysql-core/columns/date.ts b/drizzle-orm/src/mysql-core/columns/date.ts
@@ -12,6 +12,7 @@ export type MySqlDateBuilderInitial<TName extends string> = MySqlDateBuilder<{
 	data: Date;
 	driverParam: string | number;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlDateBuilder<T extends ColumnBuilderBaseConfig<'date', 'MySqlDate'>> extends MySqlColumnBuilder<T> {
@@ -55,6 +56,7 @@ export type MySqlDateStringBuilderInitial<TName extends string> = MySqlDateStrin
 	data: string;
 	driverParam: string | number;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlDateStringBuilder<T extends ColumnBuilderBaseConfig<'string', 'MySqlDateString'>>

diff --git a/drizzle-orm/src/mysql-core/columns/datetime.ts b/drizzle-orm/src/mysql-core/columns/datetime.ts
@@ -12,6 +12,7 @@ export type MySqlDateTimeBuilderInitial<TName extends string> = MySqlDateTimeBui
 	data: Date;
 	driverParam: string | number;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlDateTimeBuilder<T extends ColumnBuilderBaseConfig<'date', 'MySqlDateTime'>>
@@ -68,8 +69,8 @@ export type MySqlDateTimeStringBuilderInitial<TName extends string> = MySqlDateT
 	columnType: 'MySqlDateTimeString';
 	data: string;
 	driverParam: string | number;
-
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlDateTimeStringBuilder<T extends ColumnBuilderBaseConfig<'string', 'MySqlDateTimeString'>>

diff --git a/drizzle-orm/src/mysql-core/columns/decimal.ts b/drizzle-orm/src/mysql-core/columns/decimal.ts
@@ -11,6 +11,7 @@ export type MySqlDecimalBuilderInitial<TName extends string> = MySqlDecimalBuild
 	data: string;
 	driverParam: string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlDecimalBuilder<

diff --git a/drizzle-orm/src/mysql-core/columns/double.ts b/drizzle-orm/src/mysql-core/columns/double.ts
@@ -11,6 +11,7 @@ export type MySqlDoubleBuilderInitial<TName extends string> = MySqlDoubleBuilder
 	data: number;
 	driverParam: number | string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlDoubleBuilder<T extends ColumnBuilderBaseConfig<'number', 'MySqlDouble'>>

diff --git a/drizzle-orm/src/mysql-core/columns/enum.ts b/drizzle-orm/src/mysql-core/columns/enum.ts
@@ -13,6 +13,7 @@ export type MySqlEnumColumnBuilderInitial<TName extends string, TEnum extends [s
 		data: TEnum[number];
 		driverParam: string;
 		enumValues: TEnum;
+		generated: undefined;
 	}>;
 
 export class MySqlEnumColumnBuilder<T extends ColumnBuilderBaseConfig<'string', 'MySqlEnumColumn'>>

diff --git a/drizzle-orm/src/mysql-core/columns/float.ts b/drizzle-orm/src/mysql-core/columns/float.ts
@@ -11,6 +11,7 @@ export type MySqlFloatBuilderInitial<TName extends string> = MySqlFloatBuilder<{
 	data: number;
 	driverParam: number | string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlFloatBuilder<T extends ColumnBuilderBaseConfig<'number', 'MySqlFloat'>>

diff --git a/drizzle-orm/src/mysql-core/columns/int.ts b/drizzle-orm/src/mysql-core/columns/int.ts
@@ -11,6 +11,7 @@ export type MySqlIntBuilderInitial<TName extends string> = MySqlIntBuilder<{
 	data: number;
 	driverParam: number | string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlIntBuilder<T extends ColumnBuilderBaseConfig<'number', 'MySqlInt'>>

diff --git a/drizzle-orm/src/mysql-core/columns/json.ts b/drizzle-orm/src/mysql-core/columns/json.ts
@@ -11,6 +11,7 @@ export type MySqlJsonBuilderInitial<TName extends string> = MySqlJsonBuilder<{
 	data: unknown;
 	driverParam: string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlJsonBuilder<T extends ColumnBuilderBaseConfig<'json', 'MySqlJson'>> extends MySqlColumnBuilder<T> {

diff --git a/drizzle-orm/src/mysql-core/columns/mediumint.ts b/drizzle-orm/src/mysql-core/columns/mediumint.ts
@@ -12,6 +12,7 @@ export type MySqlMediumIntBuilderInitial<TName extends string> = MySqlMediumIntB
 	data: number;
 	driverParam: number | string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlMediumIntBuilder<T extends ColumnBuilderBaseConfig<'number', 'MySqlMediumInt'>>

diff --git a/drizzle-orm/src/mysql-core/columns/real.ts b/drizzle-orm/src/mysql-core/columns/real.ts
@@ -11,6 +11,7 @@ export type MySqlRealBuilderInitial<TName extends string> = MySqlRealBuilder<{
 	data: number;
 	driverParam: number | string;
 	enumValues: undefined;
+	generated: undefined;
 }>;
 
 export class MySqlRealBuilder<T extends ColumnBuilderBaseConfig<'number', 'MySqlReal'>>

diff --git a/drizzle-orm/src/mysql-core/columns/serial.ts b/drizzle-orm/src/mysql-core/columns/serial.ts
@@ -19,6 +19,7 @@ export type MySqlSerialBuilderInitial<TName extends string> = NotNull<
 			data: number;
 			driverParam: number;
 			enumValues: undefined;
+			generated: undefined;
 		}>
 	>
 >;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,4 +22,4 @@ const usersOnUpdate = pgTable('users_on_update', {

		- [BUG]: insertions on columns with the smallserial datatype are not optional - #1848

		Thanks @Angelelz and @gabrielDonnantuoni!
		Thanks @Angelelz and @gabrielDonnantuoni!