@mikro-orm/knex 7.0.0-dev.6 → 7.0.0-dev.61

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 (50) hide show
  1. package/AbstractSqlConnection.d.ts +11 -5
  2. package/AbstractSqlConnection.js +79 -32
  3. package/AbstractSqlDriver.d.ts +14 -10
  4. package/AbstractSqlDriver.js +273 -222
  5. package/AbstractSqlPlatform.js +3 -3
  6. package/PivotCollectionPersister.d.ts +3 -2
  7. package/PivotCollectionPersister.js +6 -2
  8. package/README.md +3 -2
  9. package/SqlEntityManager.d.ts +9 -2
  10. package/SqlEntityManager.js +2 -2
  11. package/dialects/mssql/MsSqlNativeQueryBuilder.d.ts +2 -0
  12. package/dialects/mssql/MsSqlNativeQueryBuilder.js +43 -2
  13. package/dialects/mysql/MySqlPlatform.js +2 -1
  14. package/dialects/postgresql/PostgreSqlTableCompiler.d.ts +1 -0
  15. package/dialects/postgresql/PostgreSqlTableCompiler.js +1 -0
  16. package/dialects/sqlite/BaseSqliteConnection.d.ts +4 -2
  17. package/dialects/sqlite/BaseSqliteConnection.js +8 -5
  18. package/dialects/sqlite/SqliteSchemaHelper.js +1 -1
  19. package/index.d.ts +1 -1
  20. package/index.js +1 -1
  21. package/package.json +5 -5
  22. package/query/ArrayCriteriaNode.d.ts +1 -0
  23. package/query/ArrayCriteriaNode.js +3 -0
  24. package/query/CriteriaNode.d.ts +4 -2
  25. package/query/CriteriaNode.js +11 -6
  26. package/query/CriteriaNodeFactory.js +11 -6
  27. package/query/NativeQueryBuilder.js +1 -1
  28. package/query/ObjectCriteriaNode.d.ts +1 -0
  29. package/query/ObjectCriteriaNode.js +38 -7
  30. package/query/QueryBuilder.d.ts +67 -6
  31. package/query/QueryBuilder.js +195 -43
  32. package/query/QueryBuilderHelper.d.ts +1 -1
  33. package/query/QueryBuilderHelper.js +13 -6
  34. package/query/ScalarCriteriaNode.d.ts +3 -3
  35. package/query/ScalarCriteriaNode.js +7 -5
  36. package/query/index.d.ts +1 -0
  37. package/query/index.js +1 -0
  38. package/query/raw.d.ts +59 -0
  39. package/query/raw.js +68 -0
  40. package/query/rawKnex.d.ts +58 -0
  41. package/query/rawKnex.js +72 -0
  42. package/schema/DatabaseSchema.js +25 -4
  43. package/schema/DatabaseTable.d.ts +5 -4
  44. package/schema/DatabaseTable.js +80 -34
  45. package/schema/SchemaComparator.js +2 -2
  46. package/schema/SchemaHelper.d.ts +2 -0
  47. package/schema/SchemaHelper.js +8 -4
  48. package/schema/SqlSchemaGenerator.d.ts +9 -2
  49. package/schema/SqlSchemaGenerator.js +31 -11
  50. package/typings.d.ts +86 -3
