@contember/schema-migrations 2.1.0-alpha.3 → 2.1.0-alpha.35

package/tests/cases/integration/createAndDropIndex.test.ts

@@ -17,40 +17,142 @@ namespace SchemaWithIndex {
 	}
 }
 
+namespace SchemaWithGinIndex {
+	@def.Index({ fields: ['title'], method: 'gin' })
+	export class Article {
+		title = def.stringColumn()
+	}
+}
+
+namespace SchemaWithGistIndex {
+	@def.Index({ fields: ['title'], method: 'gist' })
+	export class Article {
+		title = def.stringColumn()
+	}
+}
+
+namespace SchemaWithBtreeIndex {
+	@def.Index({ fields: ['title'], method: 'btree' })
+	export class Article {
+		title = def.stringColumn()
+	}
+}
+
+namespace SchemaWithHashIndex {
+	@def.Index({ fields: ['title'], method: 'hash' })
+	export class Article {
+		title = def.stringColumn()
+	}
+}
+
+describe('create index', () =>
+	testMigrations({
+		original: createSchema(SchemaWithoutIndex),
+		updated: createSchema(SchemaWithIndex),
+		diff: [
+			{
+				modification: 'createIndex',
+				entityName: 'Article',
+				index: { fields: ['title'] },
+			},
+		],
+		sql: SQL`CREATE INDEX ON "article" ("title");`,
+	}))
+
+describe('drop index', () =>
+	testMigrations({
+		original: createSchema(SchemaWithIndex),
+		updated: createSchema(SchemaWithoutIndex),
+		diff: [
+			{
+				modification: 'removeIndex',
+				entityName: 'Article',
+				fields: ['title'],
+			},
+		],
+		sql: SQL`DROP INDEX "idx_article_title";`,
+		databaseMetadata: createDatabaseMetadata({
+			foreignKeys: [],
+			indexes: [{
+				tableName: 'article',
+				columnNames: ['title'],
+				indexName: 'idx_article_title',
+				unique: false,
+			}],
+			uniqueConstraints: [],
+		}),
+	}))
+
+describe('create index with GIN method', () =>
+	testMigrations({
+		original: createSchema(SchemaWithoutIndex),
+		updated: createSchema(SchemaWithGinIndex),
+		diff: [
+			{
+				modification: 'createIndex',
+				entityName: 'Article',
+				index: { fields: ['title'], method: 'gin' },
+			},
+		],
+		sql: SQL`CREATE INDEX ON "article" USING gin ("title");`,
+	}))
+
+describe('change index method from btree to gin', () =>
+	testMigrations({
+		original: createSchema(SchemaWithBtreeIndex),
+		updated: createSchema(SchemaWithGinIndex),
+		diff: [
+			{
+				modification: 'removeIndex',
+				entityName: 'Article',
+				fields: ['title'],
+			},
+			{
+				modification: 'createIndex',
+				entityName: 'Article',
+				index: { fields: ['title'], method: 'gin' },
+			},
+		],
+		sql: SQL`DROP INDEX "idx_article_title";
+CREATE INDEX ON "article" USING gin ("title");`,
+		databaseMetadata: createDatabaseMetadata({
+			foreignKeys: [],
+			indexes: [{
+				tableName: 'article',
+				columnNames: ['title'],
+				indexName: 'idx_article_title',
+				unique: false,
+			}],
+			uniqueConstraints: [],
+		}),
+	}))
 
