@mikro-orm/core 7.0.0-dev.31 → 7.0.0-dev.311

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 (214) hide show
  1. package/EntityManager.d.ts +69 -61
  2. package/EntityManager.js +365 -283
  3. package/MikroORM.d.ts +44 -35
  4. package/MikroORM.js +109 -142
  5. package/README.md +5 -3
  6. package/cache/FileCacheAdapter.d.ts +1 -2
  7. package/cache/FileCacheAdapter.js +19 -14
  8. package/cache/GeneratedCacheAdapter.d.ts +0 -1
  9. package/cache/GeneratedCacheAdapter.js +0 -2
  10. package/cache/index.d.ts +1 -2
  11. package/cache/index.js +0 -2
  12. package/connections/Connection.d.ts +12 -5
  13. package/connections/Connection.js +37 -15
  14. package/drivers/DatabaseDriver.d.ts +25 -16
  15. package/drivers/DatabaseDriver.js +144 -43
  16. package/drivers/IDatabaseDriver.d.ts +118 -23
  17. package/entity/BaseEntity.d.ts +63 -4
  18. package/entity/BaseEntity.js +0 -3
  19. package/entity/Collection.d.ts +101 -29
  20. package/entity/Collection.js +473 -115
  21. package/entity/EntityAssigner.js +37 -25
  22. package/entity/EntityFactory.d.ts +7 -1
  23. package/entity/EntityFactory.js +116 -64
  24. package/entity/EntityHelper.d.ts +2 -2
  25. package/entity/EntityHelper.js +69 -27
  26. package/entity/EntityLoader.d.ts +11 -10
  27. package/entity/EntityLoader.js +262 -98
  28. package/entity/EntityRepository.d.ts +28 -8
  29. package/entity/EntityRepository.js +8 -2
  30. package/entity/PolymorphicRef.d.ts +12 -0
  31. package/entity/PolymorphicRef.js +18 -0
  32. package/entity/Reference.d.ts +2 -6
  33. package/entity/Reference.js +52 -19
  34. package/entity/WrappedEntity.d.ts +3 -8
  35. package/entity/WrappedEntity.js +6 -7
  36. package/entity/defineEntity.d.ts +525 -311
  37. package/entity/defineEntity.js +134 -290
  38. package/entity/index.d.ts +2 -2
  39. package/entity/index.js +2 -2
  40. package/entity/utils.d.ts +6 -1
  41. package/entity/utils.js +46 -11
  42. package/entity/validators.d.ts +11 -0
  43. package/entity/validators.js +66 -0
  44. package/enums.d.ts +8 -6
  45. package/enums.js +13 -17
  46. package/errors.d.ts +20 -10
  47. package/errors.js +63 -31
  48. package/events/EventManager.d.ts +2 -1
  49. package/events/EventManager.js +24 -13
  50. package/events/index.d.ts +1 -1
  51. package/events/index.js +0 -1
  52. package/exceptions.js +7 -2
  53. package/hydration/Hydrator.js +1 -2
  54. package/hydration/ObjectHydrator.d.ts +4 -4
  55. package/hydration/ObjectHydrator.js +105 -46
  56. package/index.d.ts +2 -2
  57. package/index.js +1 -2
  58. package/logging/DefaultLogger.d.ts +1 -1
  59. package/logging/DefaultLogger.js +3 -4
  60. package/logging/SimpleLogger.d.ts +1 -1
  61. package/logging/colors.d.ts +1 -1
  62. package/logging/colors.js +5 -7
  63. package/logging/index.d.ts +2 -1
  64. package/logging/index.js +1 -1
  65. package/logging/inspect.d.ts +2 -0
  66. package/logging/inspect.js +11 -0
  67. package/metadata/EntitySchema.d.ts +47 -23
  68. package/metadata/EntitySchema.js +103 -34
  69. package/metadata/MetadataDiscovery.d.ts +64 -9
  70. package/metadata/MetadataDiscovery.js +866 -354
  71. package/metadata/MetadataProvider.d.ts +11 -2
  72. package/metadata/MetadataProvider.js +71 -2
  73. package/metadata/MetadataStorage.d.ts +13 -11
  74. package/metadata/MetadataStorage.js +72 -41
  75. package/metadata/MetadataValidator.d.ts +32 -9
  76. package/metadata/MetadataValidator.js +214 -44
  77. package/metadata/discover-entities.d.ts +5 -0
  78. package/metadata/discover-entities.js +40 -0
  79. package/metadata/index.d.ts +1 -1
  80. package/metadata/index.js +0 -1
  81. package/metadata/types.d.ts +577 -0
  82. package/metadata/types.js +1 -0
  83. package/naming-strategy/AbstractNamingStrategy.d.ts +16 -4
  84. package/naming-strategy/AbstractNamingStrategy.js +26 -5
  85. package/naming-strategy/EntityCaseNamingStrategy.d.ts +3 -3
  86. package/naming-strategy/EntityCaseNamingStrategy.js +6 -5
  87. package/naming-strategy/MongoNamingStrategy.d.ts +3 -3
  88. package/naming-strategy/MongoNamingStrategy.js +6 -6
  89. package/naming-strategy/NamingStrategy.d.ts +28 -4
  90. package/naming-strategy/UnderscoreNamingStrategy.d.ts +3 -3
  91. package/naming-strategy/UnderscoreNamingStrategy.js +6 -6
  92. package/naming-strategy/index.d.ts +1 -1
  93. package/naming-strategy/index.js +0 -1
  94. package/not-supported.d.ts +2 -0
  95. package/not-supported.js +8 -0
  96. package/package.json +47 -36
  97. package/platforms/ExceptionConverter.js +1 -1
  98. package/platforms/Platform.d.ts +11 -15
  99. package/platforms/Platform.js +72 -69
  100. package/serialization/EntitySerializer.d.ts +6 -3
  101. package/serialization/EntitySerializer.js +53 -29
  102. package/serialization/EntityTransformer.js +33 -21
  103. package/serialization/SerializationContext.d.ts +6 -6
  104. package/serialization/SerializationContext.js +4 -4
  105. package/types/ArrayType.d.ts +1 -1
  106. package/types/ArrayType.js +2 -3
  107. package/types/BigIntType.js +1 -1
  108. package/types/BlobType.d.ts +0 -1
  109. package/types/BlobType.js +0 -3
  110. package/types/BooleanType.d.ts +1 -0
  111. package/types/BooleanType.js +3 -0
  112. package/types/DecimalType.js +2 -2
  113. package/types/DoubleType.js +1 -1
  114. package/types/EnumArrayType.js +1 -2
  115. package/types/JsonType.d.ts +1 -1
  116. package/types/JsonType.js +7 -2
  117. package/types/TinyIntType.js +1 -1
  118. package/types/Type.d.ts +2 -4
  119. package/types/Type.js +3 -3
  120. package/types/Uint8ArrayType.d.ts +0 -1
  121. package/types/Uint8ArrayType.js +1 -4
  122. package/types/index.d.ts +3 -2
  123. package/typings.d.ts +427 -170
  124. package/typings.js +100 -45
  125. package/unit-of-work/ChangeSet.d.ts +4 -6
  126. package/unit-of-work/ChangeSet.js +8 -9
  127. package/unit-of-work/ChangeSetComputer.d.ts +3 -8
  128. package/unit-of-work/ChangeSetComputer.js +49 -26
  129. package/unit-of-work/ChangeSetPersister.d.ts +13 -12
  130. package/unit-of-work/ChangeSetPersister.js +106 -43
  131. package/unit-of-work/CommitOrderCalculator.d.ts +12 -10
  132. package/unit-of-work/CommitOrderCalculator.js +17 -15
  133. package/unit-of-work/IdentityMap.d.ts +12 -0
  134. package/unit-of-work/IdentityMap.js +39 -1
  135. package/unit-of-work/UnitOfWork.d.ts +34 -4
  136. package/unit-of-work/UnitOfWork.js +294 -107
  137. package/utils/AbstractMigrator.d.ts +101 -0
  138. package/utils/AbstractMigrator.js +303 -0
  139. package/utils/AbstractSchemaGenerator.d.ts +5 -5
  140. package/utils/AbstractSchemaGenerator.js +30 -18
  141. package/utils/AsyncContext.d.ts +6 -0
  142. package/utils/AsyncContext.js +42 -0
  143. package/utils/Configuration.d.ts +795 -211
  144. package/utils/Configuration.js +160 -197
  145. package/utils/ConfigurationLoader.d.ts +1 -52
  146. package/utils/ConfigurationLoader.js +1 -330
  147. package/utils/Cursor.d.ts +0 -3
  148. package/utils/Cursor.js +29 -14
  149. package/utils/DataloaderUtils.d.ts +10 -5
  150. package/utils/DataloaderUtils.js +42 -22
  151. package/utils/EntityComparator.d.ts +16 -9
  152. package/utils/EntityComparator.js +202 -96
  153. package/utils/QueryHelper.d.ts +34 -6
  154. package/utils/QueryHelper.js +181 -48
  155. package/utils/RawQueryFragment.d.ts +28 -34
  156. package/utils/RawQueryFragment.js +37 -72
  157. package/utils/RequestContext.js +2 -2
  158. package/utils/TransactionContext.js +2 -2
  159. package/utils/TransactionManager.js +11 -7
  160. package/utils/Utils.d.ts +16 -127
  161. package/utils/Utils.js +106 -401
  162. package/utils/clone.js +8 -23
  163. package/utils/env-vars.d.ts +7 -0
  164. package/utils/env-vars.js +98 -0
  165. package/utils/fs-utils.d.ts +34 -0
  166. package/utils/fs-utils.js +193 -0
  167. package/utils/index.d.ts +1 -3
  168. package/utils/index.js +1 -3
  169. package/utils/upsert-utils.d.ts +9 -4
  170. package/utils/upsert-utils.js +51 -5
  171. package/decorators/Check.d.ts +0 -3
  172. package/decorators/Check.js +0 -13
  173. package/decorators/CreateRequestContext.d.ts +0 -3
  174. package/decorators/CreateRequestContext.js +0 -32
  175. package/decorators/Embeddable.d.ts +0 -8
  176. package/decorators/Embeddable.js +0 -11
  177. package/decorators/Embedded.d.ts +0 -12
  178. package/decorators/Embedded.js +0 -18
  179. package/decorators/Entity.d.ts +0 -33
  180. package/decorators/Entity.js +0 -12
  181. package/decorators/Enum.d.ts +0 -9
  182. package/decorators/Enum.js +0 -16
  183. package/decorators/Filter.d.ts +0 -2
  184. package/decorators/Filter.js +0 -8
  185. package/decorators/Formula.d.ts +0 -4
  186. package/decorators/Formula.js +0 -15
  187. package/decorators/Indexed.d.ts +0 -19
  188. package/decorators/Indexed.js +0 -20
  189. package/decorators/ManyToMany.d.ts +0 -42
  190. package/decorators/ManyToMany.js +0 -14
  191. package/decorators/ManyToOne.d.ts +0 -34
  192. package/decorators/ManyToOne.js +0 -14
  193. package/decorators/OneToMany.d.ts +0 -28
  194. package/decorators/OneToMany.js +0 -17
  195. package/decorators/OneToOne.d.ts +0 -28
  196. package/decorators/OneToOne.js +0 -7
  197. package/decorators/PrimaryKey.d.ts +0 -8
  198. package/decorators/PrimaryKey.js +0 -20
  199. package/decorators/Property.d.ts +0 -250
  200. package/decorators/Property.js +0 -32
  201. package/decorators/Transactional.d.ts +0 -14
  202. package/decorators/Transactional.js +0 -28
  203. package/decorators/hooks.d.ts +0 -16
  204. package/decorators/hooks.js +0 -47
  205. package/decorators/index.d.ts +0 -17
  206. package/decorators/index.js +0 -17
  207. package/entity/ArrayCollection.d.ts +0 -118
  208. package/entity/ArrayCollection.js +0 -407
  209. package/entity/EntityValidator.d.ts +0 -19
  210. package/entity/EntityValidator.js +0 -150
  211. package/metadata/ReflectMetadataProvider.d.ts +0 -8
  212. package/metadata/ReflectMetadataProvider.js +0 -44
  213. package/utils/resolveContextProvider.d.ts +0 -10
  214. package/utils/resolveContextProvider.js +0 -28
