@contember/schema-migrations 2.1.0-alpha.26 → 2.1.0-alpha.28

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contember/schema-migrations",
-  "version": "2.1.0-alpha.26",
+  "version": "2.1.0-alpha.28",
   "license": "Apache-2.0",
   "main": "./dist/production/index.js",
   "typings": "./dist/types/index.d.ts",
@@ -23,16 +23,16 @@
     }
   },
   "dependencies": {
-    "@contember/database": "2.1.0-alpha.26",
-    "@contember/database-migrations": "2.1.0-alpha.26",
-    "@contember/engine-common": "2.1.0-alpha.26",
-    "@contember/schema": "2.1.0-alpha.26",
-    "@contember/schema-utils": "2.1.0-alpha.26",
+    "@contember/database": "2.1.0-alpha.28",
+    "@contember/database-migrations": "2.1.0-alpha.28",
+    "@contember/engine-common": "2.1.0-alpha.28",
+    "@contember/schema": "2.1.0-alpha.28",
+    "@contember/schema-utils": "2.1.0-alpha.28",
     "fast-deep-equal": "^3.1.3",
     "rfc6902": "^5.1.1"
   },
   "devDependencies": {
-    "@contember/schema-definition": "2.1.0-alpha.26"
+    "@contember/schema-definition": "2.1.0-alpha.28"
   },
   "peerDependencies": {
     "pg": "^8.9.0"

package/src/modifications/constraints/CreateUniqueConstraintModification.ts

@@ -35,7 +35,8 @@ export class CreateUniqueConstraintModificationHandler implements ModificationHa
 
 		if ('index' in this.data.unique && this.data.unique.index) {
 			const nulls = this.data.unique.nulls === 'not distinct' ? ' NULLS NOT DISTINCT' : ''
-			builder.sql(`CREATE UNIQUE INDEX ON ${tableNameId} (${columnNameIds.join(', ')})${nulls}`)
+			const methodClause = this.data.unique.method ? ` USING ${this.data.unique.method}` : ''
+			builder.sql(`CREATE UNIQUE INDEX ON ${tableNameId}${methodClause} (${columnNameIds.join(', ')})${nulls}`)
 		} else {
 			let checkModifier = ''
 			if (this.data.unique.timing === 'deferred') {

package/src/modifications/indexes/CreateIndexModification.ts

@@ -28,8 +28,9 @@ export class CreateIndexModificationHandler implements ModificationHandler<Creat
 
 		const tableNameId = wrapIdentifier(entity.tableName)
 		const columnNameIds = columns.map(wrapIdentifier)
+		const methodClause = this.data.index.method ? ` USING ${this.data.index.method}` : ''
 
-		builder.sql(`CREATE INDEX ON ${tableNameId} (${columnNameIds.join(', ')})`)
+		builder.sql(`CREATE INDEX ON ${tableNameId}${methodClause} (${columnNameIds.join(', ')})`)
 
 		invalidateDatabaseMetadata()
 	}
@@ -47,8 +48,9 @@ export class CreateIndexModificationHandler implements ModificationHandler<Creat
 	}
 
 	describe() {
+		const methodText = this.data.index.method ? ` using ${this.data.index.method}` : ''
 		return {
-			message: `Create index(${this.data.index.fields.join(', ')}) on entity ${this.data.entityName}`,
+			message: `Create index(${this.data.index.fields.join(', ')})${methodText} on entity ${this.data.entityName}`,
 		}
 	}
 }

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