-describe('create index', () => testMigrations({
-	original: createSchema(SchemaWithoutIndex),
-	updated: createSchema(SchemaWithIndex),
-	diff: [
-		{
-			modification: 'createIndex',
-			entityName: 'Article',
-			index: { fields: ['title'] },
-		},
-	],
-	sql: SQL`CREATE INDEX ON "article" ("title");`,
-}))
-
-
-describe('drop index', () => testMigrations({
-	original: createSchema(SchemaWithIndex),
-	updated: createSchema(SchemaWithoutIndex),
-	diff: [
-		{
-			modification: 'removeIndex',
-			entityName: 'Article',
-			fields: ['title'],
-		},
-	],
-	sql: SQL`DROP INDEX "idx_article_title";`,
-	databaseMetadata: createDatabaseMetadata({
-		foreignKeys: [],
-		indexes: [{
-			tableName: 'article',
-			columnNames: ['title'],
-			indexName: 'idx_article_title',
-			unique: false,
-		}],
-		uniqueConstraints: [],
-	}),
-}))
+describe('change from regular index to method-specific index', () =>
+	testMigrations({
+		original: createSchema(SchemaWithIndex),
+		updated: createSchema(SchemaWithHashIndex),
+		diff: [
+			{
+				modification: 'removeIndex',
+				entityName: 'Article',
+				fields: ['title'],
+			},
+			{
+				modification: 'createIndex',
+				entityName: 'Article',
+				index: { fields: ['title'], method: 'hash' },
+			},
+		],
+		sql: SQL`DROP INDEX "idx_article_title";
+CREATE INDEX ON "article" USING hash ("title");`,
+		databaseMetadata: createDatabaseMetadata({
+			foreignKeys: [],
+			indexes: [{
+				tableName: 'article',
+				columnNames: ['title'],
+				indexName: 'idx_article_title',
+				unique: false,
+			}],
+			uniqueConstraints: [],
+		}),
+	}))

package/tests/cases/integration/createColumn.test.ts

@@ -4,162 +4,164 @@ import { SQL } from '../../src/tags'
 import { describe } from 'bun:test'
 import { testMigrations } from '../../src/tests'
 
-describe('create a column with default value', () => testMigrations({
-	original: createSchema({
-		Author: class Author {
-			email = def.stringColumn().unique()
-		},
-	}),
-	updated: createSchema({
-		Author: class Author {
-			name = def.stringColumn().notNull()
-			email = def.stringColumn().unique()
-		},
-	}),
-	noDiff: true,
-	diff: [
-		{
-			modification: 'createColumn',
-			entityName: 'Author',
-			field: {
-				columnName: 'name',
-				name: 'name',
-				nullable: false,
-				type: Model.ColumnType.String,
-				columnType: 'text',
-			},
-			fillValue: 'unnamed author',
-		},
-	],
-	sql: SQL`ALTER TABLE "author" ADD "name" text;
+describe('create a column with default value', () =>
+	testMigrations({
+		original: createSchema({
+			Author: class Author {
+				email = def.stringColumn().unique()
+			},
+		}),
+		updated: createSchema({
+			Author: class Author {
+				name = def.stringColumn().notNull()
+				email = def.stringColumn().unique()
+			},
+		}),
+		noDiff: true,
+		diff: [
+			{
+				modification: 'createColumn',
+				entityName: 'Author',
+				field: {
+					columnName: 'name',
+					name: 'name',
+					nullable: false,
+					type: Model.ColumnType.String,
+					columnType: 'text',
+				},
+				fillValue: 'unnamed author',
+			},
+		],
+		sql: SQL`ALTER TABLE "author" ADD "name" text;
 UPDATE "author" SET "name" = $pga$unnamed author$pga$;
 SET CONSTRAINTS ALL IMMEDIATE; SET CONSTRAINTS ALL DEFERRED;
 ALTER TABLE "author" ALTER "name" SET NOT NULL;`,
-}))
+	}))
 
-describe('create a column with copy value', () => testMigrations({
-	original: createSchema({
-		Author: class Author {
-			email = def.stringColumn().unique()
-		},
-	}),
-	updated: createSchema({
-		Author: class Author {
-			name = def.stringColumn().notNull()
-			email = def.stringColumn().unique()
-		},
-	}),
-	diff: [
-		{
-			modification: 'createColumn',
-			entityName: 'Author',
-			field: {
-				columnName: 'name',
-				name: 'name',
-				nullable: false,
-				type: Model.ColumnType.String,
-				columnType: 'text',
-			},
-			copyValue: 'email',
-		},
-	],
-	noDiff: true,
-	sql: SQL`ALTER TABLE "author" ADD "name" text;
+describe('create a column with copy value', () =>
+	testMigrations({
+		original: createSchema({
+			Author: class Author {
+				email = def.stringColumn().unique()
+			},
+		}),
+		updated: createSchema({
+			Author: class Author {
+				name = def.stringColumn().notNull()
+				email = def.stringColumn().unique()
+			},
+		}),
+		diff: [
+			{
+				modification: 'createColumn',
+				entityName: 'Author',
+				field: {
+					columnName: 'name',
+					name: 'name',
+					nullable: false,
+					type: Model.ColumnType.String,
+					columnType: 'text',
+				},
+				copyValue: 'email',
+			},
+		],
+		noDiff: true,
+		sql: SQL`ALTER TABLE "author" ADD "name" text;
 UPDATE "author" SET "name" = "email"::text;
 SET CONSTRAINTS ALL IMMEDIATE; SET CONSTRAINTS ALL DEFERRED;
 ALTER TABLE "author" ALTER "name" SET NOT NULL;`,
-}))
-
+	}))
 