@@ -17,7 +17,9 @@ export declare abstract class Connection {
17
17
  /**
18
18
  * Establishes connection to database
19
19
  */
20
- abstract connect(): void | Promise<void>;
20
+ abstract connect(options?: {
21
+ skipOnConnect?: boolean;
22
+ }): void | Promise<void>;
21
23
  /**
22
24
  * Are we connected to the database
23
25
  */
@@ -37,18 +39,24 @@ export declare abstract class Connection {
37
39
  */
38
40
  close(force?: boolean): Promise<void>;
39
41
  /**
40
- * Ensure the connection exists, this is used to support lazy connect when using `MikroORM.initSync()`
42
+ * Ensure the connection exists, this is used to support lazy connect when using `new MikroORM()` instead of the async `init` method.
41
43
  */
42
44
  ensureConnection(): Promise<void>;
45
+ /**
46
+ * Execute raw SQL queries, handy from running schema dump loaded from a file.
47
+ * This method doesn't support transactions, as opposed to `orm.schema.execute()`, which is used internally.
48
+ */
49
+ executeDump(dump: string): Promise<void>;
50
+ protected onConnect(): Promise<void>;
43
51
  transactional<T>(cb: (trx: Transaction) => Promise<T>, options?: {
44
- isolationLevel?: IsolationLevel;
52
+ isolationLevel?: IsolationLevel | `${IsolationLevel}`;
45
53
  readOnly?: boolean;
46
54
  ctx?: Transaction;
47
55
  eventBroadcaster?: TransactionEventBroadcaster;
48
56
  loggerContext?: LogContext;
49
57
  }): Promise<T>;
50
58
  begin(options?: {
51
- isolationLevel?: IsolationLevel;
59
+ isolationLevel?: IsolationLevel | `${IsolationLevel}`;
52
60
  readOnly?: boolean;
53
61
  ctx?: Transaction;
54
62
  eventBroadcaster?: TransactionEventBroadcaster;
@@ -58,7 +66,6 @@ export declare abstract class Connection {
58
66
  rollback(ctx: Transaction, eventBroadcaster?: TransactionEventBroadcaster, loggerContext?: LogContext): Promise<void>;
59
67
  abstract execute<T>(query: string, params?: any[], method?: 'all' | 'get' | 'run', ctx?: Transaction): Promise<QueryResult<T> | any | any[]>;
60
68
  getConnectionOptions(): ConnectionConfig;
61
- getClientUrl(): string;
62
69
  setMetadata(metadata: MetadataStorage): void;
63
70
  setPlatform(platform: Platform): void;
64
71
  getPlatform(): Platform;
@@ -1,4 +1,3 @@
1
- import { URL } from 'node:url';
2
1
  import { Utils } from '../utils/Utils.js';
3
2
  export class Connection {
4
3
  config;
@@ -17,7 +16,18 @@ export class Connection {
17
16
  this.options = Utils.copy(options);
18
17
  }
19
18
  else {
20
- const props = ['dbName', 'clientUrl', 'host', 'port', 'user', 'password', 'multipleStatements', 'pool', 'schema', 'driverOptions'];
19
+ const props = [
20
+ 'dbName',
21
+ 'clientUrl',
22
+ 'host',
23
+ 'port',
24
+ 'user',
25
+ 'password',
26
+ 'multipleStatements',
27
+ 'pool',
28
+ 'schema',
29
+ 'driverOptions',
30
+ ];
21
31
  this.options = props.reduce((o, i) => {
22
32
  o[i] = this.config.get(i);
23
33
  return o;
@@ -33,13 +43,32 @@ export class Connection {
33
43
  .forEach(k => delete this.options[k]);
34
44
  }
35
45
  /**
36
- * Ensure the connection exists, this is used to support lazy connect when using `MikroORM.initSync()`
46
+ * Ensure the connection exists, this is used to support lazy connect when using `new MikroORM()` instead of the async `init` method.
37
47
  */
38
48
  async ensureConnection() {
39
49
  if (!this.connected) {
40
50
  await this.connect();
41
51
  }
42
52
  }
53
+ /**
54
+ * Execute raw SQL queries, handy from running schema dump loaded from a file.
55
+ * This method doesn't support transactions, as opposed to `orm.schema.execute()`, which is used internally.
56
+ */
57
+ async executeDump(dump) {
58
+ throw new Error(`Executing SQL dumps is not supported by current driver`);
59
+ }
60
+ async onConnect() {
61
+ const schemaGenerator = this.config.getExtension('@mikro-orm/schema-generator');
62
+ if (this.type === 'write' && schemaGenerator) {
63
+ if (this.config.get('ensureDatabase')) {
64
+ const options = this.config.get('ensureDatabase');
65
+ await schemaGenerator.ensureDatabase(typeof options === 'boolean' ? {} : { ...options, forceCheck: true });
66
+ }
67
+ if (this.config.get('ensureIndexes')) {
68
+ await schemaGenerator.ensureIndexes();
69
+ }
70
+ }
71
+ }
43
72
  async transactional(cb, options) {
44
73
  throw new Error(`Transactions are not supported by current driver`);
45
74
  }
@@ -67,24 +96,17 @@ export class Connection {
67
96
  }
68
97
  }
69
98
  else {
70
- const url = new URL(this.config.getClientUrl());
99
+ const url = new URL(this.config.get('clientUrl'));
71
100
  this.options.host = ret.host = this.options.host ?? this.config.get('host', decodeURIComponent(url.hostname));
72
101
  this.options.port = ret.port = this.options.port ?? this.config.get('port', +url.port);
73
102
  this.options.user = ret.user = this.options.user ?? this.config.get('user', decodeURIComponent(url.username));
74
- this.options.password = ret.password = this.options.password ?? this.config.get('password', decodeURIComponent(url.password));
75
- this.options.dbName = ret.database = this.options.dbName ?? this.config.get('dbName', decodeURIComponent(url.pathname).replace(/^\//, ''));
103
+ this.options.password = ret.password =
104
+ this.options.password ?? this.config.get('password', decodeURIComponent(url.password));
105
+ this.options.dbName = ret.database =
106
+ this.options.dbName ?? this.config.get('dbName', decodeURIComponent(url.pathname).replace(/^\//, ''));
76
107
  }
77
108
  return ret;
78
109
  }
79
- getClientUrl() {
80
- const options = this.getConnectionOptions();
81
- const url = new URL(this.config.getClientUrl(true));
82
- const password = options.password ? ':*****' : '';
83
- const schema = options.schema && options.schema !== this.platform.getDefaultSchemaName()
84
- ? `?schema=${options.schema}`
85
- : '';
86
- return `${url.protocol}//${options.user}${password}@${options.host}:${options.port}${schema}`;
87
- }
88
110
  setMetadata(metadata) {
89
111
  this.metadata = metadata;
90
112
  }
@@ -1,5 +1,5 @@
1
- import { type CountOptions, type DeleteOptions, type DriverMethodOptions, EntityManagerType, type FindOneOptions, type FindOptions, type IDatabaseDriver, type LockOptions, type NativeInsertUpdateManyOptions, type NativeInsertUpdateOptions, type OrderDefinition } from './IDatabaseDriver.js';
2
- import type { ConnectionType, Dictionary, EntityData, EntityDictionary, EntityMetadata, EntityProperty, FilterQuery, PopulateOptions, Primary } from '../typings.js';
1
+ import { type CountOptions, type DeleteOptions, type DriverMethodOptions, EntityManagerType, type FindOneOptions, type FindOptions, type IDatabaseDriver, type LockOptions, type NativeInsertUpdateManyOptions, type NativeInsertUpdateOptions, type OrderDefinition, type StreamOptions } from './IDatabaseDriver.js';
2
+ import type { ConnectionType, Constructor, Dictionary, EntityData, EntityDictionary, EntityMetadata, EntityName, EntityProperty, FilterQuery, PopulateOptions, Primary } from '../typings.js';
3
3
  import type { MetadataStorage } from '../metadata/MetadataStorage.js';
4
4
  import type { Connection, QueryResult, Transaction } from '../connections/Connection.js';
5
5
  import { type Configuration, type ConnectionOptions } from '../utils/Configuration.js';
@@ -10,6 +10,7 @@ import type { Collection } from '../entity/Collection.js';
10
10
  import { EntityManager } from '../EntityManager.js';
11
11
  import { DriverException } from '../exceptions.js';
12
12
  import type { Logger } from '../logging/Logger.js';
13
+ import { MikroORM } from '../MikroORM.js';
13
14
  export declare abstract class DatabaseDriver<C extends Connection> implements IDatabaseDriver<C> {
14
15
  readonly config: Configuration;
15
16
  protected readonly dependencies: string[];
@@ -21,29 +22,34 @@ export declare abstract class DatabaseDriver<C extends Connection> implements ID
21
22
  protected comparator: EntityComparator;
22
23
  protected metadata: MetadataStorage;
23
24
  protected constructor(config: Configuration, dependencies: string[]);
24
- abstract find<T extends object, P extends string = never, F extends string = '*', E extends string = never>(entityName: string, where: FilterQuery<T>, options?: FindOptions<T, P, F, E>): Promise<EntityData<T>[]>;
25
- abstract findOne<T extends object, P extends string = never, F extends string = '*', E extends string = never>(entityName: string, where: FilterQuery<T>, options?: FindOneOptions<T, P, F, E>): Promise<EntityData<T> | null>;
26
- abstract nativeInsert<T extends object>(entityName: string, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>;
27
- abstract nativeInsertMany<T extends object>(entityName: string, data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>, transform?: (sql: string) => string): Promise<QueryResult<T>>;
28
- abstract nativeUpdate<T extends object>(entityName: string, where: FilterQuery<T>, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>;
29
- nativeUpdateMany<T extends object>(entityName: string, where: FilterQuery<T>[], data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>): Promise<QueryResult<T>>;
30
- abstract nativeDelete<T extends object>(entityName: string, where: FilterQuery<T>, options?: DeleteOptions<T>): Promise<QueryResult<T>>;
31
- abstract count<T extends object, P extends string = never>(entityName: string, where: FilterQuery<T>, options?: CountOptions<T, P>): Promise<number>;
25
+ abstract find<T extends object, P extends string = never, F extends string = '*', E extends string = never>(entityName: EntityName<T>, where: FilterQuery<T>, options?: FindOptions<T, P, F, E>): Promise<EntityData<T>[]>;
26
+ abstract findOne<T extends object, P extends string = never, F extends string = '*', E extends string = never>(entityName: EntityName<T>, where: FilterQuery<T>, options?: FindOneOptions<T, P, F, E>): Promise<EntityData<T> | null>;
27
+ abstract nativeInsert<T extends object>(entityName: EntityName<T>, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>;
28
+ abstract nativeInsertMany<T extends object>(entityName: EntityName<T>, data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>, transform?: (sql: string) => string): Promise<QueryResult<T>>;
29
+ abstract nativeUpdate<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>;
30
+ nativeUpdateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>[], data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>): Promise<QueryResult<T>>;
31
+ abstract nativeDelete<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, options?: DeleteOptions<T>): Promise<QueryResult<T>>;
32
+ abstract count<T extends object, P extends string = never>(entityName: EntityName<T>, where: FilterQuery<T>, options?: CountOptions<T, P>): Promise<number>;
32
33
  createEntityManager(useContext?: boolean): this[typeof EntityManagerType];
33
- findVirtual<T extends object>(entityName: string, where: FilterQuery<T>, options: FindOptions<T, any, any, any>): Promise<EntityData<T>[]>;
34
- countVirtual<T extends object>(entityName: string, where: FilterQuery<T>, options: CountOptions<T, any>): Promise<number>;
35
- aggregate(entityName: string, pipeline: any[]): Promise<any[]>;
34
+ findVirtual<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, options: FindOptions<T, any, any, any>): Promise<EntityData<T>[]>;
35
+ countVirtual<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, options: CountOptions<T, any>): Promise<number>;
36
+ aggregate(entityName: EntityName, pipeline: any[]): Promise<any[]>;
36
37
  loadFromPivotTable<T extends object, O extends object>(prop: EntityProperty, owners: Primary<O>[][], where?: FilterQuery<any>, orderBy?: OrderDefinition<T>, ctx?: Transaction, options?: FindOptions<T, any, any, any>, pivotJoin?: boolean): Promise<Dictionary<T[]>>;
37
38
  syncCollections<T extends object, O extends object>(collections: Iterable<Collection<T, O>>, options?: DriverMethodOptions): Promise<void>;
38
39
  mapResult<T extends object>(result: EntityDictionary<T>, meta?: EntityMetadata<T>, populate?: PopulateOptions<T>[]): EntityData<T> | null;
39
- connect(): Promise<C>;
40
- reconnect(): Promise<C>;
40
+ connect(options?: {
41
+ skipOnConnect?: boolean;
42
+ }): Promise<C>;
43
+ reconnect(options?: {
44
+ skipOnConnect?: boolean;
45
+ }): Promise<C>;
41
46
  getConnection(type?: ConnectionType): C;
42
47
  close(force?: boolean): Promise<void>;
43
48
  getPlatform(): Platform;
44
49
  setMetadata(metadata: MetadataStorage): void;
45
50
  getMetadata(): MetadataStorage;
46
51
  getDependencies(): string[];
52
+ protected isPopulated<T extends object>(meta: EntityMetadata<T>, prop: EntityProperty<T>, hint: PopulateOptions<T>, name?: string): boolean;
47
53
  protected processCursorOptions<T extends object, P extends string>(meta: EntityMetadata<T>, options: FindOptions<T, P, any, any>, orderBy: OrderDefinition<T>): {
48
54
  orderBy: OrderDefinition<T>[];
49
55
  where: FilterQuery<T>;
@@ -52,9 +58,10 @@ export declare abstract class DatabaseDriver<C extends Connection> implements ID
52
58
  /** @internal */
53
59
  mapDataToFieldNames(data: Dictionary, stringifyJsonArrays: boolean, properties?: Record<string, EntityProperty>, convertCustomTypes?: boolean, object?: boolean): Dictionary;
54
60
  protected inlineEmbeddables<T extends object>(meta: EntityMetadata<T>, data: T, where?: boolean): void;
55
- protected getPrimaryKeyFields(entityName: string): string[];
61
+ protected getPrimaryKeyFields<T>(meta: EntityMetadata<T>): string[];
56
62
  protected createReplicas(cb: (c: ConnectionOptions) => C): C[];
57
63
  lockPessimistic<T extends object>(entity: T, options: LockOptions): Promise<void>;
64
+ abstract stream<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, options: StreamOptions<T>): AsyncIterableIterator<T>;
58
65
  /**
59
66
  * @inheritDoc
60
67
  */
@@ -71,4 +78,6 @@ export declare abstract class DatabaseDriver<C extends Connection> implements ID
71
78
  schema?: string;
72
79
  parentSchema?: string;
73
80
  }): string | undefined;
81
+ /** @internal */
82
+ getORMClass(): Constructor<MikroORM>;
74
83
  }
@@ -8,7 +8,9 @@ import { EntityManager } from '../EntityManager.js';
8
8
  import { CursorError, ValidationError } from '../errors.js';
9
9
  import { DriverException } from '../exceptions.js';
10
10
  import { helper } from '../entity/wrap.js';
11
+ import { PolymorphicRef } from '../entity/PolymorphicRef.js';
11
12
  import { JsonType } from '../types/JsonType.js';
13
+ import { MikroORM } from '../MikroORM.js';
12
14
  export class DatabaseDriver {
13
15
  config;
14
16
  dependencies;
@@ -31,11 +33,11 @@ export class DatabaseDriver {
31
33
  const EntityManagerClass = this.config.get('entityManager', EntityManager);
32
34
  return new EntityManagerClass(this.config, this, this.metadata, useContext);
33
35
  }
34
- /* v8 ignore next 3 */
36
+ /* v8 ignore next */
35
37
  async findVirtual(entityName, where, options) {
36
38
  throw new Error(`Virtual entities are not supported by ${this.constructor.name} driver.`);
37
39
  }
38
- /* v8 ignore next 3 */
40
+ /* v8 ignore next */
39
41
  async countVirtual(entityName, where, options) {
40
42
  throw new Error(`Counting virtual entities is not supported by ${this.constructor.name} driver.`);
41
43
  }
@@ -47,32 +49,35 @@ export class DatabaseDriver {
47
49
  }
48
50
  async syncCollections(collections, options) {
49
51
  for (const coll of collections) {
52
+ /* v8 ignore else */
50
53
  if (!coll.property.owner) {
51
54
  if (coll.getSnapshot() === undefined) {
52
55
  throw ValidationError.cannotModifyInverseCollection(coll.owner, coll.property);
53
56
  }
54
57
  continue;
55
58
  }
56
- /* v8 ignore next 3 */
57
- const pk = coll.property.targetMeta.primaryKeys[0];
58
- const data = { [coll.property.name]: coll.getIdentifiers(pk) };
59
- await this.nativeUpdate(coll.owner.constructor.name, helper(coll.owner).getPrimaryKey(), data, options);
59
+ /* v8 ignore next */
60
+ {
61
+ const pk = coll.property.targetMeta.primaryKeys[0];
62
+ const data = { [coll.property.name]: coll.getIdentifiers(pk) };
63
+ await this.nativeUpdate(coll.owner.constructor, helper(coll.owner).getPrimaryKey(), data, options);
64
+ }
60
65
  }
61
66
  }
62
67
  mapResult(result, meta, populate = []) {
63
68
  if (!result || !meta) {
64
69
  return result ?? null;
65
70
  }
66
- return this.comparator.mapResult(meta.className, result);
71
+ return this.comparator.mapResult(meta, result);
67
72
  }
68
- async connect() {
69
- await this.connection.connect();
73
+ async connect(options) {
74
+ await this.connection.connect(options);
70
75
  await Promise.all(this.replicas.map(replica => replica.connect()));
71
76
  return this.connection;
72
77
  }
73
- async reconnect() {
78
+ async reconnect(options) {
74
79
  await this.close(true);
75
- await this.connect();
80
+ await this.connect(options);
76
81
  return this.connection;
77
82
  }
78
83
  getConnection(type = 'write') {
@@ -105,6 +110,15 @@ export class DatabaseDriver {
105
110
  getDependencies() {
106
111
  return this.dependencies;
107
112
  }
113
+ isPopulated(meta, prop, hint, name) {
114
+ if (hint.field === prop.name || hint.field === name || hint.all) {
115
+ return true;
116
+ }
117
+ if (prop.embedded && hint.children && meta.properties[prop.embedded[0]].name === hint.field) {
118
+ return hint.children.some(c => this.isPopulated(meta, prop, c, prop.embedded[1]));
119
+ }
120
+ return false;
121
+ }
108
122
  processCursorOptions(meta, options, orderBy) {
109
123
  const { first, last, before, after, overfetch } = options;
110
124
  const limit = first ?? last;
@@ -139,15 +153,15 @@ export class DatabaseDriver {
139
153
  }
140
154
  const createOrderBy = (prop, direction) => {
141
155
  if (Utils.isPlainObject(direction)) {
142
- const value = Utils.keys(direction).reduce((o, key) => {
156
+ const value = Utils.getObjectQueryKeys(direction).reduce((o, key) => {
143
157
  Object.assign(o, createOrderBy(key, direction[key]));
144
158
  return o;
145
159
  }, {});
146
- return ({ [prop]: value });
160
+ return { [prop]: value };
147
161
  }
148
162
  const desc = direction === QueryOrderNumeric.DESC || direction.toString().toLowerCase() === 'desc';
149
163
  const dir = Utils.xor(desc, isLast) ? 'desc' : 'asc';
150
- return ({ [prop]: dir });
164
+ return { [prop]: dir };
151
165
  };
152
166
  return {
153
167
  orderBy: definition.map(([prop, direction]) => createOrderBy(prop, direction)),
@@ -155,22 +169,51 @@ export class DatabaseDriver {
155
169
  };
156
170
  }
157
171
  createCursorCondition(definition, offsets, inverse, meta) {
158
- const createCondition = (prop, direction, offset, eq = false) => {
159
- if (offset === null) {
160
- throw CursorError.missingValue(meta.className, prop);
161
- }
172
+ const createCondition = (prop, direction, offset, eq = false, path = prop) => {
162
173
  if (Utils.isPlainObject(direction)) {
174
+ if (offset === undefined) {
175
+ throw CursorError.missingValue(meta.className, path);
176
+ }
163
177
  const value = Utils.keys(direction).reduce((o, key) => {
164
- if (Utils.isEmpty(offset[key])) {
165
- throw CursorError.missingValue(meta.className, `${prop}.${key}`);
166
- }
167
- Object.assign(o, createCondition(key, direction[key], offset[key], eq));
178
+ Object.assign(o, createCondition(key, direction[key], offset?.[key], eq, `${path}.${key}`));
168
179
  return o;
169
180
  }, {});
170
- return ({ [prop]: value });
181
+ return { [prop]: value };
171
182
  }
172
- const desc = direction === QueryOrderNumeric.DESC || direction.toString().toLowerCase() === 'desc';
173
- const operator = Utils.xor(desc, inverse) ? '$lt' : '$gt';
183
+ const isDesc = direction === QueryOrderNumeric.DESC || direction.toString().toLowerCase() === 'desc';
184
+ const dirStr = direction.toString().toLowerCase();
185
+ let nullsFirst;
186
+ if (dirStr.includes('nulls first')) {
187
+ nullsFirst = true;
188
+ }
189
+ else if (dirStr.includes('nulls last')) {
190
+ nullsFirst = false;
191
+ }
192
+ else {
193
+ // Default: NULLS LAST for ASC, NULLS FIRST for DESC (matches most databases)
194
+ nullsFirst = isDesc;
195
+ }
196
+ const operator = Utils.xor(isDesc, inverse) ? '$lt' : '$gt';
197
+ // For leaf-level properties, undefined means missing value
198
+ if (offset === undefined) {
199
+ throw CursorError.missingValue(meta.className, path);
200
+ }
201
+ // Handle null offset (intentional null cursor value)
202
+ if (offset === null) {
203
+ if (eq) {
204
+ // Equal to null
205
+ return { [prop]: null };
206
+ }
207
+ // Strict comparison with null cursor value
208
+ // hasItemsAfterNull: forward + nullsFirst, or backward + nullsLast
209
+ const hasItemsAfterNull = Utils.xor(nullsFirst, inverse);
210
+ if (hasItemsAfterNull) {
211
+ return { [prop]: { $ne: null } };
212
+ }
213
+ // No items after null in this direction, return impossible condition
214
+ return { [prop]: [] };
215
+ }
216
+ // Non-null offset
174
217
  return { [prop]: { [operator + (eq ? 'e' : '')]: offset } };
175
218
  };
176
219
  const [order, ...otherOrders] = definition;
@@ -213,24 +256,68 @@ export class DatabaseDriver {
213
256
  else {
214
257
  data[prop.fieldNames[0]] = this.mapDataToFieldNames(copy, stringifyJsonArrays, prop.embeddedProps, convertCustomTypes, true);
215
258
  }
216
- if (stringifyJsonArrays && prop.array) {
259
+ if (stringifyJsonArrays && prop.array && !object) {
217
260
  data[prop.fieldNames[0]] = this.platform.convertJsonToDatabaseValue(data[prop.fieldNames[0]]);
218
261
  }
219
262
  return;
220
263
  }
264
+ // Handle polymorphic relations - convert tuple or PolymorphicRef to separate columns
265
+ // Tuple format: ['discriminator', id] or ['discriminator', id1, id2] for composite keys
266
+ // Must be checked BEFORE joinColumns array handling since polymorphic uses fieldNames (includes discriminator)
267
+ if (prop.polymorphic && prop.fieldNames && prop.fieldNames.length >= 2) {
268
+ let discriminator;
269
+ let ids;
270
+ if (Array.isArray(data[k]) && typeof data[k][0] === 'string' && prop.discriminatorMap?.[data[k][0]]) {
271
+ // Tuple format: ['discriminator', ...ids]
272
+ const [disc, ...rest] = data[k];
273
+ discriminator = disc;
274
+ ids = rest;
275
+ }
276
+ else if (data[k] instanceof PolymorphicRef) {
277
+ // PolymorphicRef wrapper (internal use)
278
+ discriminator = data[k].discriminator;
279
+ const polyId = data[k].id;
280
+ // Handle object-style composite key IDs like { tenantId: 1, orgId: 100 }
281
+ if (polyId && typeof polyId === 'object' && !Array.isArray(polyId)) {
282
+ const targetEntity = prop.discriminatorMap?.[discriminator];
283
+ const targetMeta = this.metadata.get(targetEntity);
284
+ ids = targetMeta.primaryKeys.map(pk => polyId[pk]);
285
+ }
286
+ else {
287
+ ids = Utils.asArray(polyId);
288
+ }
289
+ }
290
+ if (discriminator) {
291
+ const discriminatorColumn = prop.fieldNames[0];
292
+ const idColumns = prop.fieldNames.slice(1);
293
+ delete data[k];
294
+ data[discriminatorColumn] = discriminator;
295
+ idColumns.forEach((col, idx) => {
296
+ data[col] = ids[idx];
297
+ });
298
+ return;
299
+ }
300
+ }
221
301
  if (prop.joinColumns && Array.isArray(data[k])) {
222
302
  const copy = Utils.flatten(data[k]);
223
303
  delete data[k];
224
- prop.joinColumns.forEach((joinColumn, idx) => data[joinColumn] = copy[idx]);
304
+ prop.joinColumns.forEach((joinColumn, idx) => (data[joinColumn] = copy[idx]));
225
305
  return;
226
306
  }
227
307
  if (prop.joinColumns?.length > 1 && data[k] == null) {
228
308
  delete data[k];
229
- prop.ownColumns.forEach(joinColumn => data[joinColumn] = null);
309
+ prop.ownColumns.forEach(joinColumn => (data[joinColumn] = null));
230
310
  return;
231
311
  }
232
- if (prop.customType && convertCustomTypes && !(prop.customType instanceof JsonType && object) && !isRaw(data[k])) {
233
- data[k] = prop.customType.convertToDatabaseValue(data[k], this.platform, { fromQuery: true, key: k, mode: 'query-data' });
312
+ if (prop.customType &&
313
+ convertCustomTypes &&
314
+ !(prop.customType instanceof JsonType && object) &&
315
+ !isRaw(data[k])) {
316
+ data[k] = prop.customType.convertToDatabaseValue(data[k], this.platform, {
317
+ fromQuery: true,
318
+ key: k,
319
+ mode: 'query-data',
320
+ });
234
321
  }
235
322
  if (prop.hasConvertToDatabaseValueSQL && !prop.object && !isRaw(data[k])) {
236
323
  const quoted = this.platform.quoteValue(data[k]);
@@ -244,7 +331,7 @@ export class DatabaseDriver {
244
331
  return data;
245
332
  }
246
333
  inlineEmbeddables(meta, data, where) {
247
- /* v8 ignore next 3 */
334
+ /* v8 ignore next */
248
335
  if (data == null) {
249
336
  return;
250
337
  }
@@ -264,38 +351,38 @@ export class DatabaseDriver {
264
351
  // explicitly allow `$exists`, `$eq` and `$ne` operators here as they can't be misused this way
265
352
  const operator = Object.keys(data[prop.name]).some(f => Utils.isOperator(f) && !['$exists', '$ne', '$eq'].includes(f));
266
353
  if (operator) {
267
- throw ValidationError.cannotUseOperatorsInsideEmbeddables(meta.className, prop.name, data);
354
+ throw ValidationError.cannotUseOperatorsInsideEmbeddables(meta.class, prop.name, data);
268
355
  }
269
356
  if (prop.object && where) {
270
357
  const inline = (payload, sub, path) => {
271
358
  if (sub.kind === ReferenceKind.EMBEDDED && Utils.isObject(payload[sub.embedded[1]])) {
272
359
  return Object.keys(payload[sub.embedded[1]]).forEach(kkk => {
273
360
  if (!sub.embeddedProps[kkk]) {
274
- throw ValidationError.invalidEmbeddableQuery(meta.className, kkk, sub.type);
361
+ throw ValidationError.invalidEmbeddableQuery(meta.class, kkk, sub.type);
275
362
  }
276
- inline(payload[sub.embedded[1]], sub.embeddedProps[kkk], [...path, sub.embedded[1]]);
363
+ inline(payload[sub.embedded[1]], sub.embeddedProps[kkk], [...path, sub.fieldNames[0]]);
277
364
  });
278
365
  }
279
- data[`${path.join('.')}.${sub.embedded[1]}`] = payload[sub.embedded[1]];
366
+ data[`${path.join('.')}.${sub.fieldNames[0]}`] = payload[sub.embedded[1]];
280
367
  };
281
368
  const parentPropName = kk.substring(0, kk.indexOf('.'));
282
369
  // we might be using some native JSON operator, e.g. with mongodb's `$geoWithin` or `$exists`
283
370
  if (props[kk]) {
284
371
  /* v8 ignore next */
285
- inline(data[prop.name], props[kk] || props[parentPropName], [prop.name]);
372
+ inline(data[prop.name], props[kk] || props[parentPropName], [prop.fieldNames[0]]);
286
373
  }
287
374
  else if (props[parentPropName]) {
288
- data[`${prop.name}.${kk}`] = data[prop.name][kk];
375
+ data[`${prop.fieldNames[0]}.${kk}`] = data[prop.name][kk];
289
376
  }
290
377
  else {
291
378
  unknownProp = true;
292
379
  }
293
380
  }
294
381
  else if (props[kk]) {
295
- data[props[kk].name] = data[prop.name][props[kk].embedded[1]];
382
+ data[props[kk].fieldNames[0]] = data[prop.name][props[kk].embedded[1]];
296
383
  }
297
384
  else {
298
- throw ValidationError.invalidEmbeddableQuery(meta.className, kk, prop.type);
385
+ throw ValidationError.invalidEmbeddableQuery(meta.class, kk, prop.type);
299
386
  }
300
387
  });
301
388
  if (!unknownProp) {
@@ -304,14 +391,24 @@ export class DatabaseDriver {
304
391
  }
305
392
  });
306
393
  }
307
- getPrimaryKeyFields(entityName) {
308
- const meta = this.metadata.find(entityName);
309
- return meta ? Utils.flatten(meta.getPrimaryProps().map(pk => pk.fieldNames)) : [this.config.getNamingStrategy().referenceColumnName()];
394
+ getPrimaryKeyFields(meta) {
395
+ return meta.getPrimaryProps().flatMap(pk => pk.fieldNames);
310
396
  }
311
397
  createReplicas(cb) {
312
398
  const replicas = this.config.get('replicas', []);
313
399
  const ret = [];
314
- const props = ['dbName', 'clientUrl', 'host', 'port', 'user', 'password', 'multipleStatements', 'pool', 'name', 'driverOptions'];
400
+ const props = [
401
+ 'dbName',
402
+ 'clientUrl',
403
+ 'host',
404
+ 'port',
405
+ 'user',
406
+ 'password',
407
+ 'multipleStatements',
408
+ 'pool',
409
+ 'name',
410
+ 'driverOptions',
411
+ ];
315
412
  for (const conf of replicas) {
316
413
  const replicaConfig = Utils.copy(conf);
317
414
  for (const prop of props) {
@@ -372,4 +469,8 @@ export class DatabaseDriver {
372
469
  const schemaName = meta?.schema === '*' ? this.config.getSchema() : meta?.schema;
373
470
  return options?.schema ?? options?.parentSchema ?? schemaName ?? this.config.getSchema();
374
471
  }
472
+ /** @internal */
473
+ getORMClass() {
474
+ return MikroORM;
475
+ }
375
476
  }