@mikro-orm/knex 6.0.0-dev.32 → 6.0.0-dev.320

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/AbstractSqlConnection.d.ts +22 -4
  2. package/AbstractSqlConnection.js +45 -20
  3. package/AbstractSqlDriver.d.ts +30 -24
  4. package/AbstractSqlDriver.js +606 -268
  5. package/AbstractSqlPlatform.d.ts +9 -5
  6. package/AbstractSqlPlatform.js +25 -29
  7. package/MonkeyPatchable.d.ts +1 -0
  8. package/MonkeyPatchable.js +3 -0
  9. package/PivotCollectionPersister.d.ts +17 -0
  10. package/PivotCollectionPersister.js +128 -0
  11. package/README.md +64 -107
  12. package/SqlEntityManager.d.ts +4 -8
  13. package/SqlEntityManager.js +8 -12
  14. package/SqlEntityRepository.d.ts +7 -5
  15. package/SqlEntityRepository.js +11 -7
  16. package/index.mjs +24 -3
  17. package/package.json +8 -8
  18. package/query/ArrayCriteriaNode.d.ts +3 -2
  19. package/query/ArrayCriteriaNode.js +7 -2
  20. package/query/CriteriaNode.d.ts +6 -4
  21. package/query/CriteriaNode.js +22 -9
  22. package/query/CriteriaNodeFactory.d.ts +1 -1
  23. package/query/CriteriaNodeFactory.js +27 -11
  24. package/query/ObjectCriteriaNode.d.ts +3 -2
  25. package/query/ObjectCriteriaNode.js +72 -28
  26. package/query/QueryBuilder.d.ts +69 -36
  27. package/query/QueryBuilder.js +469 -146
  28. package/query/QueryBuilderHelper.d.ts +13 -18
  29. package/query/QueryBuilderHelper.js +199 -171
  30. package/query/ScalarCriteriaNode.d.ts +3 -2
  31. package/query/ScalarCriteriaNode.js +14 -4
  32. package/query/enums.d.ts +7 -0
  33. package/query/enums.js +10 -2
  34. package/schema/DatabaseSchema.d.ts +5 -2
  35. package/schema/DatabaseSchema.js +26 -8
  36. package/schema/DatabaseTable.d.ts +12 -4
  37. package/schema/DatabaseTable.js +370 -42
  38. package/schema/SchemaComparator.d.ts +7 -5
  39. package/schema/SchemaComparator.js +69 -35
  40. package/schema/SchemaHelper.d.ts +7 -5
  41. package/schema/SchemaHelper.js +30 -11
  42. package/schema/SqlSchemaGenerator.d.ts +11 -48
  43. package/schema/SqlSchemaGenerator.js +84 -30
  44. package/typings.d.ts +27 -8
@@ -6,14 +6,19 @@ const core_1 = require("@mikro-orm/core");
6
6
  * @internal
7
7
  */