package/query/raw.d.ts ADDED
@@ -0,0 +1,59 @@
1
+ import { type AnyString, type Dictionary, type EntityKey, type RawQueryFragment } from '@mikro-orm/core';
2
+ import type { SelectQueryBuilder } from 'kysely';
3
+ import { QueryBuilder } from './QueryBuilder.js';
4
+ /**
5
+ * Creates raw SQL query fragment that can be assigned to a property or part of a filter. This fragment is represented
6
+ * by `RawQueryFragment` class instance that can be serialized to a string, so it can be used both as an object value
7
+ * and key. When serialized, the fragment key gets cached and only such cached key will be recognized by the ORM.
8
+ * This adds a runtime safety to the raw query fragments.
9
+ *
10
+ * > **`raw()` helper is required since v6 to use a raw fragment in your query, both through EntityManager and QueryBuilder.**
11
+ *
12
+ * ```ts
13
+ * // as a value
14
+ * await em.find(User, { time: raw('now()') });
15
+ *
16
+ * // as a key
17
+ * await em.find(User, { [raw('lower(name)')]: name.toLowerCase() });
18
+ *
19
+ * // value can be empty array
20
+ * await em.find(User, { [raw('(select 1 = 1)')]: [] });
21
+ * ```
22
+ *
23
+ * The `raw` helper supports several signatures, you can pass in a callback that receives the current property alias:
24
+ *
25
+ * ```ts
26
+ * await em.find(User, { [raw(alias => `lower(${alias}.name)`)]: name.toLowerCase() });
27
+ * ```
28
+ *
29
+ * You can also use the `sql` tagged template function, which works the same, but supports only the simple string signature:
30
+ *
31
+ * ```ts
32
+ * await em.find(User, { [sql`lower(name)`]: name.toLowerCase() });
33
+ * ```
34
+ *
35
+ * When using inside filters, you might have to use a callback signature to create new raw instance for every filter usage.
36
+ *
37
+ * ```ts
38
+ * @Filter({ name: 'long', cond: () => ({ [raw('length(perex)')]: { $gt: 10000 } }) })
39
+ * ```
40
+ *
41
+ * The `raw` helper can be used within indexes and uniques to write database-agnostic SQL expressions. In that case, you can use `'??'` to tag your database identifiers (table name, column names, index name, ...) inside your expression, and pass those identifiers as a second parameter to the `raw` helper. Internally, those will automatically be quoted according to the database in use:
42
+ *
43
+ * ```ts
44
+ * // On postgres, will produce: create index "index custom_idx_on_name" on "library.author" ("country")
45
+ * // On mysql, will produce: create index `index custom_idx_on_name` on `library.author` (`country`)
46
+ * @Index({ name: 'custom_idx_on_name', expression: (table, columns) => raw(`create index ?? on ?? (??)`, ['custom_idx_on_name', table, columns.name]) })
47
+ * @Entity({ schema: 'library' })
48
+ * export class Author { ... }
49
+ * ```
50
+ *
51
+ * You can also use the `quote` tag function to write database-agnostic SQL expressions. The end-result is the same as using the `raw` function regarding database identifiers quoting, only to have a more elegant expression syntax:
52
+ *
53
+ * ```ts
54
+ * @Index({ name: 'custom_idx_on_name', expression: (table, columns) => quote`create index ${'custom_idx_on_name'} on ${table} (${columns.name})` })
55
+ * @Entity({ schema: 'library' })
56
+ * export class Author { ... }
57
+ * ```
58
+ */
59
+ export declare function raw<T extends object = any, R = any>(sql: SelectQueryBuilder<any, any, any> | QueryBuilder<T> | EntityKey<T> | EntityKey<T>[] | AnyString | ((alias: string) => string) | RawQueryFragment, params?: readonly unknown[] | Dictionary<unknown>): NoInfer<R>;
package/query/raw.js ADDED
@@ -0,0 +1,68 @@
1
+ import { raw as raw_, Utils } from '@mikro-orm/core';
2
+ import { QueryBuilder } from './QueryBuilder.js';
3
+ /**
4
+ * Creates raw SQL query fragment that can be assigned to a property or part of a filter. This fragment is represented
5
+ * by `RawQueryFragment` class instance that can be serialized to a string, so it can be used both as an object value
6
+ * and key. When serialized, the fragment key gets cached and only such cached key will be recognized by the ORM.
7
+ * This adds a runtime safety to the raw query fragments.
8
+ *
9
+ * > **`raw()` helper is required since v6 to use a raw fragment in your query, both through EntityManager and QueryBuilder.**
10
+ *
11
+ * ```ts
12
+ * // as a value
13
+ * await em.find(User, { time: raw('now()') });
14
+ *
15
+ * // as a key
16
+ * await em.find(User, { [raw('lower(name)')]: name.toLowerCase() });
17
+ *
18
+ * // value can be empty array
19
+ * await em.find(User, { [raw('(select 1 = 1)')]: [] });
20
+ * ```
21
+ *
22
+ * The `raw` helper supports several signatures, you can pass in a callback that receives the current property alias:
23
+ *
24
+ * ```ts
25
+ * await em.find(User, { [raw(alias => `lower(${alias}.name)`)]: name.toLowerCase() });
26
+ * ```
27
+ *
28
+ * You can also use the `sql` tagged template function, which works the same, but supports only the simple string signature:
29
+ *
30
+ * ```ts
31
+ * await em.find(User, { [sql`lower(name)`]: name.toLowerCase() });
32
+ * ```
33
+ *
34
+ * When using inside filters, you might have to use a callback signature to create new raw instance for every filter usage.
35
+ *
36
+ * ```ts
37
+ * @Filter({ name: 'long', cond: () => ({ [raw('length(perex)')]: { $gt: 10000 } }) })
38
+ * ```
39
+ *
40
+ * The `raw` helper can be used within indexes and uniques to write database-agnostic SQL expressions. In that case, you can use `'??'` to tag your database identifiers (table name, column names, index name, ...) inside your expression, and pass those identifiers as a second parameter to the `raw` helper. Internally, those will automatically be quoted according to the database in use:
41
+ *
42
+ * ```ts
43
+ * // On postgres, will produce: create index "index custom_idx_on_name" on "library.author" ("country")
44
+ * // On mysql, will produce: create index `index custom_idx_on_name` on `library.author` (`country`)
45
+ * @Index({ name: 'custom_idx_on_name', expression: (table, columns) => raw(`create index ?? on ?? (??)`, ['custom_idx_on_name', table, columns.name]) })
46
+ * @Entity({ schema: 'library' })
47
+ * export class Author { ... }
48
+ * ```
49
+ *
50
+ * You can also use the `quote` tag function to write database-agnostic SQL expressions. The end-result is the same as using the `raw` function regarding database identifiers quoting, only to have a more elegant expression syntax:
51
+ *
52
+ * ```ts
53
+ * @Index({ name: 'custom_idx_on_name', expression: (table, columns) => quote`create index ${'custom_idx_on_name'} on ${table} (${columns.name})` })
54
+ * @Entity({ schema: 'library' })
55
+ * export class Author { ... }
56
+ * ```
57
+ */
58
+ export function raw(sql, params) {
59
+ if (Utils.isObject(sql) && 'compile' in sql) {
60
+ const query = sql.compile();
61
+ return raw_(query.sql, query.parameters);
62
+ }
63
+ if (sql instanceof QueryBuilder) {
64
+ const query = sql.toQuery();
65
+ return raw_(query.sql, query.params);
66
+ }
67
+ return raw_(sql, params);
68
+ }
@@ -0,0 +1,58 @@
1
+ import { type AnyString, type Dictionary, type EntityKey, type RawQueryFragment } from '@mikro-orm/core';
2
+ import { QueryBuilder } from './QueryBuilder.js';
3
+ /**
4
+ * Creates raw SQL query fragment that can be assigned to a property or part of a filter. This fragment is represented
5
+ * by `RawQueryFragment` class instance that can be serialized to a string, so it can be used both as an object value
6
+ * and key. When serialized, the fragment key gets cached and only such cached key will be recognized by the ORM.
7
+ * This adds a runtime safety to the raw query fragments.
8
+ *
9
+ * > **`raw()` helper is required since v6 to use a raw fragment in your query, both through EntityManager and QueryBuilder.**
10
+ *
11
+ * ```ts
12
+ * // as a value
13
+ * await em.find(User, { time: raw('now()') });
14
+ *
15
+ * // as a key
16
+ * await em.find(User, { [raw('lower(name)')]: name.toLowerCase() });
17
+ *
18
+ * // value can be empty array
19
+ * await em.find(User, { [raw('(select 1 = 1)')]: [] });
20
+ * ```
21
+ *
22
+ * The `raw` helper supports several signatures, you can pass in a callback that receives the current property alias:
23
+ *
24
+ * ```ts
25
+ * await em.find(User, { [raw(alias => `lower(${alias}.name)`)]: name.toLowerCase() });
26
+ * ```
27
+ *
28
+ * You can also use the `sql` tagged template function, which works the same, but supports only the simple string signature:
29
+ *
30
+ * ```ts
31
+ * await em.find(User, { [sql`lower(name)`]: name.toLowerCase() });
32
+ * ```
33
+ *
34
+ * When using inside filters, you might have to use a callback signature to create new raw instance for every filter usage.
35
+ *
36
+ * ```ts
37
+ * @Filter({ name: 'long', cond: () => ({ [raw('length(perex)')]: { $gt: 10000 } }) })
38
+ * ```
39
+ *
40
+ * The `raw` helper can be used within indexes and uniques to write database-agnostic SQL expressions. In that case, you can use `'??'` to tag your database identifiers (table name, column names, index name, ...) inside your expression, and pass those identifiers as a second parameter to the `raw` helper. Internally, those will automatically be quoted according to the database in use:
41
+ *
42
+ * ```ts
43
+ * // On postgres, will produce: create index "index custom_idx_on_name" on "library.author" ("country")
44
+ * // On mysql, will produce: create index `index custom_idx_on_name` on `library.author` (`country`)
45
+ * @Index({ name: 'custom_idx_on_name', expression: (table, columns) => raw(`create index ?? on ?? (??)`, ['custom_idx_on_name', table, columns.name]) })
46
+ * @Entity({ schema: 'library' })
47
+ * export class Author { ... }
48
+ * ```
49
+ *
50
+ * You can also use the `quote` tag function to write database-agnostic SQL expressions. The end-result is the same as using the `raw` function regarding database identifiers quoting, only to have a more elegant expression syntax:
51
+ *
52
+ * ```ts
53
+ * @Index({ name: 'custom_idx_on_name', expression: (table, columns) => quote`create index ${'custom_idx_on_name'} on ${table} (${columns.name})` })
54
+ * @Entity({ schema: 'library' })
55
+ * export class Author { ... }
56
+ * ```
57
+ */
58
+ export declare function rawKnex<T extends object = any, R = any>(sql: QueryBuilder<T> | EntityKey<T> | EntityKey<T>[] | AnyString | ((alias: string) => string) | RawQueryFragment, params?: readonly unknown[] | Dictionary<unknown>): NoInfer<R>;
@@ -0,0 +1,72 @@
1
+ import { raw } from '@mikro-orm/core';
2
+ // import type { Knex } from 'knex';
3
+ import { QueryBuilder } from './QueryBuilder.js';
4
+ /**
5
+ * Creates raw SQL query fragment that can be assigned to a property or part of a filter. This fragment is represented
6
+ * by `RawQueryFragment` class instance that can be serialized to a string, so it can be used both as an object value
7
+ * and key. When serialized, the fragment key gets cached and only such cached key will be recognized by the ORM.
8
+ * This adds a runtime safety to the raw query fragments.
9
+ *
10
+ * > **`raw()` helper is required since v6 to use a raw fragment in your query, both through EntityManager and QueryBuilder.**
11
+ *
12
+ * ```ts
13
+ * // as a value
14
+ * await em.find(User, { time: raw('now()') });
15
+ *
16
+ * // as a key
17
+ * await em.find(User, { [raw('lower(name)')]: name.toLowerCase() });
18
+ *
19
+ * // value can be empty array
20
+ * await em.find(User, { [raw('(select 1 = 1)')]: [] });
21
+ * ```
22
+ *
23
+ * The `raw` helper supports several signatures, you can pass in a callback that receives the current property alias:
24
+ *
25
+ * ```ts
26
+ * await em.find(User, { [raw(alias => `lower(${alias}.name)`)]: name.toLowerCase() });
27
+ * ```
28
+ *
29
+ * You can also use the `sql` tagged template function, which works the same, but supports only the simple string signature:
30
+ *
31
+ * ```ts
32
+ * await em.find(User, { [sql`lower(name)`]: name.toLowerCase() });
33
+ * ```
34
+ *
35
+ * When using inside filters, you might have to use a callback signature to create new raw instance for every filter usage.
36
+ *
37
+ * ```ts
38
+ * @Filter({ name: 'long', cond: () => ({ [raw('length(perex)')]: { $gt: 10000 } }) })
39
+ * ```
40
+ *
41
+ * The `raw` helper can be used within indexes and uniques to write database-agnostic SQL expressions. In that case, you can use `'??'` to tag your database identifiers (table name, column names, index name, ...) inside your expression, and pass those identifiers as a second parameter to the `raw` helper. Internally, those will automatically be quoted according to the database in use:
42
+ *
43
+ * ```ts
44
+ * // On postgres, will produce: create index "index custom_idx_on_name" on "library.author" ("country")
45
+ * // On mysql, will produce: create index `index custom_idx_on_name` on `library.author` (`country`)
46
+ * @Index({ name: 'custom_idx_on_name', expression: (table, columns) => raw(`create index ?? on ?? (??)`, ['custom_idx_on_name', table, columns.name]) })
47
+ * @Entity({ schema: 'library' })
48
+ * export class Author { ... }
49
+ * ```
50
+ *
51
+ * You can also use the `quote` tag function to write database-agnostic SQL expressions. The end-result is the same as using the `raw` function regarding database identifiers quoting, only to have a more elegant expression syntax:
52
+ *
53
+ * ```ts
54
+ * @Index({ name: 'custom_idx_on_name', expression: (table, columns) => quote`create index ${'custom_idx_on_name'} on ${table} (${columns.name})` })
55
+ * @Entity({ schema: 'library' })
56
+ * export class Author { ... }
57
+ * ```
58
+ */
59
+ export function rawKnex(sql, params) {
60
+ // export function rawKnex<T extends object = any, R = any>(sql: Knex.QueryBuilder | Knex.Raw | QueryBuilder<T> | EntityKey<T> | EntityKey<T>[] | AnyString | ((alias: string) => string) | RawQueryFragment, params?: readonly unknown[] | Dictionary<unknown>): NoInfer<R> {
61
+ // if (Utils.isObject<Knex.QueryBuilder | Knex.Raw>(sql) && 'toSQL' in sql) {
62
+ // const query = sql.toSQL();
63
+ // return raw(query.sql, query.bindings);
64
+ // }
65
+ if (sql instanceof QueryBuilder) {
66
+ // FIXME this should live in the `knex` compat package, while what we have now should live in `sql` package
67
+ // @ts-ignore
68
+ const query = sql.toQuery()._sql;
69
+ return raw(query.sql, query.bindings);
70
+ }
71
+ return raw(sql, params);
72
+ }
@@ -1,4 +1,4 @@
1
- import { ReferenceKind } from '@mikro-orm/core';
1
+ import { ReferenceKind, RawQueryFragment, } from '@mikro-orm/core';
2
2
  import { DatabaseTable } from './DatabaseTable.js';
