@contember/schema-migrations 2.1.0-beta.2 → 2.2.0-alpha.1

package/dist/development/src/modifications/indexes/CreateIndexModification.cjs

@@ -15,16 +15,25 @@ class CreateIndexModificationHandler {
     if (entity.view && !entity.view.materialized) {
       return;
     }
-    const fields = this.data.index.fields;
+    const index = this.data.index;
     const columns = utils.getIndexColumns({
-      fields,
+      fields: index.fields,
       entity,
       model: this.schema.model
     });
     const tableNameId = dbHelpers.wrapIdentifier(entity.tableName);
-    const columnNameIds = columns.map(dbHelpers.wrapIdentifier);
-    const methodClause = this.data.index.method ? ` USING ${this.data.index.method}` : "";
-    builder.sql(`CREATE INDEX ON ${tableNameId}${methodClause} (${columnNameIds.join(", ")})`);
+    const columnNameIds = index.fields.map((field, i) => {
+      const options = index.columnOptions?.[field];
+      const opClass = options?.opClass ?? index.opClass;
+      const opClassSuffix = opClass ? ` ${opClass}` : "";
+      const orderSuffix = options?.order === "desc" ? " DESC" : "";
+      const nullsSuffix = options?.nulls === "first" ? " NULLS FIRST" : options?.nulls === "last" ? " NULLS LAST" : "";
+      return dbHelpers.wrapIdentifier(columns[i]) + opClassSuffix + orderSuffix + nullsSuffix;
+    });
+    const methodClause = index.method ? ` USING ${index.method}` : "";
+    const includeClause = index.include?.length ? ` INCLUDE (${utils.getIndexColumns({ fields: index.include, entity, model: this.schema.model }).map(dbHelpers.wrapIdentifier).join(", ")})` : "";
+    const whereClause = index.where ? ` WHERE (${index.where})` : "";
+    builder.sql(`CREATE INDEX ON ${tableNameId}${methodClause} (${columnNameIds.join(", ")})${includeClause}${whereClause}`);
     invalidateDatabaseMetadata();
   }
   getSchemaUpdater() {
@@ -39,9 +48,16 @@ class CreateIndexModificationHandler {
     );
   }
   describe() {
-    const methodText = this.data.index.method ? ` using ${this.data.index.method}` : "";
+    const index = this.data.index;
+    const methodText = index.method ? ` using ${index.method}` : "";
+    const includeText = index.include?.length ? ` include (${index.include.join(", ")})` : "";
+    const whereText = index.where ? ` where ${index.where}` : "";
+    const columnOptionsText = index.columnOptions && Object.keys(index.columnOptions).length > 0 ? ` options (${Object.entries(index.columnOptions).map(([field, opts]) => {
+      const parts = [opts.order, opts.nulls ? `nulls ${opts.nulls}` : "", opts.opClass ? `opclass ${opts.opClass}` : ""].filter(Boolean);
+      return `${field}: ${parts.join(" ")}`;
+    }).join(", ")})` : "";
     return {
-      message: `Create index(${this.data.index.fields.join(", ")})${methodText} on entity ${this.data.entityName}`
+      message: `Create index(${index.fields.join(", ")})${methodText}${includeText}${whereText}${columnOptionsText} on entity ${this.data.entityName}`
     };
   }
 }

package/dist/development/src/modifications/indexes/CreateIndexModification.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"CreateIndexModification.cjs","sources":["../../../../../../packages/schema-migrations/src/modifications/indexes/CreateIndexModification.ts"],"sourcesContent":["import { MigrationBuilder } from '@contember/database-migrations'\nimport { Model, Schema } from '@contember/schema'\nimport { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'\nimport { createModificationType, Differ, ModificationHandler, ModificationHandlerCreateSqlOptions } from '../ModificationHandler'\nimport { wrapIdentifier } from '../../utils/dbHelpers'\nimport { getIndexColumns } from './utils'\nimport deepEqual from 'fast-deep-equal'\n\nexport class CreateIndexModificationHandler implements ModificationHandler<CreateIndexModificationData> {\n\tconstructor(private readonly data: CreateIndexModificationData, private readonly schema: Schema) {}\n\n\tpublic createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tif (entity.view && !entity.view.materialized) {\n\t\t\treturn\n\t\t}\n\t\tconst fields = this.data.index.fields\n\t\tconst columns = getIndexColumns({\n\t\t\tfields,\n\t\t\tentity,\n\t\t\tmodel: this.schema.model,\n\t\t})\n\n\t\tconst tableNameId = wrapIdentifier(entity.tableName)\n\t\tconst columnNameIds = columns.map(wrapIdentifier)\n\t\tconst methodClause = this.data.index.method ? ` USING ${this.data.index.method}` : ''\n\n\t\tbuilder.sql(`CREATE INDEX ON ${tableNameId}${methodClause} (${columnNameIds.join(', ')})`)\n\n\t\tinvalidateDatabaseMetadata()\n\t}\n\n\tpublic getSchemaUpdater(): SchemaUpdater {\n\t\treturn updateModel(\n\t\t\tupdateEntity(this.data.entityName, ({ entity }) => ({\n\t\t\t\t...entity,\n\t\t\t\tindexes: [\n\t\t\t\t\t...entity.indexes,\n\t\t\t\t\tthis.data.index,\n\t\t\t\t],\n\t\t\t})),\n\t\t)\n\t}\n\n\tdescribe() {\n\t\tconst methodText = this.data.index.method ? ` using ${this.data.index.method}` : ''\n\t\treturn {\n\t\t\tmessage: `Create index(${this.data.index.fields.join(', ')})${methodText} on entity ${this.data.entityName}`,\n\t\t}\n\t}\n}\n\nexport const createIndexModification = createModificationType({\n\tid: 'createIndex',\n\thandler: CreateIndexModificationHandler,\n})\n\nexport interface CreateIndexModificationData {\n\tentityName: string\n\tindex: Model.Index\n}\n\nexport class CreateIndexDiffer implements Differ {\n\tcreateDiff(originalSchema: Schema, updatedSchema: Schema) {\n\t\treturn Object.values(updatedSchema.model.entities).flatMap(entity =>\n\t\t\tentity.indexes\n\t\t\t\t.filter(it => !originalSchema.model.entities[entity.name].indexes.find(idx => deepEqual(idx, it)))\n\t\t\t\t.map(index =>\n\t\t\t\t\tcreateIndexModification.createModification({\n\t\t\t\t\t\tentityName: entity.name,\n\t\t\t\t\t\tindex,\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t)\n\t}\n}\n"],"names":["getIndexColumns","wrapIdentifier","updateModel","updateEntity","createModificationType"],"mappings":";;;;;;;AAQO,MAAM,+BAA2F;AAAA,EACvG,YAA6B,MAAoD,QAAgB;AAApE,SAAA,OAAA;AAAoD,SAAA,SAAA;AAAA,EAAiB;AAAA,EAE3F,UAAU,SAA2B,EAAE,kBAAkB,8BAAyE;AACxI,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,QAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,cAAc;AAC7C;AAAA,IACD;AACA,UAAM,SAAS,KAAK,KAAK,MAAM;AAC/B,UAAM,UAAUA,MAAAA,gBAAgB;AAAA,MAC/B;AAAA,MACA;AAAA,MACA,OAAO,KAAK,OAAO;AAAA,IAAA,CACnB;AAED,UAAM,cAAcC,UAAAA,eAAe,OAAO,SAAS;AACnD,UAAM,gBAAgB,QAAQ,IAAIA,wBAAc;AAChD,UAAM,eAAe,KAAK,KAAK,MAAM,SAAS,UAAU,KAAK,KAAK,MAAM,MAAM,KAAK;AAEnF,YAAQ,IAAI,mBAAmB,WAAW,GAAG,YAAY,KAAK,cAAc,KAAK,IAAI,CAAC,GAAG;AAEzF,+BAAA;AAAA,EACD;AAAA,EAEO,mBAAkC;AACxC,WAAOC,kBAAAA;AAAAA,MACNC,kBAAAA,aAAa,KAAK,KAAK,YAAY,CAAC,EAAE,cAAc;AAAA,QACnD,GAAG;AAAA,QACH,SAAS;AAAA,UACR,GAAG,OAAO;AAAA,UACV,KAAK,KAAK;AAAA,QAAA;AAAA,MACX,EACC;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,WAAW;AACV,UAAM,aAAa,KAAK,KAAK,MAAM,SAAS,UAAU,KAAK,KAAK,MAAM,MAAM,KAAK;AACjF,WAAO;AAAA,MACN,SAAS,gBAAgB,KAAK,KAAK,MAAM,OAAO,KAAK,IAAI,CAAC,IAAI,UAAU,cAAc,KAAK,KAAK,UAAU;AAAA,IAAA;AAAA,EAE5G;AACD;AAEO,MAAM,0BAA0BC,oBAAAA,uBAAuB;AAAA,EAC7D,IAAI;AAAA,EACJ,SAAS;AACV,CAAC;AAOM,MAAM,kBAAoC;AAAA,EAChD,WAAW,gBAAwB,eAAuB;AACzD,WAAO,OAAO,OAAO,cAAc,MAAM,QAAQ,EAAE;AAAA,MAAQ,CAAA,WAC1D,OAAO,QACL,OAAO,QAAM,CAAC,eAAe,MAAM,SAAS,OAAO,IAAI,EAAE,QAAQ,KAAK,CAAA,QAAO,UAAU,KAAK,EAAE,CAAC,CAAC,EAChG;AAAA,QAAI,CAAA,UACJ,wBAAwB,mBAAmB;AAAA,UAC1C,YAAY,OAAO;AAAA,UACnB;AAAA,QAAA,CACA;AAAA,MAAA;AAAA,IACF;AAAA,EAEH;AACD;;;;"}
+{"version":3,"file":"CreateIndexModification.cjs","sources":["../../../../../../packages/schema-migrations/src/modifications/indexes/CreateIndexModification.ts"],"sourcesContent":["import { MigrationBuilder } from '@contember/database-migrations'\nimport { Model, Schema } from '@contember/schema'\nimport { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils.js'\nimport { createModificationType, Differ, ModificationHandler, ModificationHandlerCreateSqlOptions } from '../ModificationHandler.js'\nimport { wrapIdentifier } from '../../utils/dbHelpers.js'\nimport { getIndexColumns } from './utils.js'\nimport deepEqual from 'fast-deep-equal'\n\nexport class CreateIndexModificationHandler implements ModificationHandler<CreateIndexModificationData> {\n\tconstructor(private readonly data: CreateIndexModificationData, private readonly schema: Schema) {}\n\n\tpublic createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tif (entity.view && !entity.view.materialized) {\n\t\t\treturn\n\t\t}\n\t\tconst index = this.data.index\n\t\tconst columns = getIndexColumns({\n\t\t\tfields: index.fields,\n\t\t\tentity,\n\t\t\tmodel: this.schema.model,\n\t\t})\n\n\t\tconst tableNameId = wrapIdentifier(entity.tableName)\n\t\t// Each key column may carry its own operator class (falling back to the global opClass),\n\t\t// sort direction (ASC is the default and omitted) and NULLS placement. Postgres expects\n\t\t// the parts in this order: column [opclass] [ASC|DESC] [NULLS {FIRST|LAST}].\n\t\t// The opclass is emitted verbatim (validated to an identifier shape in ModelValidator). Migrations\n\t\t// run with search_path set to the stage schema, so the value must already carry any needed schema\n\t\t// qualifier: an extension's class as \"public.gin_trgm_ops\", a built-in one (in pg_catalog) as\n\t\t// plain \"text_pattern_ops\".\n\t\tconst columnNameIds = index.fields.map((field, i) => {\n\t\t\tconst options = index.columnOptions?.[field]\n\t\t\tconst opClass = options?.opClass ?? index.opClass\n\t\t\tconst opClassSuffix = opClass ? ` ${opClass}` : ''\n\t\t\tconst orderSuffix = options?.order === 'desc' ? ' DESC' : ''\n\t\t\tconst nullsSuffix = options?.nulls === 'first' ? ' NULLS FIRST' : options?.nulls === 'last' ? ' NULLS LAST' : ''\n\t\t\treturn wrapIdentifier(columns[i]) + opClassSuffix + orderSuffix + nullsSuffix\n\t\t})\n\t\tconst methodClause = index.method ? ` USING ${index.method}` : ''\n\n\t\tconst includeClause = index.include?.length\n\t\t\t? ` INCLUDE (${getIndexColumns({ fields: index.include, entity, model: this.schema.model }).map(wrapIdentifier).join(', ')})`\n\t\t\t: ''\n\t\t// `where` is a raw, developer-authored SQL predicate. Its trust boundary is identical to\n\t\t// @c.View's raw body — committed to a migration and gated by code review, not end-user input.\n\t\t// Its shape is validated in ModelValidator (non-empty, no statement terminator); here we only\n\t\t// wrap it in parentheses so it stays a self-contained boolean expression.\n\t\tconst whereClause = index.where ? ` WHERE (${index.where})` : ''\n\n\t\tbuilder.sql(`CREATE INDEX ON ${tableNameId}${methodClause} (${columnNameIds.join(', ')})${includeClause}${whereClause}`)\n\n\t\tinvalidateDatabaseMetadata()\n\t}\n\n\tpublic getSchemaUpdater(): SchemaUpdater {\n\t\treturn updateModel(\n\t\t\tupdateEntity(this.data.entityName, ({ entity }) => ({\n\t\t\t\t...entity,\n\t\t\t\tindexes: [\n\t\t\t\t\t...entity.indexes,\n\t\t\t\t\tthis.data.index,\n\t\t\t\t],\n\t\t\t})),\n\t\t)\n\t}\n\n\tdescribe() {\n\t\tconst index = this.data.index\n\t\tconst methodText = index.method ? ` using ${index.method}` : ''\n\t\tconst includeText = index.include?.length ? ` include (${index.include.join(', ')})` : ''\n\t\tconst whereText = index.where ? ` where ${index.where}` : ''\n\t\t// columnOptions is part of index identity, so surface it in the description too — otherwise two\n\t\t// indexes on the same columns differing only by sort order / NULLS / opClass render identically.\n\t\tconst columnOptionsText = index.columnOptions && Object.keys(index.columnOptions).length > 0\n\t\t\t? ` options (${\n\t\t\t\tObject.entries(index.columnOptions).map(([field, opts]) => {\n\t\t\t\t\tconst parts = [opts.order, opts.nulls ? `nulls ${opts.nulls}` : '', opts.opClass ? `opclass ${opts.opClass}` : ''].filter(Boolean)\n\t\t\t\t\treturn `${field}: ${parts.join(' ')}`\n\t\t\t\t}).join(', ')\n\t\t\t})`\n\t\t\t: ''\n\t\treturn {\n\t\t\tmessage: `Create index(${index.fields.join(', ')})${methodText}${includeText}${whereText}${columnOptionsText} on entity ${this.data.entityName}`,\n\t\t}\n\t}\n}\n\nexport const createIndexModification = createModificationType({\n\tid: 'createIndex',\n\thandler: CreateIndexModificationHandler,\n})\n\nexport interface CreateIndexModificationData {\n\tentityName: string\n\tindex: Model.Index\n}\n\nexport class CreateIndexDiffer implements Differ {\n\tcreateDiff(originalSchema: Schema, updatedSchema: Schema) {\n\t\treturn Object.values(updatedSchema.model.entities).flatMap(entity =>\n\t\t\tentity.indexes\n\t\t\t\t.filter(it => !originalSchema.model.entities[entity.name].indexes.find(idx => deepEqual(idx, it)))\n\t\t\t\t.map(index =>\n\t\t\t\t\tcreateIndexModification.createModification({\n\t\t\t\t\t\tentityName: entity.name,\n\t\t\t\t\t\tindex,\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t)\n\t}\n}\n"],"names":["getIndexColumns","wrapIdentifier","updateModel","updateEntity","createModificationType"],"mappings":";;;;;;;AAQO,MAAM,+BAA2F;AAAA,EACvG,YAA6B,MAAoD,QAAgB;AAApE,SAAA,OAAA;AAAoD,SAAA,SAAA;AAAA,EAAiB;AAAA,EAE3F,UAAU,SAA2B,EAAE,kBAAkB,8BAAyE;AACxI,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,QAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,cAAc;AAC7C;AAAA,IACD;AACA,UAAM,QAAQ,KAAK,KAAK;AACxB,UAAM,UAAUA,MAAAA,gBAAgB;AAAA,MAC/B,QAAQ,MAAM;AAAA,MACd;AAAA,MACA,OAAO,KAAK,OAAO;AAAA,IAAA,CACnB;AAED,UAAM,cAAcC,UAAAA,eAAe,OAAO,SAAS;AAQnD,UAAM,gBAAgB,MAAM,OAAO,IAAI,CAAC,OAAO,MAAM;AACpD,YAAM,UAAU,MAAM,gBAAgB,KAAK;AAC3C,YAAM,UAAU,SAAS,WAAW,MAAM;AAC1C,YAAM,gBAAgB,UAAU,IAAI,OAAO,KAAK;AAChD,YAAM,cAAc,SAAS,UAAU,SAAS,UAAU;AAC1D,YAAM,cAAc,SAAS,UAAU,UAAU,iBAAiB,SAAS,UAAU,SAAS,gBAAgB;AAC9G,aAAOA,UAAAA,eAAe,QAAQ,CAAC,CAAC,IAAI,gBAAgB,cAAc;AAAA,IACnE,CAAC;AACD,UAAM,eAAe,MAAM,SAAS,UAAU,MAAM,MAAM,KAAK;AAE/D,UAAM,gBAAgB,MAAM,SAAS,SAClC,aAAaD,MAAAA,gBAAgB,EAAE,QAAQ,MAAM,SAAS,QAAQ,OAAO,KAAK,OAAO,MAAA,CAAO,EAAE,IAAIC,wBAAc,EAAE,KAAK,IAAI,CAAC,MACxH;AAKH,UAAM,cAAc,MAAM,QAAQ,WAAW,MAAM,KAAK,MAAM;AAE9D,YAAQ,IAAI,mBAAmB,WAAW,GAAG,YAAY,KAAK,cAAc,KAAK,IAAI,CAAC,IAAI,aAAa,GAAG,WAAW,EAAE;AAEvH,+BAAA;AAAA,EACD;AAAA,EAEO,mBAAkC;AACxC,WAAOC,kBAAAA;AAAAA,MACNC,kBAAAA,aAAa,KAAK,KAAK,YAAY,CAAC,EAAE,cAAc;AAAA,QACnD,GAAG;AAAA,QACH,SAAS;AAAA,UACR,GAAG,OAAO;AAAA,UACV,KAAK,KAAK;AAAA,QAAA;AAAA,MACX,EACC;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,WAAW;AACV,UAAM,QAAQ,KAAK,KAAK;AACxB,UAAM,aAAa,MAAM,SAAS,UAAU,MAAM,MAAM,KAAK;AAC7D,UAAM,cAAc,MAAM,SAAS,SAAS,aAAa,MAAM,QAAQ,KAAK,IAAI,CAAC,MAAM;AACvF,UAAM,YAAY,MAAM,QAAQ,UAAU,MAAM,KAAK,KAAK;AAG1D,UAAM,oBAAoB,MAAM,iBAAiB,OAAO,KAAK,MAAM,aAAa,EAAE,SAAS,IACxF,aACD,OAAO,QAAQ,MAAM,aAAa,EAAE,IAAI,CAAC,CAAC,OAAO,IAAI,MAAM;AAC1D,YAAM,QAAQ,CAAC,KAAK,OAAO,KAAK,QAAQ,SAAS,KAAK,KAAK,KAAK,IAAI,KAAK,UAAU,WAAW,KAAK,OAAO,KAAK,EAAE,EAAE,OAAO,OAAO;AACjI,aAAO,GAAG,KAAK,KAAK,MAAM,KAAK,GAAG,CAAC;AAAA,IACpC,CAAC,EAAE,KAAK,IAAI,CACb,MACE;AACH,WAAO;AAAA,MACN,SAAS,gBAAgB,MAAM,OAAO,KAAK,IAAI,CAAC,IAAI,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,iBAAiB,cAAc,KAAK,KAAK,UAAU;AAAA,IAAA;AAAA,EAEhJ;AACD;AAEO,MAAM,0BAA0BC,oBAAAA,uBAAuB;AAAA,EAC7D,IAAI;AAAA,EACJ,SAAS;AACV,CAAC;AAOM,MAAM,kBAAoC;AAAA,EAChD,WAAW,gBAAwB,eAAuB;AACzD,WAAO,OAAO,OAAO,cAAc,MAAM,QAAQ,EAAE;AAAA,MAAQ,CAAA,WAC1D,OAAO,QACL,OAAO,QAAM,CAAC,eAAe,MAAM,SAAS,OAAO,IAAI,EAAE,QAAQ,KAAK,CAAA,QAAO,UAAU,KAAK,EAAE,CAAC,CAAC,EAChG;AAAA,QAAI,CAAA,UACJ,wBAAwB,mBAAmB;AAAA,UAC1C,YAAY,OAAO;AAAA,UACnB;AAAA,QAAA,CACA;AAAA,MAAA;AAAA,IACF;AAAA,EAEH;AACD;;;;"}

