@contember/schema-migrations 1.2.1 → 1.3.0-alpha.13

package/src/modifications/constraints/CreateUniqueConstraintModification.ts

@@ -1,57 +1,48 @@
 import { MigrationBuilder } from '@contember/database-migrations'
 import { Model, Schema } from '@contember/schema'
 import { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'
-import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
-import { acceptFieldVisitor } from '@contember/schema-utils'
+import {
+	createModificationType,
+	Differ,
+	ModificationHandler,
+	ModificationHandlerCreateSqlOptions,
+} from '../ModificationHandler'
+import { wrapIdentifier } from '../../utils/dbHelpers'
+import { getUniqueConstraintColumns } from './utils'
+import deepEqual from 'fast-deep-equal'
 
 export class CreateUniqueConstraintModificationHandler implements ModificationHandler<CreateUniqueConstraintModificationData> {
 	constructor(private readonly data: CreateUniqueConstraintModificationData, private readonly schema: Schema) {
 	}
 
-	public createSql(builder: MigrationBuilder): void {
+	public createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {
 		const entity = this.schema.model.entities[this.data.entityName]
 		if (entity.view) {
 			return
 		}
 		const fields = this.data.unique.fields
-		const columns = fields.map(fieldName => {
-			return acceptFieldVisitor(this.schema.model, entity, fieldName, {
-				visitColumn: ({ column }) => {
-					return column.columnName
-				},
-				visitManyHasOne: ({ relation }) => {
-					return relation.joiningColumn.columnName
-				},
-				visitOneHasMany: () => {
-					throw new Error(`Cannot create unique key on 1:m relation in ${entity.name}.${fieldName}`)
-				},
-				visitOneHasOneOwning: () => {
-					throw new Error(
-						`Cannot create unique key on 1:1 relation, this relation has unique key by default in ${entity.name}.${fieldName}`,
-					)
-				},
-				visitOneHasOneInverse: () => {
-					throw new Error(`Cannot create unique key on 1:1 inverse relation in ${entity.name}.${fieldName}`)
-				},
-				visitManyHasManyOwning: () => {
-					throw new Error(`Cannot create unique key on m:m relation in ${entity.name}.${fieldName}`)
-				},
-				visitManyHasManyInverse: () => {
-					throw new Error(`Cannot create unique key on m:m inverse relation in ${entity.name}.${fieldName}`)
-				},
-			})
+		const columns = getUniqueConstraintColumns({
+			entity,
+			model: this.schema.model,
+			fields,
 		})
-		builder.addConstraint(entity.tableName, this.data.unique.name, { unique: columns })
+
+		const tableNameId = wrapIdentifier(entity.tableName)
+		const columnNameIds = columns.map(wrapIdentifier)
+
+		builder.sql(`ALTER TABLE ${tableNameId} ADD UNIQUE (${columnNameIds.join(', ')})`)
+
+		invalidateDatabaseMetadata()
 	}
 
 	public getSchemaUpdater(): SchemaUpdater {
 		return updateModel(
 			updateEntity(this.data.entityName, ({ entity }) => ({
 				...entity,
-				unique: {
+				unique: [
 					...entity.unique,
-					[this.data.unique.name]: this.data.unique,
-				},
+					this.data.unique,
+				],
 			})),
 		)
 	}
@@ -67,21 +58,21 @@ export class CreateUniqueConstraintModificationHandler implements ModificationHa
 
 }
 
-export interface CreateUniqueConstraintModificationData {
-	entityName: string
-	unique: Model.UniqueConstraint
-}
-
 export const createUniqueConstraintModification = createModificationType({
 	id: 'createUniqueConstraint',
 	handler: CreateUniqueConstraintModificationHandler,
 })
 
+export interface CreateUniqueConstraintModificationData {
+	entityName: string
+	unique: Model.UniqueConstraint
+}
+
 export class CreateUniqueConstraintDiffer implements Differ {
 	createDiff(originalSchema: Schema, updatedSchema: Schema) {
 		return Object.values(updatedSchema.model.entities).flatMap(entity =>
-			Object.values(entity.unique)
-				.filter(it => !originalSchema.model.entities[entity.name].unique[it.name])
+			entity.unique
+				.filter(it => !originalSchema.model.entities[entity.name].unique.find(uniq => deepEqual(uniq.fields, it.fields)))
 				.map(unique => createUniqueConstraintModification.createModification({
 					entityName: entity.name,
 					unique,

package/src/modifications/constraints/RemoveUniqueConstraintModification.ts

@@ -1,25 +1,48 @@
 import { MigrationBuilder } from '@contember/database-migrations'
 import { Schema } from '@contember/schema'
 import { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'
-import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
+import {
+	createModificationType,
+	Differ,
+	ModificationHandler,
+	ModificationHandlerCreateSqlOptions,
+} from '../ModificationHandler'
 import deepEqual from 'fast-deep-equal'
+import { getUniqueConstraintColumns } from './utils'
+import { wrapIdentifier } from '../../utils/dbHelpers'
 
 export class RemoveUniqueConstraintModificationHandler implements ModificationHandler<RemoveUniqueConstraintModificationData> {
 	constructor(private readonly data: RemoveUniqueConstraintModificationData, private readonly schema: Schema) {
 	}
 
-	public createSql(builder: MigrationBuilder): void {
+	public createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {
 		const entity = this.schema.model.entities[this.data.entityName]
 		if (entity.view) {
 			return
 		}
-		builder.dropConstraint(entity.tableName, this.data.constraintName)
+
+		const fields = this.getFields()
+
+		const columns = getUniqueConstraintColumns({
+			entity,
+			fields: fields,
+			model: this.schema.model,
+		})
+
+		const constraintNames = databaseMetadata.getUniqueConstraintNames({ tableName: entity.tableName, columnNames: columns })
+
+		for (const name of constraintNames) {
+			builder.sql(`ALTER TABLE ${wrapIdentifier(entity.tableName)} DROP CONSTRAINT ${wrapIdentifier(name)}`)
+		}
+
+		invalidateDatabaseMetadata()
 	}
 
 	public getSchemaUpdater(): SchemaUpdater {
+		const fields = this.getFields()
 		return updateModel(
 			updateEntity(this.data.entityName, ({ entity }) => {
-				const { [this.data.constraintName]: removed, ...unique } = entity.unique
+				const unique = entity.unique.filter(it => !deepEqual(it.fields, fields))
 				return {
 					...entity,
 					unique,
@@ -29,14 +52,21 @@ export class RemoveUniqueConstraintModificationHandler implements ModificationHa
 	}
 
 	describe() {
-		const fields = this.schema.model.entities[this.data.entityName].unique[this.data.constraintName].fields
+		const fields = this.getFields()
 		return { message: `Remove unique constraint (${fields.join(', ')}) on entity ${this.data.entityName}` }
 	}
-}
 
-export interface RemoveUniqueConstraintModificationData {
-	entityName: string
-	constraintName: string
+	getFields() {
+		const entity = this.schema.model.entities[this.data.entityName]
+		const fields = 'constraintName' in this.data
+			? entity.unique.find(it => it.name === this.data.constraintName)?.fields
+			: this.data.fields
+
+		if (!fields) {
+			throw new Error()
+		}
+		return fields
+	}
 }
 
 export const removeUniqueConstraintModification = createModificationType({
@@ -44,21 +74,36 @@ export const removeUniqueConstraintModification = createModificationType({
 	handler: RemoveUniqueConstraintModificationHandler,
 })
 
+export type RemoveUniqueConstraintModificationData =
+	| {
+		entityName: string
+		constraintName: string
+		fields?: never
+	}
+	| {
+		entityName: string
+		fields: readonly string[]
+		constraintName?: never
+	}
+
 
 export class RemoveUniqueConstraintDiffer implements Differ {
 	createDiff(originalSchema: Schema, updatedSchema: Schema) {
 		return Object.values(originalSchema.model.entities).flatMap(entity =>
-			Object.values(entity.unique)
+			entity.unique
 				.filter(
-					it =>
-						updatedSchema.model.entities[entity.name] &&
-						(!updatedSchema.model.entities[entity.name].unique[it.name] ||
-							!deepEqual(it.fields, updatedSchema.model.entities[entity.name].unique[it.name].fields)),
+					it => {
+						const updatedEntity = updatedSchema.model.entities[entity.name]
+						if (!updatedEntity) {
+							return false
+						}
+						return !updatedEntity.unique.find(uniq => deepEqual(uniq.fields, it.fields))
+					},
 				)
 				.map(unique =>
 					removeUniqueConstraintModification.createModification({
 						entityName: entity.name,
-						constraintName: unique.name,
+						fields: unique.fields,
 					}),
 				),
 		)

package/src/modifications/constraints/utils.ts

@@ -0,0 +1,36 @@
+import { acceptFieldVisitor } from '@contember/schema-utils'
+import { Model } from '@contember/schema'
+
+export const getUniqueConstraintColumns = ({ entity, fields, model }: {
+	fields: readonly string[]
+	model: Model.Schema
+	entity: Model.Entity
+}) => {
+	return fields.map(fieldName => {
+		return acceptFieldVisitor(model, entity, fieldName, {
+			visitColumn: ({ column }) => {
+				return column.columnName
+			},
+			visitManyHasOne: ({ relation }) => {
+				return relation.joiningColumn.columnName
+			},
+			visitOneHasMany: () => {
+				throw new Error(`Cannot create unique key on 1:m relation in ${entity.name}.${fieldName}`)
+			},
+			visitOneHasOneOwning: () => {
+				throw new Error(
+					`Cannot create unique key on 1:1 relation, this relation has unique key by default in ${entity.name}.${fieldName}`,
+				)
+			},
+			visitOneHasOneInverse: () => {
+				throw new Error(`Cannot create unique key on 1:1 inverse relation in ${entity.name}.${fieldName}`)
+			},
+			visitManyHasManyOwning: () => {
+				throw new Error(`Cannot create unique key on m:m relation in ${entity.name}.${fieldName}`)
+			},
+			visitManyHasManyInverse: () => {
+				throw new Error(`Cannot create unique key on m:m inverse relation in ${entity.name}.${fieldName}`)
+			},
+		})
+	})
+}

package/src/modifications/entities/CreateEntityModification.ts

@@ -4,11 +4,11 @@ import { SchemaUpdater, updateModel } from '../utils/schemaUpdateUtils'
 import {
 	createModificationType,
 	Differ,
-	ModificationHandler,
+	ModificationHandler, ModificationHandlerCreateSqlOptions,
 	ModificationHandlerOptions,
 } from '../ModificationHandler'
 import { createEventTrigger, createEventTrxTrigger } from '../utils/sqlUpdateUtils'
-import { PartialEntity } from '../../utils/PartialEntity.js'
+import { PossibleEntityShapeInMigrations } from '../../utils/PartialEntity.js'
 import { getColumnSqlType } from '../utils/columnUtils'
 
 export class CreateEntityModificationHandler implements ModificationHandler<CreateEntityModificationData> {
@@ -18,7 +18,7 @@ export class CreateEntityModificationHandler implements ModificationHandler<Crea
 		private readonly options: ModificationHandlerOptions,
 	) {}
 
-	public createSql(builder: MigrationBuilder): void {
+	public createSql(builder: MigrationBuilder, { systemSchema }: ModificationHandlerCreateSqlOptions): void {
 		const entity = this.data.entity
 		if (entity.view) {
 			// BC
@@ -37,8 +37,8 @@ export class CreateEntityModificationHandler implements ModificationHandler<Crea
 		})
 
 		if  (entity.eventLog?.enabled !== false) {
-			createEventTrigger(builder, this.options.systemSchema, entity.tableName, [entity.primaryColumn])
-			createEventTrxTrigger(builder, this.options.systemSchema, entity.tableName)
+			createEventTrigger(builder, systemSchema, entity.tableName, [entity.primaryColumn])
+			createEventTrxTrigger(builder, systemSchema, entity.tableName)
 		}
 	}
 
@@ -49,8 +49,9 @@ export class CreateEntityModificationHandler implements ModificationHandler<Crea
 				...model.entities,
 				[this.data.entity.name]: {
 					eventLog: { enabled: true },
-					indexes: {},
 					...this.data.entity,
+					unique: Object.values(this.data.entity.unique),
+					indexes: Object.values(this.data.entity.indexes ?? []),
 				},
 			},
 		}))
@@ -80,7 +81,7 @@ export class CreateEntityDiffer implements Differ {
 						fields: {
 							[entity.primary]: entity.fields[entity.primary],
 						},
-						unique: {},
+						unique: [],
 					},
 				}),
 			)
@@ -88,5 +89,5 @@ export class CreateEntityDiffer implements Differ {
 }
 
 export interface CreateEntityModificationData {
-	entity: PartialEntity
+	entity: PossibleEntityShapeInMigrations
 }

package/src/modifications/entities/CreateViewModification.ts

@@ -3,7 +3,7 @@ import { Model, Schema } from '@contember/schema'
 import { SchemaUpdater, updateModel } from '../utils/schemaUpdateUtils'
 import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
 import { Migration } from '../../Migration'
-import { PartialEntity } from '../../utils/PartialEntity.js'
+import { PossibleEntityShapeInMigrations } from '../../utils/PartialEntity.js'
 
 export class CreateViewModificationHandler implements ModificationHandler<CreateViewModificationData> {
 	constructor(private readonly data: CreateViewModificationData, private readonly schema: Schema) {}
@@ -22,9 +22,10 @@ export class CreateViewModificationHandler implements ModificationHandler<Create
 			entities: {
 				...model.entities,
 				[this.data.entity.name]: {
-					indexes: {},
 					eventLog: { enabled: true }, // not relevant here...
 					...this.data.entity,
+					unique: Object.values(this.data.entity.unique),
+					indexes: Object.values(this.data.entity.indexes ?? []),
 				},
 			},
 		}))
@@ -68,5 +69,5 @@ export class CreateViewDiffer implements Differ {
 }
 
 export interface CreateViewModificationData {
-	entity: PartialEntity
+	entity: PossibleEntityShapeInMigrations
 }

package/src/modifications/entities/RemoveEntityModification.ts

@@ -14,22 +14,21 @@ import {
 import {
 	createModificationType,
 	Differ,
-	ModificationHandler,
+	ModificationHandler, ModificationHandlerCreateSqlOptions,
 	ModificationHandlerOptions,
 } from '../ModificationHandler'
 import { VERSION_ACL_PATCH, VERSION_REMOVE_REFERENCING_RELATIONS } from '../ModificationVersions'
 import { isRelation, PredicateDefinitionProcessor } from '@contember/schema-utils'
 import { removeFieldModification } from '../fields'
-import { SchemaWithMeta } from '../utils/schemaMeta'
 
 export class RemoveEntityModificationHandler implements ModificationHandler<RemoveEntityModificationData> {
 	constructor(
 		private readonly data: RemoveEntityModificationData,
-		private readonly schema: SchemaWithMeta,
+		private readonly schema: Schema,
 		private readonly options: ModificationHandlerOptions,
 	) {}
 
-	public createSql(builder: MigrationBuilder): void {
+	public createSql(builder: MigrationBuilder, options: ModificationHandlerCreateSqlOptions): void {
 		const entity = this.schema.model.entities[this.data.entityName]
 		if (entity.view) {
 			builder.dropView(entity.tableName)
@@ -37,7 +36,8 @@ export class RemoveEntityModificationHandler implements ModificationHandler<Remo
 		}
 		if (this.options.formatVersion >= VERSION_REMOVE_REFERENCING_RELATIONS) {
 			this.getFieldsToRemove(this.schema).forEach(([entityName, fieldName]) => {
-				removeFieldModification.createHandler({ entityName, fieldName }, this.schema, this.options).createSql(builder)
+				const removeFieldHandler = removeFieldModification.createHandler({ entityName, fieldName }, this.schema, this.options)
+				removeFieldHandler.createSql(builder, options)
 			})
 		}
 		builder.dropTable(entity.tableName)

package/src/modifications/entities/ToggleEventLogModification.ts

@@ -5,6 +5,7 @@ import {
 	createModificationType,
 	Differ,
 	ModificationHandler,
+	ModificationHandlerCreateSqlOptions,
 	ModificationHandlerOptions,
 } from '../ModificationHandler'
 import {
@@ -23,14 +24,14 @@ export class ToggleEventLogModificationHandler implements ModificationHandler<To
 	) {
 	}
 
-	public createSql(builder: MigrationBuilder): void {
+	public createSql(builder: MigrationBuilder, { systemSchema }: ModificationHandlerCreateSqlOptions): void {
 		const entity = this.schema.model.entities[this.data.entityName]
 		if (entity.view) {
 			return
 		}
 		if (this.data.enabled) {
-			createEventTrigger(builder, this.options.systemSchema, entity.tableName, [entity.primaryColumn])
-			createEventTrxTrigger(builder, this.options.systemSchema, entity.tableName)
+			createEventTrigger(builder, systemSchema, entity.tableName, [entity.primaryColumn])
+			createEventTrxTrigger(builder, systemSchema, entity.tableName)
 		} else {
 			dropEventTrigger(builder, entity.tableName)
 			dropEventTrxTrigger(builder, entity.tableName)

package/src/modifications/entities/UpdateEntityNameModification.ts

@@ -5,28 +5,29 @@ import {
 	updateAcl,
 	updateAclEntities,
 	updateAclEveryRole,
-	updateEntity,
 	updateEveryEntity,
 	updateEveryField,
 	updateModel,
 	updateSchema,
 } from '../utils/schemaUpdateUtils'
-import { createModificationType, ModificationHandler, ModificationHandlerOptions } from '../ModificationHandler'
+import {
+	createModificationType,
+	ModificationHandler,
+	ModificationHandlerCreateSqlOptions,
+	ModificationHandlerOptions,
+} from '../ModificationHandler'
 import { isIt } from '../../utils/isIt'
-import { VERSION_ACL_PATCH, VERSION_UPDATE_CONSTRAINT_NAME } from '../ModificationVersions'
-import { NamingHelper } from '@contember/schema-utils'
+import { VERSION_ACL_PATCH } from '../ModificationVersions'
 import { NoopModification } from '../NoopModification'
-import { renameConstraintSchemaUpdater, renameConstraintsSqlBuilder } from '../utils/renameConstraintsHelper'
 import { changeValue } from '../utils/valueUtils'
 import { updateEntityTableNameModification } from './UpdateEntityTableNameModification'
-import { SchemaWithMeta } from '../utils/schemaMeta'
 
 export class UpdateEntityNameModificationHandler implements ModificationHandler<UpdateEntityNameModificationData> {
 	private subModification: ModificationHandler<any>
 
 	constructor(
 		private readonly data: UpdateEntityNameModificationData,
-		private readonly schema: SchemaWithMeta,
+		private readonly schema: Schema,
 		private readonly options: ModificationHandlerOptions,
 	) {
 		this.subModification = data.tableName
@@ -38,12 +39,8 @@ export class UpdateEntityNameModificationHandler implements ModificationHandler<
 			: new NoopModification()
 	}
 
-	public createSql(builder: MigrationBuilder): void {
-		const entity = this.schema.model.entities[this.data.entityName]
-		if (!entity.view && this.options.formatVersion >= VERSION_UPDATE_CONSTRAINT_NAME) {
-			renameConstraintsSqlBuilder(builder, entity, this.getNewConstraintName.bind(this))
-		}
-		this.subModification.createSql(builder)
+	public createSql(builder: MigrationBuilder, options: ModificationHandlerCreateSqlOptions): void {
+		this.subModification.createSql(builder, options)
 	}
 
 	public getSchemaUpdater(): SchemaUpdater {
@@ -58,9 +55,6 @@ export class UpdateEntityNameModificationHandler implements ModificationHandler<
 						return field
 					}),
 				),
-				this.options.formatVersion >= VERSION_UPDATE_CONSTRAINT_NAME
-					? updateEntity(this.data.entityName, renameConstraintSchemaUpdater(this.getNewConstraintName.bind(this)))
-					: undefined,
 				({ model }) => {
 					const { [this.data.entityName]: renamed, ...entities } = model.entities
 					const newEntities = {
@@ -112,15 +106,6 @@ export class UpdateEntityNameModificationHandler implements ModificationHandler<
 		)
 	}
 
-	private getNewConstraintName(constraint: Model.UniqueConstraint): string | null {
-		const generatedName = NamingHelper.createUniqueConstraintName(this.data.entityName, constraint.fields)
-		const isGenerated = constraint.name === generatedName
-		if (!isGenerated) {
-			null
-		}
-		return NamingHelper.createUniqueConstraintName(this.data.newEntityName, constraint.fields)
-	}
-
 	describe() {
 		return { message: `Change entity name from ${this.data.entityName} to ${this.data.newEntityName}` }
 	}

package/src/modifications/entities/UpdateEntityOrderByModification.ts

@@ -0,0 +1,68 @@
+import { MigrationBuilder } from '@contember/database-migrations'
+import { Model, Schema } from '@contember/schema'
+import { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'
+import { createModificationType, Differ, ModificationHandler } from '../ModificationHandler'
+import deepEqual from 'fast-deep-equal'
+
+export class UpdateEntityOrderByModificationHandler implements ModificationHandler<UpdateEntityOrderByModificationData> {
+
+	constructor(private readonly data: UpdateEntityOrderByModificationData, private readonly schema: Schema) { }
+
+	public createSql(builder: MigrationBuilder): void { }
+
+	public getSchemaUpdater(): SchemaUpdater {
+		const { entityName, orderBy } = this.data
+		return updateModel(
+			updateEntity(entityName, ({ entity }) => {
+				if (orderBy) {
+					return {
+						...entity,
+						orderBy,
+					}
+				}
+				const { orderBy: _, ...rest } = entity
+				return rest
+			}),
+		)
+	}
+
+	describe() {
+		return { message: `Update order-by of entity ${this.data.entityName}` }
+	}
+}
+
+export interface UpdateEntityOrderByModificationData {
+	entityName: string
+	orderBy?: readonly Model.OrderBy[]
+}
+
+export const updateEntityOrderByModification = createModificationType({
+	id: 'updateEntityOrderBy',
+	handler: UpdateEntityOrderByModificationHandler,
+})
+
+export class UpdateEntityOrderByDiffer implements Differ {
+	createDiff(originalSchema: Schema, updatedSchema: Schema) {
+		return Object.values(updatedSchema.model.entities)
+			.flatMap(updatedEntity => {
+				const origEntity = originalSchema.model.entities[updatedEntity.name]
+				if (!origEntity) {
+					return []
+				}
+
+				if (!deepEqual(updatedEntity.orderBy ?? [], origEntity.orderBy ?? [])) {
+					if (updatedEntity.orderBy) {
+						return [updateEntityOrderByModification.createModification({
+							entityName: updatedEntity.name,
+							orderBy: updatedEntity.orderBy,
+						})]
+					}
+					return [updateEntityOrderByModification.createModification({
+						entityName: updatedEntity.name,
+					})]
+				}
+				return []
+			})
+
+	}
+}

package/src/modifications/entities/index.ts

@@ -4,3 +4,4 @@ export * from './RemoveEntityModification'
 export * from './ToggleEventLogModification'
 export * from './UpdateEntityNameModification'
 export * from './UpdateEntityTableNameModification'
+export * from './UpdateEntityOrderByModification'

package/src/modifications/fields/RemoveFieldModification.ts

@@ -1,4 +1,4 @@
-import { acceptFieldVisitor, isInverseRelation, isRelation, NamingHelper } from '@contember/schema-utils'
+import { acceptFieldVisitor, isInverseRelation, isRelation } from '@contember/schema-utils'
 import { MigrationBuilder } from '@contember/database-migrations'
 import { Schema } from '@contember/schema'
 import { removeField, SchemaUpdater } from '../utils/schemaUpdateUtils'