3
3
  /**
4
4
  * @internal
@@ -69,6 +69,7 @@ export class DatabaseSchema {
69
69
  static fromMetadata(metadata, platform, config, schemaName) {
70
70
  const schema = new DatabaseSchema(platform, schemaName ?? config.get('schema'));
71
71
  const nativeEnums = {};
72
+ const skipColumns = config.get('schemaGenerator').skipColumns || {};
72
73
  for (const meta of metadata) {
73
74
  for (const prop of meta.props) {
74
75
  if (prop.nativeEnumName) {
@@ -97,7 +98,7 @@ export class DatabaseSchema {
97
98
  const table = schema.addTable(meta.collection, this.getSchemaName(meta, config, schemaName));
98
99
  table.comment = meta.comment;
99
100
  for (const prop of meta.props) {
100
- if (!this.shouldHaveColumn(meta, prop)) {
101
+ if (!this.shouldHaveColumn(meta, prop, skipColumns)) {
101
102
  continue;
102
103
  }
103
104
  table.addColumnFromProperty(prop, meta, config);
@@ -107,9 +108,14 @@ export class DatabaseSchema {
107
108
  table.addIndex(meta, { properties: meta.props.filter(prop => prop.primary).map(prop => prop.name) }, 'primary');
108
109
  for (const check of meta.checks) {
109
110
  const columnName = check.property ? meta.properties[check.property].fieldNames[0] : undefined;
111
+ let expression = check.expression;
112
+ const raw = RawQueryFragment.getKnownFragment(expression);
113
+ if (raw) {
114
+ expression = platform.formatQuery(raw.sql, raw.params);
115
+ }
110
116
  table.addCheck({
111
117
  name: check.name,
112
- expression: check.expression,
118
+ expression,
113
119
  definition: `check (${check.expression})`,
114
120
  columnName,
115
121
  });
@@ -129,10 +135,25 @@ export class DatabaseSchema {
129
135
  return ((takeTables?.some(tableNameToMatch => this.matchName(tableName, tableNameToMatch)) ?? true) &&
130
136
  !(skipTables?.some(tableNameToMatch => this.matchName(tableName, tableNameToMatch)) ?? false));
131
137
  }
132
- static shouldHaveColumn(meta, prop) {
138
+ static shouldHaveColumn(meta, prop, skipColumns) {
133
139
  if (prop.persist === false || (prop.columnTypes?.length ?? 0) === 0) {
134
140
  return false;
135
141
  }
142
+ // Check if column should be skipped
143
+ if (skipColumns) {
144
+ const tableName = meta.tableName;
145
+ const tableSchema = meta.schema;
146
+ const fullTableName = tableSchema ? `${tableSchema}.${tableName}` : tableName;
147
+ // Check for skipColumns by table name or fully qualified table name
148
+ const columnsToSkip = skipColumns[tableName] || skipColumns[fullTableName];
149
+ if (columnsToSkip) {
150
+ for (const fieldName of prop.fieldNames) {
151
+ if (columnsToSkip.some(pattern => this.matchName(fieldName, pattern))) {
152
+ return false;
153
+ }
154
+ }
155
+ }
156
+ }
136
157
  if (prop.kind === ReferenceKind.EMBEDDED && prop.object) {
137
158
  return true;
138
159
  }
@@ -1,4 +1,4 @@
1
- import { type Configuration, type DeferMode, type Dictionary, type EntityMetadata, type EntityProperty, type NamingStrategy } from '@mikro-orm/core';
1
+ import { type Configuration, type DeferMode, type Dictionary, type EntityMetadata, type EntityProperty, type NamingStrategy, type IndexCallback } from '@mikro-orm/core';
2
2
  import type { SchemaHelper } from './SchemaHelper.js';
3
3
  import type { CheckDef, Column, ForeignKey, IndexDef } from '../typings.js';
4
4
  import type { AbstractSqlPlatform } from '../AbstractSqlPlatform.js';
@@ -54,12 +54,13 @@ export declare class DatabaseTable {
54
54
  private getPropertyTypeForForeignKey;
55
55
  private getPropertyTypeForColumn;
56
56
  private getPropertyDefaultValue;
57
+ private processIndexExpression;
57
58
  addIndex(meta: EntityMetadata, index: {
58
- properties: string | string[];
59
+ properties?: string | string[];
59
60
  name?: string;
60
61
  type?: string;
61
- expression?: string;
62
- deferMode?: DeferMode;
62
+ expression?: string | IndexCallback<any>;
63
+ deferMode?: DeferMode | `${DeferMode}`;
63
64
  options?: Dictionary;
64
65
  }, type: 'index' | 'unique' | 'primary'): void;
65
66
  addCheck(check: CheckDef): void;
@@ -1,4 +1,4 @@
1
- import { Cascade, DecimalType, EntitySchema, ReferenceKind, t, Type, UnknownType, Utils, } from '@mikro-orm/core';
1
+ import { Cascade, DecimalType, EntitySchema, ReferenceKind, t, Type, UnknownType, Utils, RawQueryFragment, } from '@mikro-orm/core';
2
2
  /**
3
3
  * @internal
4
4
  */