package/dist/development/src/modifications/indexes/CreateIndexModification.js

@@ -13,16 +13,25 @@ class CreateIndexModificationHandler {
     if (entity.view && !entity.view.materialized) {
       return;
     }
-    const fields = this.data.index.fields;
+    const index = this.data.index;
     const columns = getIndexColumns({
-      fields,
+      fields: index.fields,
       entity,
       model: this.schema.model
     });
     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}${methodClause} (${columnNameIds.join(", ")})`);
+    const columnNameIds = index.fields.map((field, i) => {
+      const options = index.columnOptions?.[field];
+      const opClass = options?.opClass ?? index.opClass;
+      const opClassSuffix = opClass ? ` ${opClass}` : "";
+      const orderSuffix = options?.order === "desc" ? " DESC" : "";
+      const nullsSuffix = options?.nulls === "first" ? " NULLS FIRST" : options?.nulls === "last" ? " NULLS LAST" : "";
+      return wrapIdentifier(columns[i]) + opClassSuffix + orderSuffix + nullsSuffix;
+    });
+    const methodClause = index.method ? ` USING ${index.method}` : "";
+    const includeClause = index.include?.length ? ` INCLUDE (${getIndexColumns({ fields: index.include, entity, model: this.schema.model }).map(wrapIdentifier).join(", ")})` : "";
+    const whereClause = index.where ? ` WHERE (${index.where})` : "";
+    builder.sql(`CREATE INDEX ON ${tableNameId}${methodClause} (${columnNameIds.join(", ")})${includeClause}${whereClause}`);
     invalidateDatabaseMetadata();
   }
   getSchemaUpdater() {
@@ -37,9 +46,16 @@ class CreateIndexModificationHandler {
     );
   }
   describe() {
-    const methodText = this.data.index.method ? ` using ${this.data.index.method}` : "";
+    const index = this.data.index;
+    const methodText = index.method ? ` using ${index.method}` : "";
+    const includeText = index.include?.length ? ` include (${index.include.join(", ")})` : "";
+    const whereText = index.where ? ` where ${index.where}` : "";
+    const columnOptionsText = index.columnOptions && Object.keys(index.columnOptions).length > 0 ? ` options (${Object.entries(index.columnOptions).map(([field, opts]) => {
+      const parts = [opts.order, opts.nulls ? `nulls ${opts.nulls}` : "", opts.opClass ? `opclass ${opts.opClass}` : ""].filter(Boolean);
+      return `${field}: ${parts.join(" ")}`;
+    }).join(", ")})` : "";
     return {
-      message: `Create index(${this.data.index.fields.join(", ")})${methodText} on entity ${this.data.entityName}`
+      message: `Create index(${index.fields.join(", ")})${methodText}${includeText}${whereText}${columnOptionsText} on entity ${this.data.entityName}`
     };
   }
 }

package/dist/development/src/modifications/indexes/CreateIndexModification.js.map

@@ -1 +1 @@
-{"version":3,"file":"CreateIndexModification.js","sources":["../../../../../../packages/schema-migrations/src/modifications/indexes/CreateIndexModification.ts"],"sourcesContent":["import { MigrationBuilder } from '@contember/database-migrations'\nimport { Model, Schema } from '@contember/schema'\nimport { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'\nimport { createModificationType, Differ, ModificationHandler, ModificationHandlerCreateSqlOptions } from '../ModificationHandler'\nimport { wrapIdentifier } from '../../utils/dbHelpers'\nimport { getIndexColumns } from './utils'\nimport deepEqual from 'fast-deep-equal'\n\nexport class CreateIndexModificationHandler implements ModificationHandler<CreateIndexModificationData> {\n\tconstructor(private readonly data: CreateIndexModificationData, private readonly schema: Schema) {}\n\n\tpublic createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tif (entity.view && !entity.view.materialized) {\n\t\t\treturn\n\t\t}\n\t\tconst fields = this.data.index.fields\n\t\tconst columns = getIndexColumns({\n\t\t\tfields,\n\t\t\tentity,\n\t\t\tmodel: this.schema.model,\n\t\t})\n\n\t\tconst tableNameId = wrapIdentifier(entity.tableName)\n\t\tconst columnNameIds = columns.map(wrapIdentifier)\n\t\tconst methodClause = this.data.index.method ? ` USING ${this.data.index.method}` : ''\n\n\t\tbuilder.sql(`CREATE INDEX ON ${tableNameId}${methodClause} (${columnNameIds.join(', ')})`)\n\n\t\tinvalidateDatabaseMetadata()\n\t}\n\n\tpublic getSchemaUpdater(): SchemaUpdater {\n\t\treturn updateModel(\n\t\t\tupdateEntity(this.data.entityName, ({ entity }) => ({\n\t\t\t\t...entity,\n\t\t\t\tindexes: [\n\t\t\t\t\t...entity.indexes,\n\t\t\t\t\tthis.data.index,\n\t\t\t\t],\n\t\t\t})),\n\t\t)\n\t}\n\n\tdescribe() {\n\t\tconst methodText = this.data.index.method ? ` using ${this.data.index.method}` : ''\n\t\treturn {\n\t\t\tmessage: `Create index(${this.data.index.fields.join(', ')})${methodText} on entity ${this.data.entityName}`,\n\t\t}\n\t}\n}\n\nexport const createIndexModification = createModificationType({\n\tid: 'createIndex',\n\thandler: CreateIndexModificationHandler,\n})\n\nexport interface CreateIndexModificationData {\n\tentityName: string\n\tindex: Model.Index\n}\n\nexport class CreateIndexDiffer implements Differ {\n\tcreateDiff(originalSchema: Schema, updatedSchema: Schema) {\n\t\treturn Object.values(updatedSchema.model.entities).flatMap(entity =>\n\t\t\tentity.indexes\n\t\t\t\t.filter(it => !originalSchema.model.entities[entity.name].indexes.find(idx => deepEqual(idx, it)))\n\t\t\t\t.map(index =>\n\t\t\t\t\tcreateIndexModification.createModification({\n\t\t\t\t\t\tentityName: entity.name,\n\t\t\t\t\t\tindex,\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t)\n\t}\n}\n"],"names":[],"mappings":";;;;;AAQO,MAAM,+BAA2F;AAAA,EACvG,YAA6B,MAAoD,QAAgB;AAApE,SAAA,OAAA;AAAoD,SAAA,SAAA;AAAA,EAAiB;AAAA,EAE3F,UAAU,SAA2B,EAAE,kBAAkB,8BAAyE;AACxI,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,QAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,cAAc;AAC7C;AAAA,IACD;AACA,UAAM,SAAS,KAAK,KAAK,MAAM;AAC/B,UAAM,UAAU,gBAAgB;AAAA,MAC/B;AAAA,MACA;AAAA,MACA,OAAO,KAAK,OAAO;AAAA,IAAA,CACnB;AAED,UAAM,cAAc,eAAe,OAAO,SAAS;AACnD,UAAM,gBAAgB,QAAQ,IAAI,cAAc;AAChD,UAAM,eAAe,KAAK,KAAK,MAAM,SAAS,UAAU,KAAK,KAAK,MAAM,MAAM,KAAK;AAEnF,YAAQ,IAAI,mBAAmB,WAAW,GAAG,YAAY,KAAK,cAAc,KAAK,IAAI,CAAC,GAAG;AAEzF,+BAAA;AAAA,EACD;AAAA,EAEO,mBAAkC;AACxC,WAAO;AAAA,MACN,aAAa,KAAK,KAAK,YAAY,CAAC,EAAE,cAAc;AAAA,QACnD,GAAG;AAAA,QACH,SAAS;AAAA,UACR,GAAG,OAAO;AAAA,UACV,KAAK,KAAK;AAAA,QAAA;AAAA,MACX,EACC;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,WAAW;AACV,UAAM,aAAa,KAAK,KAAK,MAAM,SAAS,UAAU,KAAK,KAAK,MAAM,MAAM,KAAK;AACjF,WAAO;AAAA,MACN,SAAS,gBAAgB,KAAK,KAAK,MAAM,OAAO,KAAK,IAAI,CAAC,IAAI,UAAU,cAAc,KAAK,KAAK,UAAU;AAAA,IAAA;AAAA,EAE5G;AACD;AAEO,MAAM,0BAA0B,uBAAuB;AAAA,EAC7D,IAAI;AAAA,EACJ,SAAS;AACV,CAAC;AAOM,MAAM,kBAAoC;AAAA,EAChD,WAAW,gBAAwB,eAAuB;AACzD,WAAO,OAAO,OAAO,cAAc,MAAM,QAAQ,EAAE;AAAA,MAAQ,CAAA,WAC1D,OAAO,QACL,OAAO,QAAM,CAAC,eAAe,MAAM,SAAS,OAAO,IAAI,EAAE,QAAQ,KAAK,CAAA,QAAO,UAAU,KAAK,EAAE,CAAC,CAAC,EAChG;AAAA,QAAI,CAAA,UACJ,wBAAwB,mBAAmB;AAAA,UAC1C,YAAY,OAAO;AAAA,UACnB;AAAA,QAAA,CACA;AAAA,MAAA;AAAA,IACF;AAAA,EAEH;AACD;"}
+{"version":3,"file":"CreateIndexModification.js","sources":["../../../../../../packages/schema-migrations/src/modifications/indexes/CreateIndexModification.ts"],"sourcesContent":["import { MigrationBuilder } from '@contember/database-migrations'\nimport { Model, Schema } from '@contember/schema'\nimport { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils.js'\nimport { createModificationType, Differ, ModificationHandler, ModificationHandlerCreateSqlOptions } from '../ModificationHandler.js'\nimport { wrapIdentifier } from '../../utils/dbHelpers.js'\nimport { getIndexColumns } from './utils.js'\nimport deepEqual from 'fast-deep-equal'\n\nexport class CreateIndexModificationHandler implements ModificationHandler<CreateIndexModificationData> {\n\tconstructor(private readonly data: CreateIndexModificationData, private readonly schema: Schema) {}\n\n\tpublic createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tif (entity.view && !entity.view.materialized) {\n\t\t\treturn\n\t\t}\n\t\tconst index = this.data.index\n\t\tconst columns = getIndexColumns({\n\t\t\tfields: index.fields,\n\t\t\tentity,\n\t\t\tmodel: this.schema.model,\n\t\t})\n\n\t\tconst tableNameId = wrapIdentifier(entity.tableName)\n\t\t// Each key column may carry its own operator class (falling back to the global opClass),\n\t\t// sort direction (ASC is the default and omitted) and NULLS placement. Postgres expects\n\t\t// the parts in this order: column [opclass] [ASC|DESC] [NULLS {FIRST|LAST}].\n\t\t// The opclass is emitted verbatim (validated to an identifier shape in ModelValidator). Migrations\n\t\t// run with search_path set to the stage schema, so the value must already carry any needed schema\n\t\t// qualifier: an extension's class as \"public.gin_trgm_ops\", a built-in one (in pg_catalog) as\n\t\t// plain \"text_pattern_ops\".\n\t\tconst columnNameIds = index.fields.map((field, i) => {\n\t\t\tconst options = index.columnOptions?.[field]\n\t\t\tconst opClass = options?.opClass ?? index.opClass\n\t\t\tconst opClassSuffix = opClass ? ` ${opClass}` : ''\n\t\t\tconst orderSuffix = options?.order === 'desc' ? ' DESC' : ''\n\t\t\tconst nullsSuffix = options?.nulls === 'first' ? ' NULLS FIRST' : options?.nulls === 'last' ? ' NULLS LAST' : ''\n\t\t\treturn wrapIdentifier(columns[i]) + opClassSuffix + orderSuffix + nullsSuffix\n\t\t})\n\t\tconst methodClause = index.method ? ` USING ${index.method}` : ''\n\n\t\tconst includeClause = index.include?.length\n\t\t\t? ` INCLUDE (${getIndexColumns({ fields: index.include, entity, model: this.schema.model }).map(wrapIdentifier).join(', ')})`\n\t\t\t: ''\n\t\t// `where` is a raw, developer-authored SQL predicate. Its trust boundary is identical to\n\t\t// @c.View's raw body — committed to a migration and gated by code review, not end-user input.\n\t\t// Its shape is validated in ModelValidator (non-empty, no statement terminator); here we only\n\t\t// wrap it in parentheses so it stays a self-contained boolean expression.\n\t\tconst whereClause = index.where ? ` WHERE (${index.where})` : ''\n\n\t\tbuilder.sql(`CREATE INDEX ON ${tableNameId}${methodClause} (${columnNameIds.join(', ')})${includeClause}${whereClause}`)\n\n\t\tinvalidateDatabaseMetadata()\n\t}\n\n\tpublic getSchemaUpdater(): SchemaUpdater {\n\t\treturn updateModel(\n\t\t\tupdateEntity(this.data.entityName, ({ entity }) => ({\n\t\t\t\t...entity,\n\t\t\t\tindexes: [\n\t\t\t\t\t...entity.indexes,\n\t\t\t\t\tthis.data.index,\n\t\t\t\t],\n\t\t\t})),\n\t\t)\n\t}\n\n\tdescribe() {\n\t\tconst index = this.data.index\n\t\tconst methodText = index.method ? ` using ${index.method}` : ''\n\t\tconst includeText = index.include?.length ? ` include (${index.include.join(', ')})` : ''\n\t\tconst whereText = index.where ? ` where ${index.where}` : ''\n\t\t// columnOptions is part of index identity, so surface it in the description too — otherwise two\n\t\t// indexes on the same columns differing only by sort order / NULLS / opClass render identically.\n\t\tconst columnOptionsText = index.columnOptions && Object.keys(index.columnOptions).length > 0\n\t\t\t? ` options (${\n\t\t\t\tObject.entries(index.columnOptions).map(([field, opts]) => {\n\t\t\t\t\tconst parts = [opts.order, opts.nulls ? `nulls ${opts.nulls}` : '', opts.opClass ? `opclass ${opts.opClass}` : ''].filter(Boolean)\n\t\t\t\t\treturn `${field}: ${parts.join(' ')}`\n\t\t\t\t}).join(', ')\n\t\t\t})`\n\t\t\t: ''\n\t\treturn {\n\t\t\tmessage: `Create index(${index.fields.join(', ')})${methodText}${includeText}${whereText}${columnOptionsText} on entity ${this.data.entityName}`,\n\t\t}\n\t}\n}\n\nexport const createIndexModification = createModificationType({\n\tid: 'createIndex',\n\thandler: CreateIndexModificationHandler,\n})\n\nexport interface CreateIndexModificationData {\n\tentityName: string\n\tindex: Model.Index\n}\n\nexport class CreateIndexDiffer implements Differ {\n\tcreateDiff(originalSchema: Schema, updatedSchema: Schema) {\n\t\treturn Object.values(updatedSchema.model.entities).flatMap(entity =>\n\t\t\tentity.indexes\n\t\t\t\t.filter(it => !originalSchema.model.entities[entity.name].indexes.find(idx => deepEqual(idx, it)))\n\t\t\t\t.map(index =>\n\t\t\t\t\tcreateIndexModification.createModification({\n\t\t\t\t\t\tentityName: entity.name,\n\t\t\t\t\t\tindex,\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t)\n\t}\n}\n"],"names":[],"mappings":";;;;;AAQO,MAAM,+BAA2F;AAAA,EACvG,YAA6B,MAAoD,QAAgB;AAApE,SAAA,OAAA;AAAoD,SAAA,SAAA;AAAA,EAAiB;AAAA,EAE3F,UAAU,SAA2B,EAAE,kBAAkB,8BAAyE;AACxI,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,QAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,cAAc;AAC7C;AAAA,IACD;AACA,UAAM,QAAQ,KAAK,KAAK;AACxB,UAAM,UAAU,gBAAgB;AAAA,MAC/B,QAAQ,MAAM;AAAA,MACd;AAAA,MACA,OAAO,KAAK,OAAO;AAAA,IAAA,CACnB;AAED,UAAM,cAAc,eAAe,OAAO,SAAS;AAQnD,UAAM,gBAAgB,MAAM,OAAO,IAAI,CAAC,OAAO,MAAM;AACpD,YAAM,UAAU,MAAM,gBAAgB,KAAK;AAC3C,YAAM,UAAU,SAAS,WAAW,MAAM;AAC1C,YAAM,gBAAgB,UAAU,IAAI,OAAO,KAAK;AAChD,YAAM,cAAc,SAAS,UAAU,SAAS,UAAU;AAC1D,YAAM,cAAc,SAAS,UAAU,UAAU,iBAAiB,SAAS,UAAU,SAAS,gBAAgB;AAC9G,aAAO,eAAe,QAAQ,CAAC,CAAC,IAAI,gBAAgB,cAAc;AAAA,IACnE,CAAC;AACD,UAAM,eAAe,MAAM,SAAS,UAAU,MAAM,MAAM,KAAK;AAE/D,UAAM,gBAAgB,MAAM,SAAS,SAClC,aAAa,gBAAgB,EAAE,QAAQ,MAAM,SAAS,QAAQ,OAAO,KAAK,OAAO,MAAA,CAAO,EAAE,IAAI,cAAc,EAAE,KAAK,IAAI,CAAC,MACxH;AAKH,UAAM,cAAc,MAAM,QAAQ,WAAW,MAAM,KAAK,MAAM;AAE9D,YAAQ,IAAI,mBAAmB,WAAW,GAAG,YAAY,KAAK,cAAc,KAAK,IAAI,CAAC,IAAI,aAAa,GAAG,WAAW,EAAE;AAEvH,+BAAA;AAAA,EACD;AAAA,EAEO,mBAAkC;AACxC,WAAO;AAAA,MACN,aAAa,KAAK,KAAK,YAAY,CAAC,EAAE,cAAc;AAAA,QACnD,GAAG;AAAA,QACH,SAAS;AAAA,UACR,GAAG,OAAO;AAAA,UACV,KAAK,KAAK;AAAA,QAAA;AAAA,MACX,EACC;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,WAAW;AACV,UAAM,QAAQ,KAAK,KAAK;AACxB,UAAM,aAAa,MAAM,SAAS,UAAU,MAAM,MAAM,KAAK;AAC7D,UAAM,cAAc,MAAM,SAAS,SAAS,aAAa,MAAM,QAAQ,KAAK,IAAI,CAAC,MAAM;AACvF,UAAM,YAAY,MAAM,QAAQ,UAAU,MAAM,KAAK,KAAK;AAG1D,UAAM,oBAAoB,MAAM,iBAAiB,OAAO,KAAK,MAAM,aAAa,EAAE,SAAS,IACxF,aACD,OAAO,QAAQ,MAAM,aAAa,EAAE,IAAI,CAAC,CAAC,OAAO,IAAI,MAAM;AAC1D,YAAM,QAAQ,CAAC,KAAK,OAAO,KAAK,QAAQ,SAAS,KAAK,KAAK,KAAK,IAAI,KAAK,UAAU,WAAW,KAAK,OAAO,KAAK,EAAE,EAAE,OAAO,OAAO;AACjI,aAAO,GAAG,KAAK,KAAK,MAAM,KAAK,GAAG,CAAC;AAAA,IACpC,CAAC,EAAE,KAAK,IAAI,CACb,MACE;AACH,WAAO;AAAA,MACN,SAAS,gBAAgB,MAAM,OAAO,KAAK,IAAI,CAAC,IAAI,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,iBAAiB,cAAc,KAAK,KAAK,UAAU;AAAA,IAAA;AAAA,EAEhJ;AACD;AAEO,MAAM,0BAA0B,uBAAuB;AAAA,EAC7D,IAAI;AAAA,EACJ,SAAS;AACV,CAAC;AAOM,MAAM,kBAAoC;AAAA,EAChD,WAAW,gBAAwB,eAAuB;AACzD,WAAO,OAAO,OAAO,cAAc,MAAM,QAAQ,EAAE;AAAA,MAAQ,CAAA,WAC1D,OAAO,QACL,OAAO,QAAM,CAAC,eAAe,MAAM,SAAS,OAAO,IAAI,EAAE,QAAQ,KAAK,CAAA,QAAO,UAAU,KAAK,EAAE,CAAC,CAAC,EAChG;AAAA,QAAI,CAAA,UACJ,wBAAwB,mBAAmB;AAAA,UAC1C,YAAY,OAAO;AAAA,UACnB;AAAA,QAAA,CACA;AAAA,MAAA;AAAA,IACF;AAAA,EAEH;AACD;"}

package/dist/development/src/modifications/indexes/RemoveIndexModification.cjs

@@ -5,6 +5,7 @@ const ModificationHandler = require("../ModificationHandler.cjs");
 const deepEqual = require("fast-deep-equal");
 const utils = require("./utils.cjs");
 const dbHelpers = require("../../utils/dbHelpers.cjs");
+const indexIdentityEquals = (a, b) => deepEqual(a.fields, b.fields) && (a.where ?? void 0) === (b.where ?? void 0) && deepEqual(a.include ?? void 0, b.include ?? void 0) && deepEqual(a.columnOptions ?? void 0, b.columnOptions ?? void 0) && (a.method ?? void 0) === (b.method ?? void 0) && (a.opClass ?? void 0) === (b.opClass ?? void 0);
 class RemoveIndexModificationHandler {
   constructor(data, schema) {
     this.data = data;
@@ -15,23 +16,27 @@ class RemoveIndexModificationHandler {
     if (entity.view && !entity.view.materialized) {
       return;
     }
-    const fields = this.getFields();
-    const columns = utils.getIndexColumns({
-      entity,
-      fields,
-      model: this.schema.model
-    });
+    const index = this.getIndex();
+    const columns = [
+      ...utils.getIndexColumns({ entity, fields: index.fields, model: this.schema.model }),
+      ...index.include ? utils.getIndexColumns({ entity, fields: index.include, model: this.schema.model }) : []
+    ];
     const indexNames = databaseMetadata.indexes.filter({ tableName: entity.tableName, columnNames: columns, unique: false }).getNames();
+    if (indexNames.length > 1) {
+      throw new Error(
+        `Cannot unambiguously drop index on entity ${this.data.entityName} (${index.fields.join(", ")}): ${indexNames.length} indexes match these columns and the database metadata does not expose the predicate (where), per-column options (sort order / NULLS / operator class), column order, index method or index-level operator class that distinguish them. Drop the obsolete index manually.`
+      );
+    }
     for (const name of indexNames) {
       builder.sql(`DROP INDEX ${dbHelpers.wrapIdentifier(name)}`);
     }
     invalidateDatabaseMetadata();
   }
   getSchemaUpdater() {
-    const fields = this.getFields();
+    const index = this.getIndex();
     return schemaUpdateUtils.updateModel(
       schemaUpdateUtils.updateEntity(this.data.entityName, ({ entity }) => {
-        const indexes = entity.indexes.filter((it) => !deepEqual(it.fields, fields));
+        const indexes = entity.indexes.filter((it) => !indexIdentityEquals(it, index));
         return {
           ...entity,
           indexes
@@ -40,16 +45,37 @@ class RemoveIndexModificationHandler {
     );
   }
   describe() {
-    const fields = this.getFields();
-    return { message: `Remove index (${fields.join(", ")}) on entity ${this.data.entityName}` };
+    const index = this.getIndex();
+    return { message: `Remove index (${index.fields.join(", ")}) on entity ${this.data.entityName}` };
   }
-  getFields() {
-    const entity = this.schema.model.entities[this.data.entityName];
-    const fields = "indexName" in this.data ? entity.indexes.find((it) => it.name === this.data.indexName)?.fields : this.data.fields;
-    if (!fields) {
-      throw new Error();
+  getIndex() {
+    const { entityName } = this.data;
+    const entity = this.schema.model.entities[entityName];
+    if ("indexName" in this.data && this.data.indexName !== void 0) {
+      const index = entity.indexes.find((it) => it.name === this.data.indexName);
+      if (!index) {
+        throw new Error(`Index named "${this.data.indexName}" not found on entity ${entityName}`);
+      }
+      return {
+        fields: index.fields,
+        where: index.where,
+        include: index.include,
+        columnOptions: index.columnOptions,
+        method: index.method,
+        opClass: index.opClass
+      };
+    }
+    if (!this.data.fields) {
+      throw new Error(`removeIndex modification on entity ${entityName} requires either "indexName" or "fields"`);
     }
-    return fields;
+    return {
+      fields: this.data.fields,
+      where: this.data.where,
+      include: this.data.include,
+      columnOptions: this.data.columnOptions,
+      method: this.data.method,
+      opClass: this.data.opClass
+    };
   }
 }
 const removeIndexModification = ModificationHandler.createModificationType({
@@ -70,7 +96,16 @@ class RemoveIndexDiffer {
       ).map(
         (index) => removeIndexModification.createModification({
           entityName: entity.name,
-          fields: index.fields
+          fields: index.fields,
+          // keep every identity-bearing option (WHERE/INCLUDE/columnOptions/method/opClass) in the
+          // modification so indexes that share the same key columns but differ by any of them are
+          // removed individually; omit the keys when absent to keep legacy migration JSON
+          // byte-for-byte identical.
+          ...index.where !== void 0 ? { where: index.where } : {},
+          ...index.include !== void 0 ? { include: index.include } : {},
+          ...index.columnOptions !== void 0 ? { columnOptions: index.columnOptions } : {},
+          ...index.method !== void 0 ? { method: index.method } : {},
+          ...index.opClass !== void 0 ? { opClass: index.opClass } : {}
         })
       )
     );

package/dist/development/src/modifications/indexes/RemoveIndexModification.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"RemoveIndexModification.cjs","sources":["../../../../../../packages/schema-migrations/src/modifications/indexes/RemoveIndexModification.ts"],"sourcesContent":["import { MigrationBuilder } from '@contember/database-migrations'\nimport { Schema } from '@contember/schema'\nimport { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'\nimport { createModificationType, Differ, ModificationHandler, ModificationHandlerCreateSqlOptions } from '../ModificationHandler'\nimport deepEqual from 'fast-deep-equal'\nimport { getIndexColumns } from './utils'\nimport { wrapIdentifier } from '../../utils/dbHelpers'\n\nexport class RemoveIndexModificationHandler implements ModificationHandler<RemoveIndexModificationData> {\n\tconstructor(private readonly data: RemoveIndexModificationData, private readonly schema: Schema) {}\n\n\tpublic createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tif (entity.view && !entity.view.materialized) {\n\t\t\treturn\n\t\t}\n\t\tconst fields = this.getFields()\n\n\t\tconst columns = getIndexColumns({\n\t\t\tentity,\n\t\t\tfields,\n\t\t\tmodel: this.schema.model,\n\t\t})\n\n\t\tconst indexNames = databaseMetadata.indexes.filter({ tableName: entity.tableName, columnNames: columns, unique: false }).getNames()\n\n\t\tfor (const name of indexNames) {\n\t\t\tbuilder.sql(`DROP INDEX ${wrapIdentifier(name)}`)\n\t\t}\n\t\tinvalidateDatabaseMetadata()\n\t}\n\n\tpublic getSchemaUpdater(): SchemaUpdater {\n\t\tconst fields = this.getFields()\n\t\treturn updateModel(\n\t\t\tupdateEntity(this.data.entityName, ({ entity }) => {\n\t\t\t\tconst indexes = entity.indexes.filter(it => !deepEqual(it.fields, fields))\n\t\t\t\treturn {\n\t\t\t\t\t...entity,\n\t\t\t\t\tindexes,\n\t\t\t\t}\n\t\t\t}),\n\t\t)\n\t}\n\n\tdescribe() {\n\t\tconst fields = this.getFields()\n\t\treturn { message: `Remove index (${fields.join(', ')}) on entity ${this.data.entityName}` }\n\t}\n\n\tgetFields() {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tconst fields = 'indexName' in this.data\n\t\t\t? entity.indexes.find(it => it.name === this.data.indexName)?.fields\n\t\t\t: this.data.fields\n\t\tif (!fields) {\n\t\t\tthrow new Error()\n\t\t}\n\t\treturn fields\n\t}\n}\n\nexport const removeIndexModification = createModificationType({\n\tid: 'removeIndex',\n\thandler: RemoveIndexModificationHandler,\n})\n\nexport type RemoveIndexModificationData =\n\t| {\n\t\tentityName: string\n\t\tindexName: string\n\t\tfields?: never\n\t}\n\t| {\n\t\tentityName: string\n\t\tfields: readonly string[]\n\t\tindexName?: never\n\t}\n\nexport class RemoveIndexDiffer implements Differ {\n\tcreateDiff(originalSchema: Schema, updatedSchema: Schema) {\n\t\treturn Object.values(originalSchema.model.entities).flatMap(entity =>\n\t\t\tentity.indexes\n\t\t\t\t.filter(\n\t\t\t\t\tit => {\n\t\t\t\t\t\tconst updatedEntity = updatedSchema.model.entities[entity.name]\n\t\t\t\t\t\tif (!updatedEntity) {\n\t\t\t\t\t\t\treturn false\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn !updatedEntity.indexes.find(index => deepEqual(index, it))\n\t\t\t\t\t},\n\t\t\t\t)\n\t\t\t\t.map(index =>\n\t\t\t\t\tremoveIndexModification.createModification({\n\t\t\t\t\t\tentityName: entity.name,\n\t\t\t\t\t\tfields: index.fields,\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t)\n\t}\n}\n"],"names":["getIndexColumns","wrapIdentifier","updateModel","updateEntity","createModificationType"],"mappings":";;;;;;;AAQO,MAAM,+BAA2F;AAAA,EACvG,YAA6B,MAAoD,QAAgB;AAApE,SAAA,OAAA;AAAoD,SAAA,SAAA;AAAA,EAAiB;AAAA,EAE3F,UAAU,SAA2B,EAAE,kBAAkB,8BAAyE;AACxI,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,QAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,cAAc;AAC7C;AAAA,IACD;AACA,UAAM,SAAS,KAAK,UAAA;AAEpB,UAAM,UAAUA,MAAAA,gBAAgB;AAAA,MAC/B;AAAA,MACA;AAAA,MACA,OAAO,KAAK,OAAO;AAAA,IAAA,CACnB;AAED,UAAM,aAAa,iBAAiB,QAAQ,OAAO,EAAE,WAAW,OAAO,WAAW,aAAa,SAAS,QAAQ,MAAA,CAAO,EAAE,SAAA;AAEzH,eAAW,QAAQ,YAAY;AAC9B,cAAQ,IAAI,cAAcC,UAAAA,eAAe,IAAI,CAAC,EAAE;AAAA,IACjD;AACA,+BAAA;AAAA,EACD;AAAA,EAEO,mBAAkC;AACxC,UAAM,SAAS,KAAK,UAAA;AACpB,WAAOC,kBAAAA;AAAAA,MACNC,kBAAAA,aAAa,KAAK,KAAK,YAAY,CAAC,EAAE,aAAa;AAClD,cAAM,UAAU,OAAO,QAAQ,OAAO,CAAA,OAAM,CAAC,UAAU,GAAG,QAAQ,MAAM,CAAC;AACzE,eAAO;AAAA,UACN,GAAG;AAAA,UACH;AAAA,QAAA;AAAA,MAEF,CAAC;AAAA,IAAA;AAAA,EAEH;AAAA,EAEA,WAAW;AACV,UAAM,SAAS,KAAK,UAAA;AACpB,WAAO,EAAE,SAAS,iBAAiB,OAAO,KAAK,IAAI,CAAC,eAAe,KAAK,KAAK,UAAU,GAAA;AAAA,EACxF;AAAA,EAEA,YAAY;AACX,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,UAAM,SAAS,eAAe,KAAK,OAChC,OAAO,QAAQ,KAAK,CAAA,OAAM,GAAG,SAAS,KAAK,KAAK,SAAS,GAAG,SAC5D,KAAK,KAAK;AACb,QAAI,CAAC,QAAQ;AACZ,YAAM,IAAI,MAAA;AAAA,IACX;AACA,WAAO;AAAA,EACR;AACD;AAEO,MAAM,0BAA0BC,oBAAAA,uBAAuB;AAAA,EAC7D,IAAI;AAAA,EACJ,SAAS;AACV,CAAC;AAcM,MAAM,kBAAoC;AAAA,EAChD,WAAW,gBAAwB,eAAuB;AACzD,WAAO,OAAO,OAAO,eAAe,MAAM,QAAQ,EAAE;AAAA,MAAQ,CAAA,WAC3D,OAAO,QACL;AAAA,QACA,CAAA,OAAM;AACL,gBAAM,gBAAgB,cAAc,MAAM,SAAS,OAAO,IAAI;AAC9D,cAAI,CAAC,eAAe;AACnB,mBAAO;AAAA,UACR;AACA,iBAAO,CAAC,cAAc,QAAQ,KAAK,WAAS,UAAU,OAAO,EAAE,CAAC;AAAA,QACjE;AAAA,MAAA,EAEA;AAAA,QAAI,CAAA,UACJ,wBAAwB,mBAAmB;AAAA,UAC1C,YAAY,OAAO;AAAA,UACnB,QAAQ,MAAM;AAAA,QAAA,CACd;AAAA,MAAA;AAAA,IACF;AAAA,EAEH;AACD;;;;"}
+{"version":3,"file":"RemoveIndexModification.cjs","sources":["../../../../../../packages/schema-migrations/src/modifications/indexes/RemoveIndexModification.ts"],"sourcesContent":["import { MigrationBuilder } from '@contember/database-migrations'\nimport { Model, Schema } from '@contember/schema'\nimport { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils.js'\nimport { createModificationType, Differ, ModificationHandler, ModificationHandlerCreateSqlOptions } from '../ModificationHandler.js'\nimport deepEqual from 'fast-deep-equal'\nimport { getIndexColumns } from './utils.js'\nimport { wrapIdentifier } from '../../utils/dbHelpers.js'\n\ntype IndexIdentity = Pick<Model.Index, 'fields' | 'where' | 'include' | 'columnOptions' | 'method' | 'opClass'>\nconst indexIdentityEquals = (a: IndexIdentity, b: IndexIdentity) =>\n\tdeepEqual(a.fields, b.fields)\n\t&& (a.where ?? undefined) === (b.where ?? undefined)\n\t&& deepEqual(a.include ?? undefined, b.include ?? undefined)\n\t&& deepEqual(a.columnOptions ?? undefined, b.columnOptions ?? undefined)\n\t&& (a.method ?? undefined) === (b.method ?? undefined)\n\t&& (a.opClass ?? undefined) === (b.opClass ?? undefined)\n\nexport class RemoveIndexModificationHandler implements ModificationHandler<RemoveIndexModificationData> {\n\tconstructor(private readonly data: RemoveIndexModificationData, private readonly schema: Schema) {}\n\n\tpublic createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tif (entity.view && !entity.view.materialized) {\n\t\t\treturn\n\t\t}\n\t\tconst index = this.getIndex()\n\n\t\t// The DB-metadata layer (DatabaseMetadataResolver) exposes only table + columns (as an unordered\n\t\t// set) + uniqueness, so the physical DROP is matched by table + columns. Postgres' pg_index.indkey\n\t\t// includes the INCLUDE columns alongside the key columns, so a covering index's metadata lists both —\n\t\t// we match the same combined set here. Everything else that distinguishes two indexes on the same\n\t\t// column set — the partial WHERE predicate, per-column options (sort order / NULLS / operator class),\n\t\t// key-column ORDER (the set comparison is order-insensitive), the index method, and the index-level\n\t\t// operator class — is invisible to the metadata, so such siblings are indistinguishable here. We\n\t\t// detect that ambiguity below and fail loudly rather than DROP a sibling the schema still expects to\n\t\t// keep. Schema-level identity (see getSchemaUpdater) IS fully aware of these discriminators, so the\n\t\t// diff itself never conflates them.\n\t\tconst columns = [\n\t\t\t...getIndexColumns({ entity, fields: index.fields, model: this.schema.model }),\n\t\t\t...(index.include ? getIndexColumns({ entity, fields: index.include, model: this.schema.model }) : []),\n\t\t]\n\n\t\tconst indexNames = databaseMetadata.indexes.filter({ tableName: entity.tableName, columnNames: columns, unique: false }).getNames()\n\n\t\t// If more than one physical index matches these columns we cannot tell which one this modification\n\t\t// targets (the metadata hides the predicate / per-column options / column order / index method /\n\t\t// index-level operator class that distinguish them). Dropping every match would silently take out an\n\t\t// index the schema still expects — refuse instead, so the obsolete one can be dropped by hand.\n\t\tif (indexNames.length > 1) {\n\t\t\tthrow new Error(\n\t\t\t\t`Cannot unambiguously drop index on entity ${this.data.entityName} (${index.fields.join(', ')}): `\n\t\t\t\t\t+ `${indexNames.length} indexes match these columns and the database metadata does not expose the predicate (where), `\n\t\t\t\t\t+ `per-column options (sort order / NULLS / operator class), column order, index method or index-level operator class that distinguish them. `\n\t\t\t\t\t+ `Drop the obsolete index manually.`,\n\t\t\t)\n\t\t}\n\n\t\tfor (const name of indexNames) {\n\t\t\tbuilder.sql(`DROP INDEX ${wrapIdentifier(name)}`)\n\t\t}\n\t\tinvalidateDatabaseMetadata()\n\t}\n\n\tpublic getSchemaUpdater(): SchemaUpdater {\n\t\tconst index = this.getIndex()\n\t\treturn updateModel(\n\t\t\tupdateEntity(this.data.entityName, ({ entity }) => {\n\t\t\t\tconst indexes = entity.indexes.filter(it => !indexIdentityEquals(it, index))\n\t\t\t\treturn {\n\t\t\t\t\t...entity,\n\t\t\t\t\tindexes,\n\t\t\t\t}\n\t\t\t}),\n\t\t)\n\t}\n\n\tdescribe() {\n\t\tconst index = this.getIndex()\n\t\treturn { message: `Remove index (${index.fields.join(', ')}) on entity ${this.data.entityName}` }\n\t}\n\n\tprivate getIndex(): IndexIdentity {\n\t\tconst { entityName } = this.data\n\t\tconst entity = this.schema.model.entities[entityName]\n\t\tif ('indexName' in this.data && this.data.indexName !== undefined) {\n\t\t\tconst index = entity.indexes.find(it => it.name === this.data.indexName)\n\t\t\tif (!index) {\n\t\t\t\tthrow new Error(`Index named \"${this.data.indexName}\" not found on entity ${entityName}`)\n\t\t\t}\n\t\t\treturn {\n\t\t\t\tfields: index.fields,\n\t\t\t\twhere: index.where,\n\t\t\t\tinclude: index.include,\n\t\t\t\tcolumnOptions: index.columnOptions,\n\t\t\t\tmethod: index.method,\n\t\t\t\topClass: index.opClass,\n\t\t\t}\n\t\t}\n\t\tif (!this.data.fields) {\n\t\t\tthrow new Error(`removeIndex modification on entity ${entityName} requires either \"indexName\" or \"fields\"`)\n\t\t}\n\t\treturn {\n\t\t\tfields: this.data.fields,\n\t\t\twhere: this.data.where,\n\t\t\tinclude: this.data.include,\n\t\t\tcolumnOptions: this.data.columnOptions,\n\t\t\tmethod: this.data.method,\n\t\t\topClass: this.data.opClass,\n\t\t}\n\t}\n}\n\nexport const removeIndexModification = createModificationType({\n\tid: 'removeIndex',\n\thandler: RemoveIndexModificationHandler,\n})\n\nexport type RemoveIndexModificationData =\n\t| {\n\t\tentityName: string\n\t\tindexName: string\n\t\tfields?: never\n\t\twhere?: never\n\t\tinclude?: never\n\t\tcolumnOptions?: never\n\t\tmethod?: never\n\t\topClass?: never\n\t}\n\t| {\n\t\tentityName: string\n\t\tfields: readonly string[]\n\t\twhere?: string\n\t\tinclude?: readonly string[]\n\t\tcolumnOptions?: { readonly [field: string]: Model.IndexColumnOptions }\n\t\tmethod?: Model.IndexMethod\n\t\topClass?: string\n\t\tindexName?: never\n\t}\n\nexport class RemoveIndexDiffer implements Differ {\n\tcreateDiff(originalSchema: Schema, updatedSchema: Schema) {\n\t\treturn Object.values(originalSchema.model.entities).flatMap(entity =>\n\t\t\tentity.indexes\n\t\t\t\t.filter(\n\t\t\t\t\tit => {\n\t\t\t\t\t\tconst updatedEntity = updatedSchema.model.entities[entity.name]\n\t\t\t\t\t\tif (!updatedEntity) {\n\t\t\t\t\t\t\treturn false\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn !updatedEntity.indexes.find(index => deepEqual(index, it))\n\t\t\t\t\t},\n\t\t\t\t)\n\t\t\t\t.map(index =>\n\t\t\t\t\tremoveIndexModification.createModification({\n\t\t\t\t\t\tentityName: entity.name,\n\t\t\t\t\t\tfields: index.fields,\n\t\t\t\t\t\t// keep every identity-bearing option (WHERE/INCLUDE/columnOptions/method/opClass) in the\n\t\t\t\t\t\t// modification so indexes that share the same key columns but differ by any of them are\n\t\t\t\t\t\t// removed individually; omit the keys when absent to keep legacy migration JSON\n\t\t\t\t\t\t// byte-for-byte identical.\n\t\t\t\t\t\t...(index.where !== undefined ? { where: index.where } : {}),\n\t\t\t\t\t\t...(index.include !== undefined ? { include: index.include } : {}),\n\t\t\t\t\t\t...(index.columnOptions !== undefined ? { columnOptions: index.columnOptions } : {}),\n\t\t\t\t\t\t...(index.method !== undefined ? { method: index.method } : {}),\n\t\t\t\t\t\t...(index.opClass !== undefined ? { opClass: index.opClass } : {}),\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t)\n\t}\n}\n"],"names":["getIndexColumns","wrapIdentifier","updateModel","updateEntity","createModificationType"],"mappings":";;;;;;;AASA,MAAM,sBAAsB,CAAC,GAAkB,MAC9C,UAAU,EAAE,QAAQ,EAAE,MAAM,MACxB,EAAE,SAAS,aAAgB,EAAE,SAAS,WACvC,UAAU,EAAE,WAAW,QAAW,EAAE,WAAW,MAAS,KACxD,UAAU,EAAE,iBAAiB,QAAW,EAAE,iBAAiB,MAAS,MACnE,EAAE,UAAU,aAAgB,EAAE,UAAU,YACxC,EAAE,WAAW,aAAgB,EAAE,WAAW;AAExC,MAAM,+BAA2F;AAAA,EACvG,YAA6B,MAAoD,QAAgB;AAApE,SAAA,OAAA;AAAoD,SAAA,SAAA;AAAA,EAAiB;AAAA,EAE3F,UAAU,SAA2B,EAAE,kBAAkB,8BAAyE;AACxI,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,QAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,cAAc;AAC7C;AAAA,IACD;AACA,UAAM,QAAQ,KAAK,SAAA;AAYnB,UAAM,UAAU;AAAA,MACf,GAAGA,sBAAgB,EAAE,QAAQ,QAAQ,MAAM,QAAQ,OAAO,KAAK,OAAO,OAAO;AAAA,MAC7E,GAAI,MAAM,UAAUA,sBAAgB,EAAE,QAAQ,QAAQ,MAAM,SAAS,OAAO,KAAK,OAAO,MAAA,CAAO,IAAI,CAAA;AAAA,IAAC;AAGrG,UAAM,aAAa,iBAAiB,QAAQ,OAAO,EAAE,WAAW,OAAO,WAAW,aAAa,SAAS,QAAQ,MAAA,CAAO,EAAE,SAAA;AAMzH,QAAI,WAAW,SAAS,GAAG;AAC1B,YAAM,IAAI;AAAA,QACT,6CAA6C,KAAK,KAAK,UAAU,KAAK,MAAM,OAAO,KAAK,IAAI,CAAC,MACvF,WAAW,MAAM;AAAA,MAAA;AAAA,IAIzB;AAEA,eAAW,QAAQ,YAAY;AAC9B,cAAQ,IAAI,cAAcC,UAAAA,eAAe,IAAI,CAAC,EAAE;AAAA,IACjD;AACA,+BAAA;AAAA,EACD;AAAA,EAEO,mBAAkC;AACxC,UAAM,QAAQ,KAAK,SAAA;AACnB,WAAOC,kBAAAA;AAAAA,MACNC,kBAAAA,aAAa,KAAK,KAAK,YAAY,CAAC,EAAE,aAAa;AAClD,cAAM,UAAU,OAAO,QAAQ,OAAO,QAAM,CAAC,oBAAoB,IAAI,KAAK,CAAC;AAC3E,eAAO;AAAA,UACN,GAAG;AAAA,UACH;AAAA,QAAA;AAAA,MAEF,CAAC;AAAA,IAAA;AAAA,EAEH;AAAA,EAEA,WAAW;AACV,UAAM,QAAQ,KAAK,SAAA;AACnB,WAAO,EAAE,SAAS,iBAAiB,MAAM,OAAO,KAAK,IAAI,CAAC,eAAe,KAAK,KAAK,UAAU,GAAA;AAAA,EAC9F;AAAA,EAEQ,WAA0B;AACjC,UAAM,EAAE,eAAe,KAAK;AAC5B,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,UAAU;AACpD,QAAI,eAAe,KAAK,QAAQ,KAAK,KAAK,cAAc,QAAW;AAClE,YAAM,QAAQ,OAAO,QAAQ,KAAK,QAAM,GAAG,SAAS,KAAK,KAAK,SAAS;AACvE,UAAI,CAAC,OAAO;AACX,cAAM,IAAI,MAAM,gBAAgB,KAAK,KAAK,SAAS,yBAAyB,UAAU,EAAE;AAAA,MACzF;AACA,aAAO;AAAA,QACN,QAAQ,MAAM;AAAA,QACd,OAAO,MAAM;AAAA,QACb,SAAS,MAAM;AAAA,QACf,eAAe,MAAM;AAAA,QACrB,QAAQ,MAAM;AAAA,QACd,SAAS,MAAM;AAAA,MAAA;AAAA,IAEjB;AACA,QAAI,CAAC,KAAK,KAAK,QAAQ;AACtB,YAAM,IAAI,MAAM,sCAAsC,UAAU,0CAA0C;AAAA,IAC3G;AACA,WAAO;AAAA,MACN,QAAQ,KAAK,KAAK;AAAA,MAClB,OAAO,KAAK,KAAK;AAAA,MACjB,SAAS,KAAK,KAAK;AAAA,MACnB,eAAe,KAAK,KAAK;AAAA,MACzB,QAAQ,KAAK,KAAK;AAAA,MAClB,SAAS,KAAK,KAAK;AAAA,IAAA;AAAA,EAErB;AACD;AAEO,MAAM,0BAA0BC,oBAAAA,uBAAuB;AAAA,EAC7D,IAAI;AAAA,EACJ,SAAS;AACV,CAAC;AAwBM,MAAM,kBAAoC;AAAA,EAChD,WAAW,gBAAwB,eAAuB;AACzD,WAAO,OAAO,OAAO,eAAe,MAAM,QAAQ,EAAE;AAAA,MAAQ,CAAA,WAC3D,OAAO,QACL;AAAA,QACA,CAAA,OAAM;AACL,gBAAM,gBAAgB,cAAc,MAAM,SAAS,OAAO,IAAI;AAC9D,cAAI,CAAC,eAAe;AACnB,mBAAO;AAAA,UACR;AACA,iBAAO,CAAC,cAAc,QAAQ,KAAK,WAAS,UAAU,OAAO,EAAE,CAAC;AAAA,QACjE;AAAA,MAAA,EAEA;AAAA,QAAI,CAAA,UACJ,wBAAwB,mBAAmB;AAAA,UAC1C,YAAY,OAAO;AAAA,UACnB,QAAQ,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKd,GAAI,MAAM,UAAU,SAAY,EAAE,OAAO,MAAM,MAAA,IAAU,CAAA;AAAA,UACzD,GAAI,MAAM,YAAY,SAAY,EAAE,SAAS,MAAM,QAAA,IAAY,CAAA;AAAA,UAC/D,GAAI,MAAM,kBAAkB,SAAY,EAAE,eAAe,MAAM,cAAA,IAAkB,CAAA;AAAA,UACjF,GAAI,MAAM,WAAW,SAAY,EAAE,QAAQ,MAAM,OAAA,IAAW,CAAA;AAAA,UAC5D,GAAI,MAAM,YAAY,SAAY,EAAE,SAAS,MAAM,YAAY,CAAA;AAAA,QAAC,CAChE;AAAA,MAAA;AAAA,IACF;AAAA,EAEH;AACD;;;;"}