-describe('create a column with default value with "using"', () => testMigrations({
-	original: createSchema({
-		Author: class Author {
-			email = def.stringColumn().unique()
-		},
-	}),
-	updated: createSchema({
-		Author: class Author {
-			name = def.stringColumn().default('unnamed author').notNull()
-			order = def.intColumn().default(0).notNull()
-			score = def.doubleColumn().default(1 / 3).notNull()
-			active = def.boolColumn().default(false).notNull()
-			createdAt = def.dateTimeColumn().default('2024-01-01 10:00').notNull()
-			email = def.stringColumn().unique()
-		},
-	}),
-	diff: [
-		{
-			modification: 'createColumn',
-			entityName: 'Author',
-			field: {
-				columnName: 'name',
-				name: 'name',
-				nullable: false,
-				default: 'unnamed author',
-				type: Model.ColumnType.String,
-				columnType: 'text',
-			},
-			fillValue: 'unnamed author',
-			valueMigrationStrategy: 'using',
-		},
-		{
-			modification: 'createColumn',
-			entityName: 'Author',
-			field: {
-				columnName: 'order',
-				name: 'order',
-				nullable: false,
-				default: 0,
-				type: Model.ColumnType.Int,
-				columnType: 'integer',
-			},
-			fillValue: 0,
-			valueMigrationStrategy: 'using',
-		},
-		{
-			modification: 'createColumn',
-			entityName: 'Author',
-			field: {
-				columnName: 'score',
-				name: 'score',
-				nullable: false,
-				default: 0.3333333333333333,
-				type: Model.ColumnType.Double,
-				columnType: 'double precision',
-			},
-			fillValue: 0.3333333333333333,
-			valueMigrationStrategy: 'using',
-		},
-		{
-			modification: 'createColumn',
-			entityName: 'Author',
-			field: {
-				columnName: 'active',
-				name: 'active',
-				nullable: false,
-				default: false,
-				type: Model.ColumnType.Bool,
-				columnType: 'boolean',
-			},
-			fillValue: false,
-			valueMigrationStrategy: 'using',
-		},
-		{
-			modification: 'createColumn',
-			entityName: 'Author',
-			field: {
-				columnName: 'created_at',
-				name: 'createdAt',
-				nullable: false,
-				default: '2024-01-01 10:00',
-				type: Model.ColumnType.DateTime,
-				columnType: 'timestamptz',
-			},
-			fillValue: '2024-01-01 10:00',
-			valueMigrationStrategy: 'using',
-		},
-	],
-	sql: SQL`
+describe('create a column with default value with "using"', () =>
+	testMigrations({
+		original: createSchema({
+			Author: class Author {
+				email = def.stringColumn().unique()
+			},
+		}),
+		updated: createSchema({
+			Author: class Author {
+				name = def.stringColumn().default('unnamed author').notNull()
+				order = def.intColumn().default(0).notNull()
+				score = def.doubleColumn().default(1 / 3).notNull()
+				active = def.boolColumn().default(false).notNull()
+				createdAt = def.dateTimeColumn().default('2024-01-01 10:00').notNull()
+				email = def.stringColumn().unique()
+			},
+		}),
+		diff: [
+			{
+				modification: 'createColumn',
+				entityName: 'Author',
+				field: {
+					columnName: 'name',
+					name: 'name',
+					nullable: false,
+					default: 'unnamed author',
+					type: Model.ColumnType.String,
+					columnType: 'text',
+				},
+				fillValue: 'unnamed author',
+				valueMigrationStrategy: 'using',
+			},
+			{
+				modification: 'createColumn',
+				entityName: 'Author',
+				field: {
+					columnName: 'order',
+					name: 'order',
+					nullable: false,
+					default: 0,
+					type: Model.ColumnType.Int,
+					columnType: 'integer',
+				},
+				fillValue: 0,
+				valueMigrationStrategy: 'using',
+			},
+			{
+				modification: 'createColumn',
+				entityName: 'Author',
+				field: {
+					columnName: 'score',
+					name: 'score',
+					nullable: false,
+					default: 0.3333333333333333,
+					type: Model.ColumnType.Double,
+					columnType: 'double precision',
+				},
+				fillValue: 0.3333333333333333,
+				valueMigrationStrategy: 'using',
+			},
+			{
+				modification: 'createColumn',
+				entityName: 'Author',
+				field: {
+					columnName: 'active',
+					name: 'active',
+					nullable: false,
+					default: false,
+					type: Model.ColumnType.Bool,
+					columnType: 'boolean',
+				},
+				fillValue: false,
+				valueMigrationStrategy: 'using',
+			},
+			{
+				modification: 'createColumn',
+				entityName: 'Author',
+				field: {
+					columnName: 'created_at',
+					name: 'createdAt',
+					nullable: false,
+					default: '2024-01-01 10:00',
+					type: Model.ColumnType.DateTime,
+					columnType: 'timestamptz',
+				},
+				fillValue: '2024-01-01 10:00',
+				valueMigrationStrategy: 'using',
+			},
+		],
+		sql: SQL`
 ALTER TABLE "author" ADD "name" text;
 ALTER TABLE "author" ALTER "name" SET DATA TYPE text USING $pga$unnamed author$pga$, ALTER "name" SET NOT NULL;
 ALTER TABLE "author" ADD "order" integer;
@@ -171,31 +173,32 @@ ALTER TABLE "author" ALTER "active" SET DATA TYPE boolean USING false,
 ALTER "active" SET NOT NULL; ALTER TABLE "author" ADD "created_at" timestamptz; 
 ALTER TABLE "author" ALTER "created_at" SET DATA TYPE timestamptz USING $pga$2024-01-01 10:00$pga$, ALTER "created_at" SET NOT NULL;
 `,
-}))
+	}))
 
-describe('create list column', () => testMigrations({
-	original: createSchema({
-		Author: class Author {
-		},
-	}),
-	updated: createSchema({
-		Author: class Author {
-			emails = def.stringColumn().list()
-		},
-	}),
-	diff: [
-		{
-			modification: 'createColumn',
-			entityName: 'Author',
-			field: {
-				columnName: 'emails',
-				name: 'emails',
-				nullable: true,
-				type: Model.ColumnType.String,
-				columnType: 'text',
-				list: true,
-			},
-		},
-	],
-	sql: SQL`ALTER TABLE "author" ADD "emails" text[];`,
-}))
+describe('create list column', () =>
+	testMigrations({
+		original: createSchema({
+			Author: class Author {
+			},
+		}),
+		updated: createSchema({
+			Author: class Author {
+				emails = def.stringColumn().list()
+			},
+		}),
+		diff: [
+			{
+				modification: 'createColumn',
+				entityName: 'Author',
+				field: {
+					columnName: 'emails',
+					name: 'emails',
+					nullable: true,
+					type: Model.ColumnType.String,
+					columnType: 'text',
+					list: true,
+				},
+			},
+		],
+		sql: SQL`ALTER TABLE "author" ADD "emails" text[];`,
+	}))