@@ -17,6 +17,34 @@ 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),
@@ -54,3 +82,75 @@ describe('drop index', () => testMigrations({
 		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('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/createUnique.test.ts

@@ -104,7 +104,7 @@ describe('change unique timing', () => testMigrations({
 			},
 		}),
 	],
-	sql: SQL`ALTER TABLE "author" DROP CONSTRAINT "uniq_author_email"; 
+	sql: SQL`ALTER TABLE "author" DROP CONSTRAINT "uniq_author_email";
 ALTER TABLE "author" ADD UNIQUE ("email") DEFERRABLE;`,
 	databaseMetadata: createDatabaseMetadata({
 		foreignKeys: [],
@@ -235,3 +235,155 @@ describe('create unique index', () => testMigrations({
 	],
 	sql: SQL`CREATE UNIQUE INDEX ON "author" ("email");`,
 }))
+
+namespace AuthorWithUniqueGinIndex {
+	@c.Unique({ fields: ['email'], index: true, method: 'gin' })
+	export class Author {
+		email = c.stringColumn()
+	}
+}
+
+namespace AuthorWithUniqueGistIndex {
+	@c.Unique({ fields: ['email'], index: true, method: 'gist' })
+	export class Author {
+		email = c.stringColumn()
+	}
+}
+
+namespace AuthorWithUniqueBtreeIndex {
+	@c.Unique({ fields: ['email'], index: true, method: 'btree', nulls: 'not distinct' })
+	export class Author {
+		email = c.stringColumn()
+	}
+}
+
+describe('create unique index with GIN method', () => testMigrations({
+	original: createSchema({
+		Author: class Author {
+			email = c.stringColumn()
+		},
+	}),
+	updated: createSchema(AuthorWithUniqueGinIndex),
+	diff: [
+		createUniqueConstraintModification.createModification({
+			entityName: 'Author',
+			unique: {
+				fields: ['email'],
+				index: true,
+				method: 'gin',
+			},
+		}),
+	],
+	sql: SQL`CREATE UNIQUE INDEX ON "author" USING gin ("email");`,
+}))
+
+describe('create unique index with GiST method', () => testMigrations({
+	original: createSchema({
+		Author: class Author {
+			email = c.stringColumn()
+		},
+	}),
+	updated: createSchema(AuthorWithUniqueGistIndex),
+	diff: [
+		createUniqueConstraintModification.createModification({
+			entityName: 'Author',
+			unique: {
+				fields: ['email'],
+				index: true,
+				method: 'gist',
+			},
+		}),
+	],
+	sql: SQL`CREATE UNIQUE INDEX ON "author" USING gist ("email");`,
+}))
+
+describe('create unique index with btree method and nulls not distinct', () => testMigrations({
+	original: createSchema({
+		Author: class Author {
+			email = c.stringColumn()
+		},
+	}),
+	updated: createSchema(AuthorWithUniqueBtreeIndex),
+	diff: [
+		createUniqueConstraintModification.createModification({
+			entityName: 'Author',
+			unique: {
+				fields: ['email'],
+				index: true,
+				method: 'btree',
+				nulls: 'not distinct',
+			},
+		}),
+	],
+	sql: SQL`CREATE UNIQUE INDEX ON "author" USING btree ("email") NULLS NOT DISTINCT;`,
+}))
+
+describe('change unique index method from gin to gist', () => testMigrations({
+	original: createSchema(AuthorWithUniqueGinIndex),
+	updated: createSchema(AuthorWithUniqueGistIndex),
+	diff: [
+		removeUniqueConstraintModification.createModification({
+			entityName: 'Author',
+			unique: {
+				fields: ['email'],
+				index: true,
+				method: 'gin',
+			},
+		}),
+		createUniqueConstraintModification.createModification({
+			entityName: 'Author',
+			unique: {
+				fields: ['email'],
+				index: true,
+				method: 'gist',
+			},
+		}),
+	],
+	sql: SQL`DROP INDEX "uniq_author_email";
+CREATE UNIQUE INDEX ON "author" USING gist ("email");`,
+	databaseMetadata: createDatabaseMetadata({
+		foreignKeys: [],
+		indexes: [{
+			tableName: 'author',
+			columnNames: ['email'],
+			indexName: 'uniq_author_email',
+			unique: true,
+		}],
+		uniqueConstraints: [],
+	}),
+}))
+
+describe('change from regular unique index to method-specific unique index', () => testMigrations({
+	original: createSchema(AuthorWithUniqueIndex),
+	updated: createSchema(AuthorWithUniqueGinIndex),
+	diff: [
+		removeUniqueConstraintModification.createModification({
+			entityName: 'Author',
+			unique: {
+				fields: ['email'],
+				index: true,
+				nulls: 'not distinct',
+			},
+		}),
+		createUniqueConstraintModification.createModification({
+			entityName: 'Author',
+			unique: {
+				fields: ['email'],
+				index: true,
+				method: 'gin',
+			},
+		}),
+	],
+	sql: SQL`DROP INDEX "uniq_author_email";
+CREATE UNIQUE INDEX ON "author" USING gin ("email");`,
+	databaseMetadata: createDatabaseMetadata({
+		foreignKeys: [],
+		indexes: [{
+			tableName: 'author',
+			columnNames: ['email'],
+			indexName: 'uniq_author_email',
+			unique: true,
+		}],
+		uniqueConstraints: [],
+	}),
+}))