package/dist/development/src/modifications/indexes/RemoveIndexModification.js

@@ -3,6 +3,7 @@ import { createModificationType } from "../ModificationHandler.js";
 import deepEqual from "fast-deep-equal";
 import { getIndexColumns } from "./utils.js";
 import { wrapIdentifier } from "../../utils/dbHelpers.js";
+const indexIdentityEquals = (a, b) => deepEqual(a.fields, b.fields) && (a.where ?? void 0) === (b.where ?? void 0) && deepEqual(a.include ?? void 0, b.include ?? void 0) && deepEqual(a.columnOptions ?? void 0, b.columnOptions ?? void 0) && (a.method ?? void 0) === (b.method ?? void 0) && (a.opClass ?? void 0) === (b.opClass ?? void 0);
 class RemoveIndexModificationHandler {
   constructor(data, schema) {
     this.data = data;
@@ -13,23 +14,27 @@ class RemoveIndexModificationHandler {
     if (entity.view && !entity.view.materialized) {
       return;
     }
-    const fields = this.getFields();
-    const columns = getIndexColumns({
-      entity,
-      fields,
-      model: this.schema.model
-    });
+    const index = this.getIndex();
+    const columns = [
+      ...getIndexColumns({ entity, fields: index.fields, model: this.schema.model }),
+      ...index.include ? getIndexColumns({ entity, fields: index.include, model: this.schema.model }) : []
+    ];
     const indexNames = databaseMetadata.indexes.filter({ tableName: entity.tableName, columnNames: columns, unique: false }).getNames();
+    if (indexNames.length > 1) {
+      throw new Error(
+        `Cannot unambiguously drop index on entity ${this.data.entityName} (${index.fields.join(", ")}): ${indexNames.length} indexes match these columns and the database metadata does not expose the predicate (where), per-column options (sort order / NULLS / operator class), column order, index method or index-level operator class that distinguish them. Drop the obsolete index manually.`
+      );
+    }
     for (const name of indexNames) {
       builder.sql(`DROP INDEX ${wrapIdentifier(name)}`);
     }
     invalidateDatabaseMetadata();
   }
   getSchemaUpdater() {
-    const fields = this.getFields();
+    const index = this.getIndex();
     return updateModel(
       updateEntity(this.data.entityName, ({ entity }) => {
-        const indexes = entity.indexes.filter((it) => !deepEqual(it.fields, fields));
+        const indexes = entity.indexes.filter((it) => !indexIdentityEquals(it, index));
         return {
           ...entity,
           indexes
@@ -38,16 +43,37 @@ class RemoveIndexModificationHandler {
     );
   }
   describe() {
-    const fields = this.getFields();
-    return { message: `Remove index (${fields.join(", ")}) on entity ${this.data.entityName}` };
+    const index = this.getIndex();
+    return { message: `Remove index (${index.fields.join(", ")}) on entity ${this.data.entityName}` };
   }
-  getFields() {
-    const entity = this.schema.model.entities[this.data.entityName];
-    const fields = "indexName" in this.data ? entity.indexes.find((it) => it.name === this.data.indexName)?.fields : this.data.fields;
-    if (!fields) {
-      throw new Error();
+  getIndex() {
+    const { entityName } = this.data;
+    const entity = this.schema.model.entities[entityName];
+    if ("indexName" in this.data && this.data.indexName !== void 0) {
+      const index = entity.indexes.find((it) => it.name === this.data.indexName);
+      if (!index) {
+        throw new Error(`Index named "${this.data.indexName}" not found on entity ${entityName}`);
+      }
+      return {
+        fields: index.fields,
+        where: index.where,
+        include: index.include,
+        columnOptions: index.columnOptions,
+        method: index.method,
+        opClass: index.opClass
+      };
+    }
+    if (!this.data.fields) {
+      throw new Error(`removeIndex modification on entity ${entityName} requires either "indexName" or "fields"`);
     }
-    return fields;
+    return {
+      fields: this.data.fields,
+      where: this.data.where,
+      include: this.data.include,
+      columnOptions: this.data.columnOptions,
+      method: this.data.method,
+      opClass: this.data.opClass
+    };
   }
 }
 const removeIndexModification = createModificationType({
@@ -68,7 +94,16 @@ class RemoveIndexDiffer {
       ).map(
         (index) => removeIndexModification.createModification({
           entityName: entity.name,
-          fields: index.fields
+          fields: index.fields,
+          // keep every identity-bearing option (WHERE/INCLUDE/columnOptions/method/opClass) in the
+          // modification so indexes that share the same key columns but differ by any of them are
+          // removed individually; omit the keys when absent to keep legacy migration JSON
+          // byte-for-byte identical.
+          ...index.where !== void 0 ? { where: index.where } : {},
+          ...index.include !== void 0 ? { include: index.include } : {},
+          ...index.columnOptions !== void 0 ? { columnOptions: index.columnOptions } : {},
+          ...index.method !== void 0 ? { method: index.method } : {},
+          ...index.opClass !== void 0 ? { opClass: index.opClass } : {}
         })
       )
     );

package/dist/development/src/modifications/indexes/RemoveIndexModification.js.map

@@ -1 +1 @@
-{"version":3,"file":"RemoveIndexModification.js","sources":["../../../../../../packages/schema-migrations/src/modifications/indexes/RemoveIndexModification.ts"],"sourcesContent":["import { MigrationBuilder } from '@contember/database-migrations'\nimport { Schema } from '@contember/schema'\nimport { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils'\nimport { createModificationType, Differ, ModificationHandler, ModificationHandlerCreateSqlOptions } from '../ModificationHandler'\nimport deepEqual from 'fast-deep-equal'\nimport { getIndexColumns } from './utils'\nimport { wrapIdentifier } from '../../utils/dbHelpers'\n\nexport class RemoveIndexModificationHandler implements ModificationHandler<RemoveIndexModificationData> {\n\tconstructor(private readonly data: RemoveIndexModificationData, private readonly schema: Schema) {}\n\n\tpublic createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tif (entity.view && !entity.view.materialized) {\n\t\t\treturn\n\t\t}\n\t\tconst fields = this.getFields()\n\n\t\tconst columns = getIndexColumns({\n\t\t\tentity,\n\t\t\tfields,\n\t\t\tmodel: this.schema.model,\n\t\t})\n\n\t\tconst indexNames = databaseMetadata.indexes.filter({ tableName: entity.tableName, columnNames: columns, unique: false }).getNames()\n\n\t\tfor (const name of indexNames) {\n\t\t\tbuilder.sql(`DROP INDEX ${wrapIdentifier(name)}`)\n\t\t}\n\t\tinvalidateDatabaseMetadata()\n\t}\n\n\tpublic getSchemaUpdater(): SchemaUpdater {\n\t\tconst fields = this.getFields()\n\t\treturn updateModel(\n\t\t\tupdateEntity(this.data.entityName, ({ entity }) => {\n\t\t\t\tconst indexes = entity.indexes.filter(it => !deepEqual(it.fields, fields))\n\t\t\t\treturn {\n\t\t\t\t\t...entity,\n\t\t\t\t\tindexes,\n\t\t\t\t}\n\t\t\t}),\n\t\t)\n\t}\n\n\tdescribe() {\n\t\tconst fields = this.getFields()\n\t\treturn { message: `Remove index (${fields.join(', ')}) on entity ${this.data.entityName}` }\n\t}\n\n\tgetFields() {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tconst fields = 'indexName' in this.data\n\t\t\t? entity.indexes.find(it => it.name === this.data.indexName)?.fields\n\t\t\t: this.data.fields\n\t\tif (!fields) {\n\t\t\tthrow new Error()\n\t\t}\n\t\treturn fields\n\t}\n}\n\nexport const removeIndexModification = createModificationType({\n\tid: 'removeIndex',\n\thandler: RemoveIndexModificationHandler,\n})\n\nexport type RemoveIndexModificationData =\n\t| {\n\t\tentityName: string\n\t\tindexName: string\n\t\tfields?: never\n\t}\n\t| {\n\t\tentityName: string\n\t\tfields: readonly string[]\n\t\tindexName?: never\n\t}\n\nexport class RemoveIndexDiffer implements Differ {\n\tcreateDiff(originalSchema: Schema, updatedSchema: Schema) {\n\t\treturn Object.values(originalSchema.model.entities).flatMap(entity =>\n\t\t\tentity.indexes\n\t\t\t\t.filter(\n\t\t\t\t\tit => {\n\t\t\t\t\t\tconst updatedEntity = updatedSchema.model.entities[entity.name]\n\t\t\t\t\t\tif (!updatedEntity) {\n\t\t\t\t\t\t\treturn false\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn !updatedEntity.indexes.find(index => deepEqual(index, it))\n\t\t\t\t\t},\n\t\t\t\t)\n\t\t\t\t.map(index =>\n\t\t\t\t\tremoveIndexModification.createModification({\n\t\t\t\t\t\tentityName: entity.name,\n\t\t\t\t\t\tfields: index.fields,\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t)\n\t}\n}\n"],"names":[],"mappings":";;;;;AAQO,MAAM,+BAA2F;AAAA,EACvG,YAA6B,MAAoD,QAAgB;AAApE,SAAA,OAAA;AAAoD,SAAA,SAAA;AAAA,EAAiB;AAAA,EAE3F,UAAU,SAA2B,EAAE,kBAAkB,8BAAyE;AACxI,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,QAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,cAAc;AAC7C;AAAA,IACD;AACA,UAAM,SAAS,KAAK,UAAA;AAEpB,UAAM,UAAU,gBAAgB;AAAA,MAC/B;AAAA,MACA;AAAA,MACA,OAAO,KAAK,OAAO;AAAA,IAAA,CACnB;AAED,UAAM,aAAa,iBAAiB,QAAQ,OAAO,EAAE,WAAW,OAAO,WAAW,aAAa,SAAS,QAAQ,MAAA,CAAO,EAAE,SAAA;AAEzH,eAAW,QAAQ,YAAY;AAC9B,cAAQ,IAAI,cAAc,eAAe,IAAI,CAAC,EAAE;AAAA,IACjD;AACA,+BAAA;AAAA,EACD;AAAA,EAEO,mBAAkC;AACxC,UAAM,SAAS,KAAK,UAAA;AACpB,WAAO;AAAA,MACN,aAAa,KAAK,KAAK,YAAY,CAAC,EAAE,aAAa;AAClD,cAAM,UAAU,OAAO,QAAQ,OAAO,CAAA,OAAM,CAAC,UAAU,GAAG,QAAQ,MAAM,CAAC;AACzE,eAAO;AAAA,UACN,GAAG;AAAA,UACH;AAAA,QAAA;AAAA,MAEF,CAAC;AAAA,IAAA;AAAA,EAEH;AAAA,EAEA,WAAW;AACV,UAAM,SAAS,KAAK,UAAA;AACpB,WAAO,EAAE,SAAS,iBAAiB,OAAO,KAAK,IAAI,CAAC,eAAe,KAAK,KAAK,UAAU,GAAA;AAAA,EACxF;AAAA,EAEA,YAAY;AACX,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,UAAM,SAAS,eAAe,KAAK,OAChC,OAAO,QAAQ,KAAK,CAAA,OAAM,GAAG,SAAS,KAAK,KAAK,SAAS,GAAG,SAC5D,KAAK,KAAK;AACb,QAAI,CAAC,QAAQ;AACZ,YAAM,IAAI,MAAA;AAAA,IACX;AACA,WAAO;AAAA,EACR;AACD;AAEO,MAAM,0BAA0B,uBAAuB;AAAA,EAC7D,IAAI;AAAA,EACJ,SAAS;AACV,CAAC;AAcM,MAAM,kBAAoC;AAAA,EAChD,WAAW,gBAAwB,eAAuB;AACzD,WAAO,OAAO,OAAO,eAAe,MAAM,QAAQ,EAAE;AAAA,MAAQ,CAAA,WAC3D,OAAO,QACL;AAAA,QACA,CAAA,OAAM;AACL,gBAAM,gBAAgB,cAAc,MAAM,SAAS,OAAO,IAAI;AAC9D,cAAI,CAAC,eAAe;AACnB,mBAAO;AAAA,UACR;AACA,iBAAO,CAAC,cAAc,QAAQ,KAAK,WAAS,UAAU,OAAO,EAAE,CAAC;AAAA,QACjE;AAAA,MAAA,EAEA;AAAA,QAAI,CAAA,UACJ,wBAAwB,mBAAmB;AAAA,UAC1C,YAAY,OAAO;AAAA,UACnB,QAAQ,MAAM;AAAA,QAAA,CACd;AAAA,MAAA;AAAA,IACF;AAAA,EAEH;AACD;"}
+{"version":3,"file":"RemoveIndexModification.js","sources":["../../../../../../packages/schema-migrations/src/modifications/indexes/RemoveIndexModification.ts"],"sourcesContent":["import { MigrationBuilder } from '@contember/database-migrations'\nimport { Model, Schema } from '@contember/schema'\nimport { SchemaUpdater, updateEntity, updateModel } from '../utils/schemaUpdateUtils.js'\nimport { createModificationType, Differ, ModificationHandler, ModificationHandlerCreateSqlOptions } from '../ModificationHandler.js'\nimport deepEqual from 'fast-deep-equal'\nimport { getIndexColumns } from './utils.js'\nimport { wrapIdentifier } from '../../utils/dbHelpers.js'\n\ntype IndexIdentity = Pick<Model.Index, 'fields' | 'where' | 'include' | 'columnOptions' | 'method' | 'opClass'>\nconst indexIdentityEquals = (a: IndexIdentity, b: IndexIdentity) =>\n\tdeepEqual(a.fields, b.fields)\n\t&& (a.where ?? undefined) === (b.where ?? undefined)\n\t&& deepEqual(a.include ?? undefined, b.include ?? undefined)\n\t&& deepEqual(a.columnOptions ?? undefined, b.columnOptions ?? undefined)\n\t&& (a.method ?? undefined) === (b.method ?? undefined)\n\t&& (a.opClass ?? undefined) === (b.opClass ?? undefined)\n\nexport class RemoveIndexModificationHandler implements ModificationHandler<RemoveIndexModificationData> {\n\tconstructor(private readonly data: RemoveIndexModificationData, private readonly schema: Schema) {}\n\n\tpublic createSql(builder: MigrationBuilder, { databaseMetadata, invalidateDatabaseMetadata }: ModificationHandlerCreateSqlOptions): void {\n\t\tconst entity = this.schema.model.entities[this.data.entityName]\n\t\tif (entity.view && !entity.view.materialized) {\n\t\t\treturn\n\t\t}\n\t\tconst index = this.getIndex()\n\n\t\t// The DB-metadata layer (DatabaseMetadataResolver) exposes only table + columns (as an unordered\n\t\t// set) + uniqueness, so the physical DROP is matched by table + columns. Postgres' pg_index.indkey\n\t\t// includes the INCLUDE columns alongside the key columns, so a covering index's metadata lists both —\n\t\t// we match the same combined set here. Everything else that distinguishes two indexes on the same\n\t\t// column set — the partial WHERE predicate, per-column options (sort order / NULLS / operator class),\n\t\t// key-column ORDER (the set comparison is order-insensitive), the index method, and the index-level\n\t\t// operator class — is invisible to the metadata, so such siblings are indistinguishable here. We\n\t\t// detect that ambiguity below and fail loudly rather than DROP a sibling the schema still expects to\n\t\t// keep. Schema-level identity (see getSchemaUpdater) IS fully aware of these discriminators, so the\n\t\t// diff itself never conflates them.\n\t\tconst columns = [\n\t\t\t...getIndexColumns({ entity, fields: index.fields, model: this.schema.model }),\n\t\t\t...(index.include ? getIndexColumns({ entity, fields: index.include, model: this.schema.model }) : []),\n\t\t]\n\n\t\tconst indexNames = databaseMetadata.indexes.filter({ tableName: entity.tableName, columnNames: columns, unique: false }).getNames()\n\n\t\t// If more than one physical index matches these columns we cannot tell which one this modification\n\t\t// targets (the metadata hides the predicate / per-column options / column order / index method /\n\t\t// index-level operator class that distinguish them). Dropping every match would silently take out an\n\t\t// index the schema still expects — refuse instead, so the obsolete one can be dropped by hand.\n\t\tif (indexNames.length > 1) {\n\t\t\tthrow new Error(\n\t\t\t\t`Cannot unambiguously drop index on entity ${this.data.entityName} (${index.fields.join(', ')}): `\n\t\t\t\t\t+ `${indexNames.length} indexes match these columns and the database metadata does not expose the predicate (where), `\n\t\t\t\t\t+ `per-column options (sort order / NULLS / operator class), column order, index method or index-level operator class that distinguish them. `\n\t\t\t\t\t+ `Drop the obsolete index manually.`,\n\t\t\t)\n\t\t}\n\n\t\tfor (const name of indexNames) {\n\t\t\tbuilder.sql(`DROP INDEX ${wrapIdentifier(name)}`)\n\t\t}\n\t\tinvalidateDatabaseMetadata()\n\t}\n\n\tpublic getSchemaUpdater(): SchemaUpdater {\n\t\tconst index = this.getIndex()\n\t\treturn updateModel(\n\t\t\tupdateEntity(this.data.entityName, ({ entity }) => {\n\t\t\t\tconst indexes = entity.indexes.filter(it => !indexIdentityEquals(it, index))\n\t\t\t\treturn {\n\t\t\t\t\t...entity,\n\t\t\t\t\tindexes,\n\t\t\t\t}\n\t\t\t}),\n\t\t)\n\t}\n\n\tdescribe() {\n\t\tconst index = this.getIndex()\n\t\treturn { message: `Remove index (${index.fields.join(', ')}) on entity ${this.data.entityName}` }\n\t}\n\n\tprivate getIndex(): IndexIdentity {\n\t\tconst { entityName } = this.data\n\t\tconst entity = this.schema.model.entities[entityName]\n\t\tif ('indexName' in this.data && this.data.indexName !== undefined) {\n\t\t\tconst index = entity.indexes.find(it => it.name === this.data.indexName)\n\t\t\tif (!index) {\n\t\t\t\tthrow new Error(`Index named \"${this.data.indexName}\" not found on entity ${entityName}`)\n\t\t\t}\n\t\t\treturn {\n\t\t\t\tfields: index.fields,\n\t\t\t\twhere: index.where,\n\t\t\t\tinclude: index.include,\n\t\t\t\tcolumnOptions: index.columnOptions,\n\t\t\t\tmethod: index.method,\n\t\t\t\topClass: index.opClass,\n\t\t\t}\n\t\t}\n\t\tif (!this.data.fields) {\n\t\t\tthrow new Error(`removeIndex modification on entity ${entityName} requires either \"indexName\" or \"fields\"`)\n\t\t}\n\t\treturn {\n\t\t\tfields: this.data.fields,\n\t\t\twhere: this.data.where,\n\t\t\tinclude: this.data.include,\n\t\t\tcolumnOptions: this.data.columnOptions,\n\t\t\tmethod: this.data.method,\n\t\t\topClass: this.data.opClass,\n\t\t}\n\t}\n}\n\nexport const removeIndexModification = createModificationType({\n\tid: 'removeIndex',\n\thandler: RemoveIndexModificationHandler,\n})\n\nexport type RemoveIndexModificationData =\n\t| {\n\t\tentityName: string\n\t\tindexName: string\n\t\tfields?: never\n\t\twhere?: never\n\t\tinclude?: never\n\t\tcolumnOptions?: never\n\t\tmethod?: never\n\t\topClass?: never\n\t}\n\t| {\n\t\tentityName: string\n\t\tfields: readonly string[]\n\t\twhere?: string\n\t\tinclude?: readonly string[]\n\t\tcolumnOptions?: { readonly [field: string]: Model.IndexColumnOptions }\n\t\tmethod?: Model.IndexMethod\n\t\topClass?: string\n\t\tindexName?: never\n\t}\n\nexport class RemoveIndexDiffer implements Differ {\n\tcreateDiff(originalSchema: Schema, updatedSchema: Schema) {\n\t\treturn Object.values(originalSchema.model.entities).flatMap(entity =>\n\t\t\tentity.indexes\n\t\t\t\t.filter(\n\t\t\t\t\tit => {\n\t\t\t\t\t\tconst updatedEntity = updatedSchema.model.entities[entity.name]\n\t\t\t\t\t\tif (!updatedEntity) {\n\t\t\t\t\t\t\treturn false\n\t\t\t\t\t\t}\n\t\t\t\t\t\treturn !updatedEntity.indexes.find(index => deepEqual(index, it))\n\t\t\t\t\t},\n\t\t\t\t)\n\t\t\t\t.map(index =>\n\t\t\t\t\tremoveIndexModification.createModification({\n\t\t\t\t\t\tentityName: entity.name,\n\t\t\t\t\t\tfields: index.fields,\n\t\t\t\t\t\t// keep every identity-bearing option (WHERE/INCLUDE/columnOptions/method/opClass) in the\n\t\t\t\t\t\t// modification so indexes that share the same key columns but differ by any of them are\n\t\t\t\t\t\t// removed individually; omit the keys when absent to keep legacy migration JSON\n\t\t\t\t\t\t// byte-for-byte identical.\n\t\t\t\t\t\t...(index.where !== undefined ? { where: index.where } : {}),\n\t\t\t\t\t\t...(index.include !== undefined ? { include: index.include } : {}),\n\t\t\t\t\t\t...(index.columnOptions !== undefined ? { columnOptions: index.columnOptions } : {}),\n\t\t\t\t\t\t...(index.method !== undefined ? { method: index.method } : {}),\n\t\t\t\t\t\t...(index.opClass !== undefined ? { opClass: index.opClass } : {}),\n\t\t\t\t\t})\n\t\t\t\t)\n\t\t)\n\t}\n}\n"],"names":[],"mappings":";;;;;AASA,MAAM,sBAAsB,CAAC,GAAkB,MAC9C,UAAU,EAAE,QAAQ,EAAE,MAAM,MACxB,EAAE,SAAS,aAAgB,EAAE,SAAS,WACvC,UAAU,EAAE,WAAW,QAAW,EAAE,WAAW,MAAS,KACxD,UAAU,EAAE,iBAAiB,QAAW,EAAE,iBAAiB,MAAS,MACnE,EAAE,UAAU,aAAgB,EAAE,UAAU,YACxC,EAAE,WAAW,aAAgB,EAAE,WAAW;AAExC,MAAM,+BAA2F;AAAA,EACvG,YAA6B,MAAoD,QAAgB;AAApE,SAAA,OAAA;AAAoD,SAAA,SAAA;AAAA,EAAiB;AAAA,EAE3F,UAAU,SAA2B,EAAE,kBAAkB,8BAAyE;AACxI,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,KAAK,KAAK,UAAU;AAC9D,QAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,cAAc;AAC7C;AAAA,IACD;AACA,UAAM,QAAQ,KAAK,SAAA;AAYnB,UAAM,UAAU;AAAA,MACf,GAAG,gBAAgB,EAAE,QAAQ,QAAQ,MAAM,QAAQ,OAAO,KAAK,OAAO,OAAO;AAAA,MAC7E,GAAI,MAAM,UAAU,gBAAgB,EAAE,QAAQ,QAAQ,MAAM,SAAS,OAAO,KAAK,OAAO,MAAA,CAAO,IAAI,CAAA;AAAA,IAAC;AAGrG,UAAM,aAAa,iBAAiB,QAAQ,OAAO,EAAE,WAAW,OAAO,WAAW,aAAa,SAAS,QAAQ,MAAA,CAAO,EAAE,SAAA;AAMzH,QAAI,WAAW,SAAS,GAAG;AAC1B,YAAM,IAAI;AAAA,QACT,6CAA6C,KAAK,KAAK,UAAU,KAAK,MAAM,OAAO,KAAK,IAAI,CAAC,MACvF,WAAW,MAAM;AAAA,MAAA;AAAA,IAIzB;AAEA,eAAW,QAAQ,YAAY;AAC9B,cAAQ,IAAI,cAAc,eAAe,IAAI,CAAC,EAAE;AAAA,IACjD;AACA,+BAAA;AAAA,EACD;AAAA,EAEO,mBAAkC;AACxC,UAAM,QAAQ,KAAK,SAAA;AACnB,WAAO;AAAA,MACN,aAAa,KAAK,KAAK,YAAY,CAAC,EAAE,aAAa;AAClD,cAAM,UAAU,OAAO,QAAQ,OAAO,QAAM,CAAC,oBAAoB,IAAI,KAAK,CAAC;AAC3E,eAAO;AAAA,UACN,GAAG;AAAA,UACH;AAAA,QAAA;AAAA,MAEF,CAAC;AAAA,IAAA;AAAA,EAEH;AAAA,EAEA,WAAW;AACV,UAAM,QAAQ,KAAK,SAAA;AACnB,WAAO,EAAE,SAAS,iBAAiB,MAAM,OAAO,KAAK,IAAI,CAAC,eAAe,KAAK,KAAK,UAAU,GAAA;AAAA,EAC9F;AAAA,EAEQ,WAA0B;AACjC,UAAM,EAAE,eAAe,KAAK;AAC5B,UAAM,SAAS,KAAK,OAAO,MAAM,SAAS,UAAU;AACpD,QAAI,eAAe,KAAK,QAAQ,KAAK,KAAK,cAAc,QAAW;AAClE,YAAM,QAAQ,OAAO,QAAQ,KAAK,QAAM,GAAG,SAAS,KAAK,KAAK,SAAS;AACvE,UAAI,CAAC,OAAO;AACX,cAAM,IAAI,MAAM,gBAAgB,KAAK,KAAK,SAAS,yBAAyB,UAAU,EAAE;AAAA,MACzF;AACA,aAAO;AAAA,QACN,QAAQ,MAAM;AAAA,QACd,OAAO,MAAM;AAAA,QACb,SAAS,MAAM;AAAA,QACf,eAAe,MAAM;AAAA,QACrB,QAAQ,MAAM;AAAA,QACd,SAAS,MAAM;AAAA,MAAA;AAAA,IAEjB;AACA,QAAI,CAAC,KAAK,KAAK,QAAQ;AACtB,YAAM,IAAI,MAAM,sCAAsC,UAAU,0CAA0C;AAAA,IAC3G;AACA,WAAO;AAAA,MACN,QAAQ,KAAK,KAAK;AAAA,MAClB,OAAO,KAAK,KAAK;AAAA,MACjB,SAAS,KAAK,KAAK;AAAA,MACnB,eAAe,KAAK,KAAK;AAAA,MACzB,QAAQ,KAAK,KAAK;AAAA,MAClB,SAAS,KAAK,KAAK;AAAA,IAAA;AAAA,EAErB;AACD;AAEO,MAAM,0BAA0B,uBAAuB;AAAA,EAC7D,IAAI;AAAA,EACJ,SAAS;AACV,CAAC;AAwBM,MAAM,kBAAoC;AAAA,EAChD,WAAW,gBAAwB,eAAuB;AACzD,WAAO,OAAO,OAAO,eAAe,MAAM,QAAQ,EAAE;AAAA,MAAQ,CAAA,WAC3D,OAAO,QACL;AAAA,QACA,CAAA,OAAM;AACL,gBAAM,gBAAgB,cAAc,MAAM,SAAS,OAAO,IAAI;AAC9D,cAAI,CAAC,eAAe;AACnB,mBAAO;AAAA,UACR;AACA,iBAAO,CAAC,cAAc,QAAQ,KAAK,WAAS,UAAU,OAAO,EAAE,CAAC;AAAA,QACjE;AAAA,MAAA,EAEA;AAAA,QAAI,CAAA,UACJ,wBAAwB,mBAAmB;AAAA,UAC1C,YAAY,OAAO;AAAA,UACnB,QAAQ,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA,UAKd,GAAI,MAAM,UAAU,SAAY,EAAE,OAAO,MAAM,MAAA,IAAU,CAAA;AAAA,UACzD,GAAI,MAAM,YAAY,SAAY,EAAE,SAAS,MAAM,QAAA,IAAY,CAAA;AAAA,UAC/D,GAAI,MAAM,kBAAkB,SAAY,EAAE,eAAe,MAAM,cAAA,IAAkB,CAAA;AAAA,UACjF,GAAI,MAAM,WAAW,SAAY,EAAE,QAAQ,MAAM,OAAA,IAAW,CAAA;AAAA,UAC5D,GAAI,MAAM,YAAY,SAAY,EAAE,SAAS,MAAM,YAAY,CAAA;AAAA,QAAC,CAChE;AAAA,MAAA;AAAA,IACF;AAAA,EAEH;AACD;"}

package/dist/development/src/modifications/relations/ConvertManyHasManyToJoiningEntityModification.cjs

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const schema = require("@contember/schema");
+const schemaUpdateUtils = require("../utils/schemaUpdateUtils.cjs");
+const ModificationHandler = require("../ModificationHandler.cjs");
+const sqlUpdateUtils = require("../utils/sqlUpdateUtils.cjs");
+const columnUtils = require("../utils/columnUtils.cjs");
+const dbHelpers = require("../../utils/dbHelpers.cjs");
+const ModificationVersions = require("../ModificationVersions.cjs");
+class ConvertManyHasManyToJoiningEntityModificationHandler {
+  constructor(data, schema2, options) {
+    this.data = data;
+    this.schema = schema2;
+    this.options = options;
+  }
+  createSql(builder, { systemSchema }) {
+    const { relation } = this.getRelation();
+    const joiningTable = relation.joiningTable;
+    const tableName = joiningTable.tableName;
+    const tableNameId = dbHelpers.wrapIdentifier(tableName);
+    const joiningEntity = this.data.joiningEntity;
+    const primaryColumn = joiningEntity.fields[joiningEntity.primary];
+    const primaryColumnName = primaryColumn.columnName;
+    const primaryColumnNameId = dbHelpers.wrapIdentifier(primaryColumnName);
+    const primaryColumnType = columnUtils.getColumnSqlType(primaryColumn);
+    if (joiningTable.eventLog.enabled) {
+      sqlUpdateUtils.dropEventTrigger(builder, tableName);
+      sqlUpdateUtils.dropEventTrxTrigger(builder, tableName);
+    }
+    builder.sql(`ALTER TABLE ${tableNameId} ADD COLUMN ${primaryColumnNameId} ${primaryColumnType}`);
+    builder.sql(ensureUuidGenerator(systemSchema));
+    builder.sql(`UPDATE ${tableNameId} SET ${primaryColumnNameId} = ${uuidGenerator(systemSchema)}`);
+    builder.sql(`ALTER TABLE ${tableNameId} ALTER COLUMN ${primaryColumnNameId} SET NOT NULL`);
+    builder.sql(`ALTER TABLE ${tableNameId} DROP CONSTRAINT ${dbHelpers.wrapIdentifier(`${tableName}_pkey`)}`);
+    builder.sql(`ALTER TABLE ${tableNameId} ADD PRIMARY KEY (${primaryColumnNameId})`);
+    builder.sql(
+      `ALTER TABLE ${tableNameId} ADD UNIQUE (${dbHelpers.wrapIdentifier(joiningTable.joiningColumn.columnName)}, ${dbHelpers.wrapIdentifier(joiningTable.inverseJoiningColumn.columnName)})`
+    );
+    if (joiningEntity.eventLog?.enabled !== false) {
+      sqlUpdateUtils.createEventTrigger(builder, systemSchema, tableName, [primaryColumnName]);
+      sqlUpdateUtils.createEventTrxTrigger(builder, systemSchema, tableName);
+    }
+  }
+  getSchemaUpdater() {
+    const { entity, relation } = this.getRelation();
+    const version = this.options.formatVersion ?? ModificationVersions.VERSION_LATEST;
+    const joiningEntity = this.data.joiningEntity;
+    const joinUniqueConstraint = this.getJoinUniqueConstraint();
+    return schemaUpdateUtils.updateSchema(
+      // remove the original many-has-many (owning side + inverse side)
+      schemaUpdateUtils.removeField(entity.name, relation.name, version),
+      // register the new joining entity reusing the junction table
+      schemaUpdateUtils.updateModel(({ model }) => ({
+        ...model,
+        entities: {
+          ...model.entities,
+          [joiningEntity.name]: {
+            eventLog: { enabled: true },
+            ...joiningEntity,
+            // Keep the schema in sync with the join-uniqueness constraint emitted by createSql.
+            unique: [...Object.values(joiningEntity.unique ?? []), joinUniqueConstraint],
+            indexes: Object.values(joiningEntity.indexes ?? [])
+          }
+        }
+      })),
+      // add inverse one-has-many relations on both connected entities
+      this.data.sourceInverseSide ? schemaUpdateUtils.updateModel(schemaUpdateUtils.updateEntity(entity.name, schemaUpdateUtils.addField(this.data.sourceInverseSide))) : void 0,
+      this.data.targetInverseSide ? schemaUpdateUtils.updateModel(schemaUpdateUtils.updateEntity(relation.target, schemaUpdateUtils.addField(this.data.targetInverseSide))) : void 0
+    );
+  }
+  describe() {
+    return {
+      message: `Converts ManyHasMany relation ${this.data.entityName}.${this.data.fieldName} to a joining entity ${this.data.joiningEntity.name}`
+    };
+  }
+  /**
+   * The join-uniqueness constraint (relationA, relationB) that replaces the dropped composite
+   * primary key. The field names are resolved from the joining entity's two many-has-one relations
+   * by matching their joining columns against the original junction columns, so the constraint
+   * references schema field names (not raw column names).
+   */
+  getJoinUniqueConstraint() {
+    const { relation } = this.getRelation();
+    const joiningTable = relation.joiningTable;
+    const joiningEntity = this.data.joiningEntity;
+    const findRelationField = (columnName) => {
+      const field = Object.values(joiningEntity.fields).find(
+        (it) => "joiningColumn" in it && it.joiningColumn.columnName === columnName
+      );
+      if (!field) {
+        throw new Error(
+          `Joining entity ${joiningEntity.name} has no many-has-one relation mapped to column ${columnName}`
+        );
+      }
+      return field.name;
+    };
+    return {
+      fields: [
+        findRelationField(joiningTable.joiningColumn.columnName),
+        findRelationField(joiningTable.inverseJoiningColumn.columnName)
+      ]
+    };
+  }
+  getRelation() {
+    const entity = this.schema.model.entities[this.data.entityName];
+    const relation = entity.fields[this.data.fieldName];
+    if (!relation || relation.type !== schema.Model.RelationType.ManyHasMany || !("joiningTable" in relation)) {
+      throw new Error(`${this.data.entityName}.${this.data.fieldName} is not a many-has-many owning relation`);
+    }
+    return { entity, relation };
+  }
+}
+const uuidGenerator = (systemSchema) => `${dbHelpers.wrapIdentifier(systemSchema)}."uuid_generate_v4"()`;
+const ensureUuidGenerator = (systemSchema) => {
+  const systemSchemaId = dbHelpers.wrapIdentifier(systemSchema);
+  return `DO $ensure_uuid$
+BEGIN
+	IF NOT EXISTS(
+		SELECT FROM pg_proc
+		JOIN pg_namespace ON pg_proc.pronamespace = pg_namespace.oid
+		WHERE pg_namespace.nspname = ${quoteLiteral(systemSchema)} AND pg_proc.proname = 'uuid_generate_v4'
+	) THEN
+		CREATE FUNCTION ${systemSchemaId}."uuid_generate_v4"() RETURNS "uuid"
+		LANGUAGE "sql"
+		AS $ensure_uuid_body$
+			SELECT OVERLAY(OVERLAY(md5(random()::TEXT || ':' || clock_timestamp()::TEXT) PLACING '4' FROM 13) PLACING
+				to_hex(floor(random() * (11 - 8 + 1) + 8)::INT)::TEXT FROM 17)::UUID;
+		$ensure_uuid_body$;
+	END IF;
+END
+$ensure_uuid$;`;
+};
+const quoteLiteral = (value) => `'${value.replace(/'/g, "''")}'`;
+const convertManyHasManyToJoiningEntityModification = ModificationHandler.createModificationType({
+  id: "convertManyHasManyToJoiningEntity",
+  handler: ConvertManyHasManyToJoiningEntityModificationHandler
+});
+exports.ConvertManyHasManyToJoiningEntityModificationHandler = ConvertManyHasManyToJoiningEntityModificationHandler;
+exports.convertManyHasManyToJoiningEntityModification = convertManyHasManyToJoiningEntityModification;
+//# sourceMappingURL=ConvertManyHasManyToJoiningEntityModification.cjs.map