8
8
  class DatabaseTable {
9
+ platform;
10
+ name;
11
+ schema;
12
+ columns = {};
13
+ indexes = [];
14
+ checks = [];
15
+ foreignKeys = {};
16
+ nativeEnums = {}; // for postgres
17
+ comment;
9
18
  constructor(platform, name, schema) {
10
19
  this.platform = platform;
11
20
  this.name = name;
12
21
  this.schema = schema;
13
- this.columns = {};
14
- this.indexes = [];
15
- this.checks = [];
16
- this.foreignKeys = {};
17
22
  Object.defineProperties(this, {
18
23
  platform: { enumerable: false, writable: true },
19
24
  });
@@ -24,8 +29,11 @@ class DatabaseTable {
24
29
  getColumn(name) {
25
30
  return this.columns[name];
26
31
  }
32
+ removeColumn(name) {
33
+ delete this.columns[name];
34
+ }
27
35
  getIndexes() {
28
- return this.indexes;
36
+ return core_1.Utils.removeDuplicates(this.indexes);
29
37
  }
30
38
  getChecks() {
31
39
  return this.checks;
@@ -41,7 +49,7 @@ class DatabaseTable {
41
49
  const type = v.name in enums ? 'enum' : v.type;
42
50
  v.mappedType = this.platform.getMappedType(type);
43
51
  v.default = v.default?.toString().startsWith('nextval(') ? null : v.default;
44
- v.enumItems = enums[v.name] || [];
52
+ v.enumItems ??= enums[v.name] || [];
45
53
  o[v.name] = v;
46
54
  return o;
47
55
  }, {});
@@ -49,7 +57,7 @@ class DatabaseTable {
49
57
  addColumn(column) {
50
58
  this.columns[column.name] = column;
51
59
  }
52
- addColumnFromProperty(prop, meta) {
60
+ addColumnFromProperty(prop, meta, config) {
53
61
  prop.fieldNames.forEach((field, idx) => {
54
62
  const type = prop.enum ? 'enum' : prop.columnTypes[idx];
55
63
  const mappedType = this.platform.getMappedType(type);
@@ -57,28 +65,36 @@ class DatabaseTable {
57
65
  const match = prop.columnTypes[idx].match(/\w+\((\d+), ?(\d+)\)/);
58
66
  /* istanbul ignore else */
59
67
  if (match) {
60
- prop.precision = +match[1];
61
- prop.scale = +match[2];
68
+ prop.precision ??= +match[1];
69
+ prop.scale ??= +match[2];
62
70
  prop.length = undefined;
63
71
  }
64
72
  }
65
73
  if (mappedType instanceof core_1.DateTimeType) {
66
- prop.length ??= this.platform.getDefaultDateTimeLength();
74
+ const match = prop.columnTypes[idx].match(/\w+\((\d+)\)/);
75
+ if (match) {
76
+ prop.length ??= +match[1];
77
+ }
78
+ else {
79
+ prop.length ??= this.platform.getDefaultDateTimeLength();
80
+ }
67
81
  }
68
82
  const primary = !meta.compositePK && !!prop.primary && prop.kind === core_1.ReferenceKind.SCALAR && this.platform.isNumericColumn(mappedType);
69
83
  this.columns[field] = {
70
84
  name: prop.fieldNames[idx],
71
85
  type: prop.columnTypes[idx],
86
+ generated: prop.generated,
72
87
  mappedType,
73
88
  unsigned: prop.unsigned && this.platform.isNumericColumn(mappedType),
74
89
  autoincrement: prop.autoincrement ?? primary,
75
90
  primary,
76
- nullable: !!prop.nullable,
91
+ nullable: this.columns[field]?.nullable ?? !!prop.nullable,
92
+ nativeEnumName: prop.nativeEnumName,
77
93
  length: prop.length,
78
94
  precision: prop.precision,
79
95
  scale: prop.scale,
80
96
  default: prop.defaultRaw,
81
- enumItems: prop.items?.every(core_1.Utils.isString) ? prop.items : undefined,
97
+ enumItems: prop.nativeEnumName || prop.items?.every(core_1.Utils.isString) ? prop.items : undefined,
82
98
  comment: prop.comment,
83
99
  extra: prop.extra,
84
100
  ignoreSchemaChanges: prop.ignoreSchemaChanges,
@@ -89,7 +105,7 @@ class DatabaseTable {
89
105
  });
90
106
  if ([core_1.ReferenceKind.MANY_TO_ONE, core_1.ReferenceKind.ONE_TO_ONE].includes(prop.kind)) {
91
107
  const constraintName = this.getIndexName(true, prop.fieldNames, 'foreign');
92
- let schema = prop.targetMeta.schema === '*' ? this.schema : prop.targetMeta.schema ?? this.schema;
108
+ let schema = prop.targetMeta.root.schema === '*' ? this.schema : (prop.targetMeta.root.schema ?? config.get('schema', this.platform.getDefaultSchemaName()));
93
109
  if (prop.referencedTableName.includes('.')) {
94
110
  schema = undefined;
95
111
  }
@@ -113,6 +129,7 @@ class DatabaseTable {
113
129
  columnNames: prop.fieldNames,
114
130
  composite: prop.fieldNames.length > 1,
115
131
  keyName: this.getIndexName(prop.index, prop.fieldNames, 'index'),
132
+ constraint: false,
116
133
  primary: false,
117
134
  unique: false,
118
135
  });
@@ -122,6 +139,7 @@ class DatabaseTable {
122
139
  columnNames: prop.fieldNames,
123
140
  composite: prop.fieldNames.length > 1,
124
141
  keyName: this.getIndexName(prop.unique, prop.fieldNames, 'unique'),
142
+ constraint: !prop.fieldNames.some((d) => d.includes('.')),
125
143
  primary: false,
126
144
  unique: true,
127
145
  });
@@ -133,40 +151,285 @@ class DatabaseTable {
133
151
  }
134
152
  return this.platform.getIndexName(this.name, columnNames, type);
135
153
  }
136
- getEntityDeclaration(namingStrategy, schemaHelper) {
154
+ getEntityDeclaration(namingStrategy, schemaHelper, scalarPropertiesForRelations) {
155
+ const { fksOnColumnProps, fksOnStandaloneProps, columnFks, fkIndexes, nullableForeignKeys, skippedColumnNames, } = this.foreignKeysToProps(namingStrategy, scalarPropertiesForRelations);
137
156
  let name = namingStrategy.getClassName(this.name, '_');
138
157
  name = name.match(/^\d/) ? 'E' + name : name;
139
158
  const schema = new core_1.EntitySchema({ name, collection: this.name, schema: this.schema });
140
159
  const compositeFkIndexes = {};
141
160
  const compositeFkUniques = {};
142
- for (const index of this.indexes.filter(index => index.columnNames.length > 1)) {
143
- const properties = index.columnNames.map(col => this.getPropertyName(namingStrategy, this.getColumn(col)));
144
- const ret = { name: index.keyName, properties: core_1.Utils.unique(properties) };
145
- if (ret.properties.length === 1) {
161
+ const potentiallyUnmappedIndexes = this.indexes.filter(index => !index.primary // Skip primary index. Whether it's in use by scalar column or FK, it's already mapped.
162
+ && (index.columnNames.length > 1 // All composite indexes are to be mapped to entity decorators or FK props.
163
+ || !(index.columnNames[0] in columnFks) // Non-composite indexes for scalar props are to be mapped to the column.
164
+ || skippedColumnNames.includes(index.columnNames[0]) // Non-composite indexes for skipped columns are to be mapped as entity decorators.
165
+ )
166
+ // ignore indexes that don't have all column names (this can happen in sqlite where there is no way to infer this for expressions)
167
+ && !(index.columnNames.some(col => !col) && !index.expression));
168
+ for (const index of potentiallyUnmappedIndexes) {
169
+ const ret = { name: index.keyName };
170
+ // Index is for FK. Map to the FK prop and move on.
171
+ const fkForIndex = fkIndexes.get(index);
172
+ if (fkForIndex && !fkForIndex.fk.columnNames.some(col => !index.columnNames.includes(col))) {
173
+ ret.properties = [this.getPropertyName(namingStrategy, fkForIndex.baseName, fkForIndex.fk)];
146
174
  const map = index.unique ? compositeFkUniques : compositeFkIndexes;
147
175
  map[ret.properties[0]] = { keyName: index.keyName };
148
176
  continue;
149
177
  }
150
- if (index.primary) {
151
- //
178
+ const properties = this.getIndexProperties(index, columnFks, fksOnColumnProps, fksOnStandaloneProps, namingStrategy);
179
+ // If there is a column that cannot be unambiguously mapped to a prop, render an expression.
180
+ if (index.expression) {
181
+ ret.expression = index.expression;
152
182
  }
153
- else if (index.unique) {
154
- schema.addUnique(ret);
183
+ else if (typeof properties === 'undefined') {
184
+ ret.expression = schemaHelper.getCreateIndexSQL(this.name, index);
155
185
  }
156
186
  else {
157
- schema.addIndex(ret);
187
+ ret.properties = properties;
188
+ // If the index is for one property that is not a FK prop, map to the column prop and move on.
189
+ if (properties.length === 1 && !fksOnStandaloneProps.has(properties[0])) {
190
+ const map = index.unique ? compositeFkUniques : compositeFkIndexes;
191
+ map[properties[0]] = { keyName: index.keyName };
192
+ continue;
193
+ }
158
194
  }
195
+ // Composite indexes that aren't exclusively mapped to FK props get an entity decorator.
196
+ if (index.unique) {
197
+ schema.addUnique(ret);
198
+ continue;
199
+ }
200
+ schema.addIndex(ret);
159
201
  }
160
- for (const column of this.getColumns()) {
161
- const prop = this.getPropertyDeclaration(column, namingStrategy, schemaHelper, compositeFkIndexes, compositeFkUniques);
202
+ const addedStandaloneFkPropsBasedOnColumn = new Set;
203
+ const nonSkippedColumns = this.getColumns().filter(column => !skippedColumnNames.includes(column.name));
204
+ for (const column of nonSkippedColumns) {
205
+ const columnName = column.name;
206
+ const standaloneFkPropBasedOnColumn = fksOnStandaloneProps.get(columnName);
207
+ if (standaloneFkPropBasedOnColumn && !fksOnColumnProps.get(columnName)) {
208
+ addedStandaloneFkPropsBasedOnColumn.add(columnName);
209
+ const [fkIndex, currentFk] = standaloneFkPropBasedOnColumn;
210
+ const prop = this.getForeignKeyDeclaration(currentFk, namingStrategy, schemaHelper, fkIndex, nullableForeignKeys.has(currentFk), columnName);
211
+ schema.addProperty(prop.name, prop.type, prop);
212
+ }
213
+ const prop = this.getPropertyDeclaration(column, namingStrategy, schemaHelper, compositeFkIndexes, compositeFkUniques, columnFks, fksOnColumnProps.get(columnName));
214
+ schema.addProperty(prop.name, prop.type, prop);
215
+ }
216
+ for (const [propBaseName, [fkIndex, currentFk]] of fksOnStandaloneProps.entries()) {
217
+ if (addedStandaloneFkPropsBasedOnColumn.has(propBaseName)) {
218
+ continue;
219
+ }
220
+ const prop = this.getForeignKeyDeclaration(currentFk, namingStrategy, schemaHelper, fkIndex, nullableForeignKeys.has(currentFk), propBaseName);
162
221
  schema.addProperty(prop.name, prop.type, prop);
163
222
  }
164
223
  const meta = schema.init().meta;
165
- meta.relations
166
- .filter(prop => prop.primary && prop.kind === core_1.ReferenceKind.MANY_TO_ONE && !meta.compositePK)
167
- .forEach(prop => prop.kind = core_1.ReferenceKind.ONE_TO_ONE);
224
+ const oneToOneCandidateProperties = meta.relations
225
+ .filter(prop => prop.primary && prop.kind === core_1.ReferenceKind.MANY_TO_ONE);
226
+ if (oneToOneCandidateProperties.length === 1
227
+ && oneToOneCandidateProperties[0].fieldNames.length === (new Set(meta.getPrimaryProps().flatMap(prop => prop.fieldNames))).size) {
228
+ oneToOneCandidateProperties[0].kind = core_1.ReferenceKind.ONE_TO_ONE;
229
+ }
168
230
  return meta;
169
231
  }
232
+ foreignKeysToProps(namingStrategy, scalarPropertiesForRelations) {
233
+ const fks = Object.values(this.getForeignKeys());
234
+ const fksOnColumnProps = new Map();
235
+ const fksOnStandaloneProps = new Map();
236
+ const columnFks = {};
237
+ const fkIndexes = new Map();
238
+ const nullableForeignKeys = new Set();
239
+ for (const currentFk of fks) {
240
+ const fkIndex = this.findFkIndex(currentFk);
241
+ if (currentFk.columnNames.length === 1 && !fks.some(fk => fk !== currentFk && fk.columnNames.length === 1 && currentFk.columnNames[0] === fk.columnNames[0])) {
242
+ // Non-composite FK is the only possible one for a column. Render the column with it.
243
+ const columnName = currentFk.columnNames[0];
244
+ columnFks[columnName] ??= [];
245
+ columnFks[columnName].push(currentFk);
246
+ if (this.getColumn(columnName)?.nullable) {
247
+ nullableForeignKeys.add(currentFk);
248
+ }
249
+ if (scalarPropertiesForRelations === 'always') {
250
+ const baseName = this.getSafeBaseNameForFkProp(namingStrategy, currentFk, fks, columnName);
251
+ fksOnStandaloneProps.set(baseName, [fkIndex, currentFk]);
252
+ fkIndexes.set(fkIndex, { fk: currentFk, baseName });
253
+ }
254
+ else {
255
+ fksOnColumnProps.set(columnName, currentFk);
256
+ fkIndexes.set(fkIndex, { fk: currentFk, baseName: columnName });
257
+ }
258
+ continue;
259
+ }
260
+ const specificColumnNames = [];
261
+ const nullableColumnsInFk = [];
262
+ for (const columnName of currentFk.columnNames) {
263
+ columnFks[columnName] ??= [];
264
+ columnFks[columnName].push(currentFk);
265
+ if (!fks.some(fk => fk !== currentFk && fk.columnNames.includes(columnName))) {
266
+ specificColumnNames.push(columnName);
267
+ }
268
+ if (this.getColumn(columnName)?.nullable) {
269
+ nullableColumnsInFk.push(columnName);
270
+ }
271
+ }
272
+ if (nullableColumnsInFk.length > 0) {
273
+ nullableForeignKeys.add(currentFk);
274
+ }
275
+ if (specificColumnNames.length === 1 && ((nullableColumnsInFk.length === currentFk.columnNames.length || nullableColumnsInFk.length === 0) || (nullableColumnsInFk.length === 1 && nullableColumnsInFk[0] === specificColumnNames[0]))) {
276
+ // Composite FK has exactly one column which is not used in any other FK.
277
+ // The FK also doesn't have a mix of nullable and non-nullable columns,
278
+ // or its only nullable column is this very one.
279
+ // It is safe to just render this FK attached to the specific column.
280
+ const columnName = specificColumnNames[0];
281
+ if (scalarPropertiesForRelations === 'always') {
282
+ const baseName = this.getSafeBaseNameForFkProp(namingStrategy, currentFk, fks, columnName);
283
+ fksOnStandaloneProps.set(baseName, [fkIndex, currentFk]);
284
+ fkIndexes.set(fkIndex, { fk: currentFk, baseName });
285
+ }
286
+ else {
287
+ fksOnColumnProps.set(columnName, currentFk);
288
+ fkIndexes.set(fkIndex, { fk: currentFk, baseName: columnName });
289
+ }
290
+ continue;
291
+ }
292
+ if (specificColumnNames.length === currentFk.columnNames.length) {
293
+ // All columns involved with this FK are only covered by this one FK.
294
+ if (nullableColumnsInFk.length <= 1) {
295
+ // Also, this FK is either not nullable, or has only one nullable column.
296
+ // It is safe to name the FK after the nullable column, or any non-nullable one (the first one is picked).
297
+ const columnName = nullableColumnsInFk.at(0) ?? currentFk.columnNames[0];
298
+ if (scalarPropertiesForRelations === 'always') {
299
+ const baseName = this.getSafeBaseNameForFkProp(namingStrategy, currentFk, fks, columnName);
300
+ fksOnStandaloneProps.set(baseName, [fkIndex, currentFk]);
301
+ fkIndexes.set(fkIndex, { fk: currentFk, baseName });
302
+ }
303
+ else {
304
+ fksOnColumnProps.set(columnName, currentFk);
305
+ fkIndexes.set(fkIndex, { fk: currentFk, baseName: columnName });
306
+ }
307
+ continue;
308
+ }
309
+ // If the first nullable column's name with FK is different from the name without FK,
310
+ // name a standalone prop after the column, but treat the column prop itself as not having FK.
311
+ const columnName = nullableColumnsInFk[0];
312
+ const baseName = this.getSafeBaseNameForFkProp(namingStrategy, currentFk, fks, columnName);
313
+ fksOnStandaloneProps.set(baseName, [fkIndex, currentFk]);
314
+ fkIndexes.set(fkIndex, { fk: currentFk, baseName });
315
+ continue;
316
+ }
317
+ // FK is not unambiguously mappable to a column. Pick another name for a standalone FK prop.
318
+ const baseName = this.getSafeBaseNameForFkProp(namingStrategy, currentFk, fks);
319
+ fksOnStandaloneProps.set(baseName, [fkIndex, currentFk]);
320
+ fkIndexes.set(fkIndex, { fk: currentFk, baseName });
321
+ }
322
+ const columnsInFks = Object.keys(columnFks);
323
+ const skippingHandlers = {
324
+ // Never generate scalar props for composite keys,
325
+ // i.e. always skip columns if they are covered by foreign keys.
326
+ never: (column) => columnsInFks.includes(column.name) && !fksOnColumnProps.has(column.name),
327
+ // Always generate scalar props for composite keys,
328
+ // i.e. do not skip columns, even if they are covered by foreign keys.
329
+ always: (column) => false,
330
+ // Smart scalar props generation.
331
+ // Skips columns if they are covered by foreign keys.
332
+ // But also does not skip if the column is not nullable, and yet all involved FKs are nullable,
333
+ // or if one or more FKs involved has multiple nullable columns.
334
+ smart: (column) => {
335
+ return columnsInFks.includes(column.name)
336
+ && !fksOnColumnProps.has(column.name)
337
+ && (column.nullable
338
+ ? columnFks[column.name].some(fk => !fk.columnNames.some(fkColumnName => fkColumnName !== column.name && this.getColumn(fkColumnName)?.nullable))
339
+ : columnFks[column.name].some(fk => !nullableForeignKeys.has(fk)));
340
+ },
341
+ };
342
+ const skippedColumnNames = this.getColumns().filter(skippingHandlers[scalarPropertiesForRelations]).map(column => column.name);
343
+ return { fksOnColumnProps, fksOnStandaloneProps, columnFks, fkIndexes, nullableForeignKeys, skippedColumnNames };
344
+ }
345
+ findFkIndex(currentFk) {
346
+ const fkColumnsLength = currentFk.columnNames.length;
347
+ const possibleIndexes = this.indexes.filter(index => {
348
+ return index.columnNames.length >= fkColumnsLength && !currentFk.columnNames.some((columnName, i) => index.columnNames[i] !== columnName);
349
+ });
350
+ possibleIndexes.sort((a, b) => {
351
+ if (a.columnNames.length !== b.columnNames.length) {
352
+ return a.columnNames.length < b.columnNames.length ? -1 : 1;
353
+ }
354
+ if (a.primary !== b.primary) {
355
+ return a.primary ? -1 : 1;
356
+ }
357
+ if (a.unique !== b.unique) {
358
+ return a.unique ? -1 : 1;
359
+ }
360
+ return a.keyName.localeCompare(b.keyName);
361
+ });
362
+ return possibleIndexes[0];
363
+ }
364
+ getIndexProperties(index, columnFks, fksOnColumnProps, fksOnStandaloneProps, namingStrategy) {
365
+ const propBaseNames = new Set();
366
+ const columnNames = index.columnNames;
367
+ const l = columnNames.length;
368
+ if (columnNames.some(col => !col)) {
369
+ return;
370
+ }
371
+ for (let i = 0; i < l; ++i) {
372
+ const columnName = columnNames[i];
373
+ // The column is not involved with FKs.
374
+ // It has a prop named after it.
375
+ // Add it and move on.
376
+ if (!(columnName in columnFks)) {
377
+ propBaseNames.add(columnName);
378
+ continue;
379
+ }
380
+ // If the prop named after the column has a FK and the FK's columns are a subset of this index,
381
+ // include this prop and move on.
382
+ const columnPropFk = fksOnColumnProps.get(columnName);
383
+ if (columnPropFk && !columnPropFk.columnNames.some(fkColumnName => !columnNames.includes(fkColumnName))) {
384
+ propBaseNames.add(columnName);
385
+ continue;
386
+ }
387
+ // If there is at least one standalone FK featuring this column,
388
+ // and all of its columns are a subset of this index,
389
+ // include that FK, and consider mapping of this column to a prop a success.
390
+ let propAdded = false;
391
+ for (const [propName, [, fk]] of fksOnStandaloneProps) {
392
+ if (!columnFks[columnName].includes(fk)) {
393
+ continue;
394
+ }
395
+ if (!fk.columnNames.some(fkColumnName => !columnNames.includes(fkColumnName))) {
396
+ propBaseNames.add(propName);
397
+ propAdded = true;
398
+ }
399
+ }
400
+ if (propAdded) {
401
+ continue;
402
+ }
403
+ // If we have reached this point, it means the column is not mappable to a prop name.
404
+ // Break the whole prop creation.
405
+ return;
406
+ }
407
+ return Array.from(propBaseNames).map(baseName => this.getPropertyName(namingStrategy, baseName, fksOnColumnProps.get(baseName)));
408
+ }
409
+ getSafeBaseNameForFkProp(namingStrategy, currentFk, fks, columnName) {
410
+ if (columnName && this.getPropertyName(namingStrategy, columnName, currentFk) !== this.getPropertyName(namingStrategy, columnName)) {
411
+ // The eligible scalar column name is different from the name of the FK prop of the same column.
412
+ // Both can be safely rendered.
413
+ // Use the column name as a base for the FK prop.
414
+ return columnName;
415
+ }
416
+ if (!fks.some(fk => fk !== currentFk && fk.referencedTableName === currentFk.referencedTableName) && !this.getColumn(currentFk.referencedTableName)) {
417
+ // FK is the only one in this table that references this other table.
418
+ // The name of the referenced table is not shared with a column in this table,
419
+ // so it is safe to output prop name based on the referenced entity.
420
+ return currentFk.referencedTableName;
421
+ }
422
+ // Any ambiguous FK is rendered with a name based on the FK constraint name
423
+ let finalPropBaseName = currentFk.constraintName;
424
+ while (this.getColumn(finalPropBaseName)) {
425
+ // In the unlikely event that the FK constraint name is shared by a column name, generate a name by
426
+ // continuously prefixing with "fk_", until a non-existent column is hit.
427
+ // The worst case scenario is a very long name with several repeated "fk_"
428
+ // that is not really a valid DB identifier but a valid JS variable name.
429
+ finalPropBaseName = `fk_${finalPropBaseName}`;
430
+ }
431
+ return finalPropBaseName;
432
+ }
170
433
  /**
171
434
  * The shortest name is stripped of the default namespace. All other namespaced elements are returned as full-qualified names.
172
435
  */
@@ -200,13 +463,48 @@ class DatabaseTable {
200
463
  hasPrimaryKey() {
201
464
  return !!this.getPrimaryKey();
202
465
  }
203
- getPropertyDeclaration(column, namingStrategy, schemaHelper, compositeFkIndexes, compositeFkUniques) {
204
- const fk = Object.values(this.foreignKeys).find(fk => fk.columnNames.includes(column.name));
205
- const prop = this.getPropertyName(namingStrategy, column);
466
+ getForeignKeyDeclaration(fk, namingStrategy, schemaHelper, fkIndex, nullable, propNameBase) {
467
+ const prop = this.getPropertyName(namingStrategy, propNameBase, fk);
468
+ const kind = (fkIndex.unique && !fkIndex.primary) ? this.getReferenceKind(fk, fkIndex) : this.getReferenceKind(fk);
469
+ const type = this.getPropertyTypeForForeignKey(namingStrategy, fk);
470
+ const fkOptions = {};
471
+ fkOptions.fieldNames = fk.columnNames;
472
+ fkOptions.referencedTableName = fk.referencedTableName;
473
+ fkOptions.referencedColumnNames = fk.referencedColumnNames;
474
+ fkOptions.updateRule = fk.updateRule?.toLowerCase();
475
+ fkOptions.deleteRule = fk.deleteRule?.toLowerCase();
476
+ const columnOptions = {};
477
+ if (fk.columnNames.length === 1) {
478
+ const column = this.getColumn(fk.columnNames[0]);
479
+ columnOptions.default = this.getPropertyDefaultValue(schemaHelper, column, type);
480
+ columnOptions.defaultRaw = this.getPropertyDefaultValue(schemaHelper, column, type, true);
481
+ columnOptions.nullable = column.nullable;
482
+ columnOptions.primary = column.primary;
483
+ columnOptions.length = column.length;
484
+ columnOptions.precision = column.precision;
485
+ columnOptions.scale = column.scale;
486
+ columnOptions.enum = !!column.enumItems?.length;
487
+ columnOptions.items = column.enumItems;
488
+ }
489
+ return {
490
+ name: prop,
491
+ type,
492
+ kind,
493
+ ...columnOptions,
494
+ nullable,
495
+ primary: fkIndex.primary || !fk.columnNames.some(columnName => !this.getPrimaryKey()?.columnNames.includes(columnName)),
496
+ index: !fkIndex.unique ? fkIndex.keyName : undefined,
497
+ unique: (fkIndex.unique && !fkIndex.primary) ? fkIndex.keyName : undefined,
498
+ ...fkOptions,
499
+ };
500
+ }
501
+ getPropertyDeclaration(column, namingStrategy, schemaHelper, compositeFkIndexes, compositeFkUniques, columnFks, fk) {
502
+ const prop = this.getPropertyName(namingStrategy, column.name, fk);
503
+ const persist = !(column.name in columnFks && typeof fk === 'undefined');
206
504
  const index = compositeFkIndexes[prop] || this.indexes.find(idx => idx.columnNames[0] === column.name && !idx.composite && !idx.unique && !idx.primary);
207
505
  const unique = compositeFkUniques[prop] || this.indexes.find(idx => idx.columnNames[0] === column.name && !idx.composite && idx.unique && !idx.primary);
208
506
  const kind = this.getReferenceKind(fk, unique);
209
- const type = this.getPropertyType(namingStrategy, column, fk);
507
+ const type = this.getPropertyTypeForColumn(namingStrategy, column, fk);
210
508
  const fkOptions = {};
211
509
  if (fk) {
212
510
  fkOptions.fieldNames = fk.columnNames;
@@ -223,13 +521,17 @@ class DatabaseTable {
223
521
  default: this.getPropertyDefaultValue(schemaHelper, column, type),
224
522
  defaultRaw: this.getPropertyDefaultValue(schemaHelper, column, type, true),
225
523
  nullable: column.nullable,
226
- primary: column.primary,
524
+ primary: column.primary && persist,
525
+ autoincrement: column.autoincrement,
227
526
  fieldName: column.name,
228
527
  length: column.length,
528
+ precision: column.precision,
529
+ scale: column.scale,
229
530
  index: index ? index.keyName : undefined,
230
531
  unique: unique ? unique.keyName : undefined,
231
532
  enum: !!column.enumItems?.length,
232
533
  items: column.enumItems,
534
+ persist,
233
535
  ...fkOptions,
234
536
  };
235
537
  }
@@ -242,19 +544,28 @@ class DatabaseTable {
242
544
  }
243
545
  return core_1.ReferenceKind.SCALAR;
244
546
  }
245
- getPropertyName(namingStrategy, column) {
246
- const fk = Object.values(this.foreignKeys).find(fk => fk.columnNames.includes(column.name));
247
- let field = column.name;
547
+ getPropertyName(namingStrategy, baseName, fk) {
548
+ let field = baseName;
248
549
  if (fk) {
249
- const idx = fk.columnNames.indexOf(column.name);
250
- field = field.replace(new RegExp(`_${fk.referencedColumnNames[idx]}$`), '');
550
+ const idx = fk.columnNames.indexOf(baseName);
551
+ let replacedFieldName = field.replace(new RegExp(`_${fk.referencedColumnNames[idx]}$`), '');
552
+ if (replacedFieldName === field) {
553
+ replacedFieldName = field.replace(new RegExp(`_${namingStrategy.referenceColumnName()}$`), '');
554
+ }
555
+ field = replacedFieldName;
556
+ }
557
+ if (field.startsWith('_')) {
558
+ return field;
251
559
  }
252
560
  return namingStrategy.columnNameToProperty(field);
253
561
  }
254
- getPropertyType(namingStrategy, column, fk) {
562
+ getPropertyTypeForForeignKey(namingStrategy, fk) {
563
+ const parts = fk.referencedTableName.split('.', 2);
564
+ return namingStrategy.getClassName(parts.length > 1 ? parts[1] : parts[0], '_');
565
+ }
566
+ getPropertyTypeForColumn(namingStrategy, column, fk) {
255
567
  if (fk) {
256
- const parts = fk.referencedTableName.split('.', 2);
257
- return namingStrategy.getClassName(parts.length > 1 ? parts[1] : parts[0], '_');
568
+ return this.getPropertyTypeForForeignKey(namingStrategy, fk);
258
569
  }
259
570
  // If this column is using an enum.
260
571
  if (column.enumItems?.length) {
@@ -287,7 +598,21 @@ class DatabaseTable {
287
598
  return '' + val;
288
599
  }
289
600
  addIndex(meta, index, type) {
290
- const properties = core_1.Utils.flatten(core_1.Utils.asArray(index.properties).map(prop => meta.properties[prop].fieldNames));
601
+ const properties = core_1.Utils.unique(core_1.Utils.flatten(core_1.Utils.asArray(index.properties).map(prop => {
602
+ const root = prop.replace(/\..+$/, '');
603
+ if (meta.properties[prop]) {
604
+ if (meta.properties[prop].embeddedPath) {
605
+ return [meta.properties[prop].embeddedPath.join('.')];
606
+ }
607
+ return meta.properties[prop].fieldNames;
608
+ }
609
+ // json index, we need to rename the column only
610
+ if (meta.properties[root]) {
611
+ return [prop.replace(root, meta.properties[root].fieldNames[0])];
612
+ }
613
+ /* istanbul ignore next */
614
+ return [prop];
615
+ })));
291
616
  if (properties.length === 0 && !index.expression) {
292
617
  return;
293
618
  }
@@ -296,10 +621,13 @@ class DatabaseTable {
296
621
  keyName: name,
297
622
  columnNames: properties,
298
623
  composite: properties.length > 1,
624
+ // JSON columns can have unique index but not unique constraint, and we need to distinguish those, so we can properly drop them
625
+ constraint: type !== 'index' && !properties.some((d) => d.includes('.')),
299
626
  primary: type === 'primary',
300
627
  unique: type !== 'index',
301
628
  type: index.type,
302
629
  expression: index.expression,
630
+ options: index.options,
303
631
  });
304
632
  }
305
633
  addCheck(check) {
@@ -1,4 +1,5 @@
1
- import type { CheckDef, Column, ForeignKey, IndexDef, SchemaDifference, TableDifference } from '../typings';
1
+ import { type Dictionary } from '@mikro-orm/core';
2
+ import type { Column, ForeignKey, IndexDef, SchemaDifference, TableDifference } from '../typings';
2
3
  import type { DatabaseSchema } from './DatabaseSchema';
3
4
  import type { DatabaseTable } from './DatabaseTable';
4
5
  import type { AbstractSqlPlatform } from '../AbstractSqlPlatform';
@@ -17,12 +18,12 @@ export declare class SchemaComparator {
17
18
  * operations to change the schema stored in fromSchema to the schema that is
18
19
  * stored in toSchema.
19
20
  */
20
- compare(fromSchema: DatabaseSchema, toSchema: DatabaseSchema): SchemaDifference;
21
+ compare(fromSchema: DatabaseSchema, toSchema: DatabaseSchema, inverseDiff?: SchemaDifference): SchemaDifference;
21
22
  /**
22
23
  * Returns the difference between the tables fromTable and toTable.
23
24
  * If there are no differences this method returns the boolean false.
24
25
  */
25
- diffTable(fromTable: DatabaseTable, toTable: DatabaseTable): TableDifference | false;
26
+ diffTable(fromTable: DatabaseTable, toTable: DatabaseTable, inverseTableDiff?: TableDifference): TableDifference | false;
26
27
  /**
27
28
  * Try to find columns that only changed their name, rename operations maybe cheaper than add/drop
28
29
  * however ambiguities between different possibilities should not lead to renaming at all.
@@ -38,7 +39,7 @@ export declare class SchemaComparator {
38
39
  * Returns the difference between the columns
39
40
  * If there are differences this method returns field2, otherwise the boolean false.
40
41
  */
41
- diffColumn(column1: Column, column2: Column, tableName?: string): Set<string>;
42
+ diffColumn(fromColumn: Column, toColumn: Column, tableName?: string): Set<string>;
42
43
  diffEnumItems(items1?: string[], items2?: string[]): boolean;
43
44
  diffComment(comment1?: string, comment2?: string): boolean;
44
45
  /**
@@ -50,7 +51,8 @@ export declare class SchemaComparator {
50
51
  * Checks if the other index already fulfills all the indexing and constraint needs of the current one.
51
52
  */
52
53
  isIndexFulfilledBy(index1: IndexDef, index2: IndexDef): boolean;
53
- diffCheck(check1: CheckDef, check2: CheckDef): boolean;
54
+ diffExpression(expr1: string, expr2: string): boolean;
55
+ parseJsonDefault(defaultValue?: string | null): Dictionary | string | null;
54
56
  hasSameDefaultValue(from: Column, to: Column): boolean;
55
57
  private mapColumnToProperty;
56
58
  private log;