@contember/schema-migrations 1.2.0-alpha.2 → 1.2.0-alpha.5

package/src/modifications/indexes/CreateIndexModification.ts

@@ -0,0 +1,82 @@
+import { MigrationBuilder } from '@contember/database-migrations'
+import { Model, Schema } from '@contember/schema'
+import { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'
+import { ModificationHandlerStatic } from '../ModificationHandler'
+import { acceptFieldVisitor } from '@contember/schema-utils'
+
+export const CreateIndexModification: ModificationHandlerStatic<CreateIndexModificationData> = class {
+	static id = 'createIndex'
+
+	constructor(private readonly data: CreateIndexModificationData, private readonly schema: Schema) {}
+
+	public createSql(builder: MigrationBuilder): void {
+		const entity = this.schema.model.entities[this.data.entityName]
+		if (entity.view) {
+			return
+		}
+		const fields = this.data.index.fields
+		const columns = fields.map(fieldName => {
+			return acceptFieldVisitor(this.schema.model, entity, fieldName, {
+				visitColumn: ({}, column) => {
+					return column.columnName
+				},
+				visitManyHasOne: ({}, relation) => {
+					return relation.joiningColumn.columnName
+				},
+				visitOneHasOneOwning: ({}, relation) => {
+					return relation.joiningColumn.columnName
+				},
+				visitOneHasMany: () => {
+					throw new Error(`Cannot create index on 1:m relation in ${entity.name}.${fieldName}`)
+				},
+				visitOneHasOneInverse: () => {
+					throw new Error(`Cannot create index on 1:1 inverse relation in ${entity.name}.${fieldName}`)
+				},
+				visitManyHasManyOwning: () => {
+					throw new Error(`Cannot create index on m:m relation in ${entity.name}.${fieldName}`)
+				},
+				visitManyHasManyInverse: () => {
+					throw new Error(`Cannot create index on m:m inverse relation in ${entity.name}.${fieldName}`)
+				},
+			})
+		})
+		builder.addIndex(entity.tableName, [...columns], {
+			name: this.data.index.name,
+		})
+	}
+
+	public getSchemaUpdater(): SchemaUpdater {
+		return updateModel(
+			updateEntity(this.data.entityName, ({ entity }) => ({
+				...entity,
+				indexes: {
+					...entity.indexes,
+					[this.data.index.name]: this.data.index,
+				},
+			})),
+		)
+	}
+
+	describe() {
+		return {
+			message: `Create index(${this.data.index.fields.join(', ')}) on entity ${this.data.entityName}`,
+		}
+	}
+
+	static createModification(data: CreateIndexModificationData) {
+		return { modification: this.id, ...data }
+	}
+
+	static createDiff(originalSchema: Schema, updatedSchema: Schema) {
+		return Object.values(updatedSchema.model.entities).flatMap(entity =>
+			Object.values(entity.indexes)
+				.filter(it => !originalSchema.model.entities[entity.name].indexes[it.name])
+				.map(index => CreateIndexModification.createModification({ entityName: entity.name, index })),
+		)
+	}
+}
+
+export interface CreateIndexModificationData {
+	entityName: string
+	index: Model.Index
+}

package/src/modifications/indexes/RemoveIndexModification.ts

@@ -0,0 +1,64 @@
+import { MigrationBuilder } from '@contember/database-migrations'
+import { Schema } from '@contember/schema'
+import { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'
+import { ModificationHandlerStatic } from '../ModificationHandler'
+import deepEqual from 'fast-deep-equal'
+
+export const RemoveIndexModification: ModificationHandlerStatic<RemoveIndexModificationData> = class {
+	static id = 'removeIndex'
+	constructor(private readonly data: RemoveIndexModificationData, private readonly schema: Schema) {}
+
+	public createSql(builder: MigrationBuilder): void {
+		const entity = this.schema.model.entities[this.data.entityName]
+		if (entity.view) {
+			return
+		}
+		builder.dropIndex(entity.tableName, [], {
+			name: this.data.indexName,
+		})
+	}
+
+	public getSchemaUpdater(): SchemaUpdater {
+		return updateModel(
+			updateEntity(this.data.entityName, ({ entity }) => {
+				const { [this.data.indexName]: removed, ...indexes } = entity.indexes
+				return {
+					...entity,
+					indexes,
+				}
+			}),
+		)
+	}
+
+	describe() {
+		const fields = this.schema.model.entities[this.data.entityName].indexes[this.data.indexName].fields
+		return { message: `Remove index (${fields.join(', ')}) on entity ${this.data.entityName}` }
+	}
+
+	static createModification(data: RemoveIndexModificationData) {
+		return { modification: this.id, ...data }
+	}
+
+	static createDiff(originalSchema: Schema, updatedSchema: Schema) {
+		return Object.values(originalSchema.model.entities).flatMap(entity =>
+			Object.values(entity.indexes)
+				.filter(
+					it =>
+						updatedSchema.model.entities[entity.name] &&
+						(!updatedSchema.model.entities[entity.name].indexes[it.name] ||
+							!deepEqual(it.fields, updatedSchema.model.entities[entity.name].indexes[it.name].fields)),
+				)
+				.map(index =>
+					RemoveIndexModification.createModification({
+						entityName: entity.name,
+						indexName: index.name,
+					}),
+				),
+		)
+	}
+}
+
+export interface RemoveIndexModificationData {
+	entityName: string
+	indexName: string
+}

package/src/modifications/indexes/index.ts

@@ -0,0 +1,2 @@
+export * from './CreateIndexModification'
+export * from './RemoveIndexModification'

package/src/utils/PartialEntity.ts

@@ -0,0 +1,5 @@
+import { Model } from '@contember/schema'
+
+type SomePartial<E, K extends keyof E> = Omit<E, K> & Partial<Pick<E, K>>
+
+export type PartialEntity = SomePartial<Model.Entity, 'eventLog' | 'indexes'>

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

@@ -0,0 +1,44 @@
+import { testMigrations } from '../../src/tests'
+import { SQL } from '../../src/tags'
+import { SchemaDefinition as def } from '@contember/schema-definition'
+
+namespace SchemaWithoutIndex {
+	export class Article {
+		title = def.stringColumn()
+	}
+}
+
+namespace SchemaWithIndex {
+	@def.Index('title')
+	export class Article {
+		title = def.stringColumn()
+	}
+}
+
+
+testMigrations('create index', {
+	originalSchema: def.createModel(SchemaWithoutIndex),
+	updatedSchema: def.createModel(SchemaWithIndex),
+	diff: [
+		{
+			modification: 'createIndex',
+			entityName: 'Article',
+			index: { name: 'idx_Article_title_2dc66a', fields: ['title'] },
+		},
+	],
+	sql: SQL`CREATE INDEX "idx_Article_title_2dc66a" ON "article" ("title");`,
+})
+
+
+testMigrations('drop index', {
+	originalSchema: def.createModel(SchemaWithIndex),
+	updatedSchema: def.createModel(SchemaWithoutIndex),
+	diff: [
+		{
+			modification: 'removeIndex',
+			entityName: 'Article',
+			indexName: 'idx_Article_title_2dc66a',
+		},
+	],
+	sql: SQL`DROP INDEX "idx_Article_title_2dc66a";`,
+})

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

@@ -35,6 +35,7 @@ testMigrations('create a table (no relations, unique on column)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -141,6 +142,7 @@ testMigrations('create a view', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],

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

@@ -34,6 +34,7 @@ testMigrations('create many has many relation (post with categories)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

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

@@ -36,6 +36,7 @@ testMigrations('create many has one relation (post with author)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

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

@@ -37,6 +37,7 @@ testMigrations('create one has many relation (post with locales)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

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

@@ -34,6 +34,7 @@ testMigrations('create one has one relation (site with settings)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -56,6 +57,7 @@ testMigrations('create one has one relation (site with settings)', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

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

@@ -68,6 +68,7 @@ testMigrations('create view', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{

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

@@ -83,6 +83,7 @@ testMigrations('update a view 1', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -118,6 +119,7 @@ testMigrations('update a view 1', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -153,6 +155,7 @@ testMigrations('update a view 1', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],
@@ -227,6 +230,7 @@ testMigrations('update a view 2', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -262,6 +266,7 @@ testMigrations('update a view 2', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],
@@ -331,6 +336,7 @@ testMigrations('update a view 3', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],
@@ -402,6 +408,7 @@ testMigrations('update a view 4', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -437,6 +444,7 @@ testMigrations('update a view 4', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 		{
@@ -472,6 +480,7 @@ testMigrations('update a view 4', {
 				eventLog: {
 					enabled: true,
 				},
+				indexes: {},
 			},
 		},
 	],