@@ -97,41 +97,46 @@ export class DatabaseTable {
97
97
  ignoreSchemaChanges: prop.ignoreSchemaChanges,
98
98
  };
99
99
  this.columns[field].unsigned ??= this.columns[field].autoincrement;
100
+ if (this.nativeEnums[type]) {
101
+ this.columns[field].enumItems ??= this.nativeEnums[type].items;
102
+ }
100
103
  const defaultValue = this.platform.getSchemaHelper().normalizeDefaultValue(prop.defaultRaw, prop.length);
101
104
  this.columns[field].default = defaultValue;
102
105
  });
103
106
  if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind)) {
104
- const constraintName = this.getIndexName(true, prop.fieldNames, 'foreign');
107
+ const constraintName = this.getIndexName(prop.foreignKeyName ?? true, prop.fieldNames, 'foreign');
105
108
  let schema = prop.targetMeta.root.schema === '*' ? this.schema : (prop.targetMeta.root.schema ?? config.get('schema', this.platform.getDefaultSchemaName()));
106
109
  if (prop.referencedTableName.includes('.')) {
107
110
  schema = undefined;
108
111
  }
109
- this.foreignKeys[constraintName] = {
110
- constraintName,
111
- columnNames: prop.fieldNames,
112
- localTableName: this.getShortestName(false),
113
- referencedColumnNames: prop.referencedColumnNames,
114
- referencedTableName: schema ? `${schema}.${prop.referencedTableName}` : prop.referencedTableName,
115
- };
116
- const cascade = prop.cascade.includes(Cascade.REMOVE) || prop.cascade.includes(Cascade.ALL);
117
- if (prop.deleteRule || cascade || prop.nullable) {
118
- this.foreignKeys[constraintName].deleteRule = prop.deleteRule || (cascade ? 'cascade' : 'set null');
119
- }
120
- if (prop.updateRule) {
121
- this.foreignKeys[constraintName].updateRule = prop.updateRule || 'cascade';
122
- }
123
- if ((prop.cascade.includes(Cascade.PERSIST) || prop.cascade.includes(Cascade.ALL))) {
124
- const hasCascadePath = Object.values(this.foreignKeys).some(fk => {
125
- return fk.constraintName !== constraintName
126
- && ((fk.updateRule && fk.updateRule !== 'no action') || (fk.deleteRule && fk.deleteRule !== 'no action'))
127
- && fk.referencedTableName === this.foreignKeys[constraintName].referencedTableName;
128
- });
129
- if (!hasCascadePath || this.platform.supportsMultipleCascadePaths()) {
130
- this.foreignKeys[constraintName].updateRule ??= 'cascade';
112
+ if (prop.createForeignKeyConstraint) {
113
+ this.foreignKeys[constraintName] = {
114
+ constraintName,
115
+ columnNames: prop.fieldNames,
116
+ localTableName: this.getShortestName(false),
117
+ referencedColumnNames: prop.referencedColumnNames,
118
+ referencedTableName: schema ? `${schema}.${prop.referencedTableName}` : prop.referencedTableName,
119
+ };
120
+ const cascade = prop.cascade.includes(Cascade.REMOVE) || prop.cascade.includes(Cascade.ALL);
121
+ if (prop.deleteRule || cascade || prop.nullable) {
122
+ this.foreignKeys[constraintName].deleteRule = prop.deleteRule || (cascade ? 'cascade' : 'set null');
123
+ }
124
+ if (prop.updateRule) {
125
+ this.foreignKeys[constraintName].updateRule = prop.updateRule || 'cascade';
126
+ }
127
+ if ((prop.cascade.includes(Cascade.PERSIST) || prop.cascade.includes(Cascade.ALL))) {
128
+ const hasCascadePath = Object.values(this.foreignKeys).some(fk => {
129
+ return fk.constraintName !== constraintName
130
+ && ((fk.updateRule && fk.updateRule !== 'no action') || (fk.deleteRule && fk.deleteRule !== 'no action'))
131
+ && fk.referencedTableName === this.foreignKeys[constraintName].referencedTableName;
132
+ });
133
+ if (!hasCascadePath || this.platform.supportsMultipleCascadePaths()) {
134
+ this.foreignKeys[constraintName].updateRule ??= 'cascade';
135
+ }
136
+ }
137
+ if (prop.deferMode) {
138
+ this.foreignKeys[constraintName].deferMode = prop.deferMode;
131
139
  }
132
- }
133
- if (prop.deferMode) {
134
- this.foreignKeys[constraintName].deferMode = prop.deferMode;
135
140
  }
136
141
  }
137
142
  if (prop.index) {
@@ -610,7 +615,7 @@ export class DatabaseTable {
610
615
  fkOptions.deferMode = fk.deferMode;
611
616
  fkOptions.columnTypes = fk.columnNames.map(col => this.getColumn(col).type);
612
617
  }
613
- return {
618
+ const ret = {
614
619
  name: prop,
615
620
  type,
616
621
  runtimeType,
@@ -638,6 +643,11 @@ export class DatabaseTable {
638
643
  persist,
639
644
  ...fkOptions,
640
645
  };
646
+ const nativeEnumName = Object.keys(this.nativeEnums).find(name => name === column.type);
647
+ if (nativeEnumName) {
648
+ ret.nativeEnumName = nativeEnumName;
649
+ }
650
+ return ret;
641
651
  }
642
652
  getReferenceKind(fk, unique) {
643
653
  if (fk && unique) {
@@ -671,10 +681,17 @@ export class DatabaseTable {
671
681
  if (fk) {
672
682
  return this.getPropertyTypeForForeignKey(namingStrategy, fk);
673
683
  }
684
+ const enumMode = this.platform.getConfig().get('entityGenerator').enumMode;
674
685
  // If this column is using an enum.
675
686
  if (column.enumItems?.length) {
676
- // We will create a new enum name for this type and set it as the property type as well.
677
- return namingStrategy.getEnumClassName(column.name, this.name, this.schema);
687
+ const name = column.nativeEnumName ?? column.name;
688
+ const tableName = column.nativeEnumName ? undefined : this.name;
689
+ if (enumMode === 'ts-enum') {
690
+ // We will create a new enum name for this type and set it as the property type as well.
691
+ return namingStrategy.getEnumClassName(name, tableName, this.schema);
692
+ }
693
+ // With other enum strategies, we need to use the type name.
694
+ return namingStrategy.getEnumTypeName(name, tableName, this.schema);
678
695
  }
679
696
  return column.mappedType?.runtimeType ?? 'unknown';
680
697
  }
@@ -697,18 +714,47 @@ export class DatabaseTable {
697
714
  }
698
715
  return '' + val;
699
716
  }
717
+ processIndexExpression(indexName, expression, meta) {
718
+ if (expression instanceof Function) {
719
+ const table = {
720
+ name: this.name,
721
+ schema: this.schema,
722
+ toString() {
723
+ if (this.schema) {
724
+ return `${this.schema}.${this.name}`;
725
+ }
726
+ return this.name;
727
+ },
728
+ };
729
+ const exp = expression(table, meta.createColumnMappingObject(), indexName);
730
+ return exp instanceof RawQueryFragment ? this.platform.formatQuery(exp.sql, exp.params) : exp;
731
+ }
732
+ return expression;
733
+ }
700
734
  addIndex(meta, index, type) {
701
735
  const properties = Utils.unique(Utils.flatten(Utils.asArray(index.properties).map(prop => {
702
- const root = prop.replace(/\..+$/, '');
736
+ const parts = prop.split('.');
737
+ const root = parts[0];
703
738
  if (meta.properties[prop]) {
704
739
  if (meta.properties[prop].embeddedPath) {
705
740
  return [meta.properties[prop].embeddedPath.join('.')];
706
741
  }
707
742
  return meta.properties[prop].fieldNames;
708
743
  }
744
+ const rootProp = meta.properties[root];
745
+ // inline embedded property index, we need to find the field name of the child property
746
+ if (rootProp?.embeddable && !rootProp.object && parts.length > 1) {
747
+ const expand = (p, i) => {
748
+ if (parts.length === i) {
749
+ return p.fieldNames[0];
750
+ }
751
+ return expand(p.embeddedProps[parts[i]], i + 1);
752
+ };
753
+ return [expand(rootProp, 1)];
754
+ }
709
755
  // json index, we need to rename the column only
710
- if (meta.properties[root]) {
711
- return [prop.replace(root, meta.properties[root].fieldNames[0])];
756
+ if (rootProp) {
757
+ return [prop.replace(root, rootProp.fieldNames[0])];
712
758
  }
713
759
  /* v8 ignore next */
714
760
  return [prop];
@@ -726,7 +772,7 @@ export class DatabaseTable {
726
772
  primary: type === 'primary',
727
773
  unique: type !== 'index',
728
774
  type: index.type,
729
- expression: index.expression,
775
+ expression: this.processIndexExpression(name, index.expression, meta),
730
776
  options: index.options,
731
777
  deferMode: index.deferMode,
732
778
  });
@@ -269,7 +269,7 @@ export class SchemaComparator {
269
269
  }
270
270
  for (const toConstraint of Object.values(toForeignKeys)) {
271
271
  tableDifferences.addedForeignKeys[toConstraint.constraintName] = toConstraint;
272
- this.log(`FK constraint ${toConstraint.constraintName} added from table ${tableDifferences.name}`, { constraint: toConstraint });
272
+ this.log(`FK constraint ${toConstraint.constraintName} added to table ${tableDifferences.name}`, { constraint: toConstraint });
273
273
  changes++;
274
274
  }
275
275
  return changes ? tableDifferences : false;
@@ -511,7 +511,7 @@ export class SchemaComparator {
511
511
  return str
512
512
  ?.replace(/_\w+'(.*?)'/g, '$1')
513
513
  .replace(/in\s*\((.*?)\)/ig, '= any (array[$1])')
514
- .replace(/['"`()]|::\w+| +/g, '')
514
+ .replace(/['"`()\n[\]]|::\w+| +/g, '')
515
515
  .replace(/anyarray\[(.*)]/ig, '$1')
516
516
  .toLowerCase();
517
517
  };
@@ -63,6 +63,8 @@ export declare abstract class SchemaHelper {
63
63
  disableForeignKeys?: boolean;
64
64
  createForeignKeyConstraints?: boolean;
65
65
  ignoreSchema?: string[];
66
+ skipTables?: (string | RegExp)[];
67
+ skipColumns?: Dictionary<(string | RegExp)[]>;
66
68
  managementDbName?: string;
67
69
  };
68
70
  protected processComment(comment: string): string;
@@ -119,9 +119,8 @@ export class SchemaHelper {
119
119
  }
120
120
  }
121
121
  Utils.removeDuplicates(changedNativeEnums).forEach(([enumName, itemsNew, itemsOld]) => {
122
- // postgres allows only adding new items, the values are case insensitive
123
- itemsOld = itemsOld.map(v => v.toLowerCase());
124
- const newItems = itemsNew.filter(val => !itemsOld.includes(val.toLowerCase()));
122
+ // postgres allows only adding new items
123
+ const newItems = itemsNew.filter(val => !itemsOld.includes(val));
125
124
  if (enumName.includes('.')) {
126
125
  const [enumSchemaName, rawEnumName] = enumName.split('.');
127
126
  ret.push(...newItems.map(val => this.getAlterNativeEnumSQL(rawEnumName, enumSchemaName, val, itemsNew, itemsOld)));
@@ -264,7 +263,12 @@ export class SchemaHelper {
264
263
  if (column.autoincrement && !column.generated && !compositePK && (!changedProperties || changedProperties.has('autoincrement') || changedProperties.has('type'))) {
265
264
  Utils.runIfNotEmpty(() => col.push('primary key'), primaryKey && column.primary);
266
265
  }
267
- Utils.runIfNotEmpty(() => col.push(`default ${column.default}`), useDefault);
266
+ if (useDefault) {
267
+ // https://dev.mysql.com/doc/refman/9.0/en/data-type-defaults.html
268
+ const needsExpression = ['blob', 'text', 'json', 'point', 'linestring', 'polygon', 'multipoint', 'multilinestring', 'multipolygon', 'geometrycollection'].some(type => column.type.toLowerCase().startsWith(type));
269
+ const defaultSql = needsExpression && !column.default.startsWith('(') ? `(${column.default})` : column.default;
270
+ col.push(`default ${defaultSql}`);
271
+ }
268
272
  Utils.runIfNotEmpty(() => col.push(column.extra), column.extra);
269
273
  Utils.runIfNotEmpty(() => col.push(`comment ${this.platform.quoteValue(column.comment)}`), column.comment);
270
274
  return col.join(' ');
@@ -1,4 +1,4 @@
1
- import { AbstractSchemaGenerator, type ClearDatabaseOptions, type CreateSchemaOptions, type DropSchemaOptions, type EnsureDatabaseOptions, type ISchemaGenerator, type MikroORM, type Transaction, type UpdateSchemaOptions } from '@mikro-orm/core';
1
+ import { AbstractSchemaGenerator, type ClearDatabaseOptions, type CreateSchemaOptions, type Dictionary, type DropSchemaOptions, type EnsureDatabaseOptions, type EntityMetadata, type ISchemaGenerator, type MikroORM, type Transaction, type UpdateSchemaOptions } from '@mikro-orm/core';
2
2
  import type { SchemaDifference } from '../typings.js';
3
3
  import { DatabaseSchema } from './DatabaseSchema.js';
4
4
  import type { AbstractSqlDriver } from '../AbstractSqlDriver.js';
@@ -8,6 +8,8 @@ export declare class SqlSchemaGenerator extends AbstractSchemaGenerator<Abstract
8
8
  disableForeignKeys?: boolean;
9
9
  createForeignKeyConstraints?: boolean;
10
10
  ignoreSchema?: string[];
11
+ skipTables?: (string | RegExp)[];
12
+ skipColumns?: Dictionary<(string | RegExp)[]>;
11
13
  managementDbName?: string;
12
14
  };
13
15
  protected lastEnsuredDatabase?: string;
@@ -18,6 +20,7 @@ export declare class SqlSchemaGenerator extends AbstractSchemaGenerator<Abstract
18
20
  */
19
21
  ensureDatabase(options?: EnsureDatabaseOptions): Promise<boolean>;
20
22
  getTargetSchema(schema?: string): DatabaseSchema;
23
+ protected getOrderedMetadata(schema?: string): EntityMetadata[];
21
24
  getCreateSchemaSQL(options?: CreateSchemaOptions): Promise<string>;
22
25
  dropSchema(options?: DropSchemaOptions): Promise<void>;
23
26
  createNamespace(name: string): Promise<void>;
@@ -45,7 +48,9 @@ export declare class SqlSchemaGenerator extends AbstractSchemaGenerator<Abstract
45
48
  /**
46
49
  * creates new database and connects to it
47
50
  */
48
- createDatabase(name?: string): Promise<void>;
51
+ createDatabase(name?: string, options?: {
52
+ skipOnConnect?: boolean;
53
+ }): Promise<void>;
49
54
  dropDatabase(name?: string): Promise<void>;
50
55
  execute(sql: string, options?: {
51
56
  wrap?: boolean;
@@ -54,5 +59,7 @@ export declare class SqlSchemaGenerator extends AbstractSchemaGenerator<Abstract
54
59
  dropTableIfExists(name: string, schema?: string): Promise<void>;
55
60
  private wrapSchema;
56
61
  private append;
62
+ private matchName;
63
+ private isTableSkipped;
57
64
  }
58
65
  export { SqlSchemaGenerator as SchemaGenerator };