@mikro-orm/core 7.0.4-dev.8 → 7.0.4

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 (206) hide show
  1. package/EntityManager.d.ts +884 -583
  2. package/EntityManager.js +1922 -1895
  3. package/MikroORM.d.ts +103 -74
  4. package/MikroORM.js +178 -179
  5. package/README.md +1 -1
  6. package/cache/CacheAdapter.d.ts +36 -36
  7. package/cache/FileCacheAdapter.d.ts +30 -24
  8. package/cache/FileCacheAdapter.js +80 -78
  9. package/cache/GeneratedCacheAdapter.d.ts +18 -20
  10. package/cache/GeneratedCacheAdapter.js +30 -30
  11. package/cache/MemoryCacheAdapter.d.ts +18 -20
  12. package/cache/MemoryCacheAdapter.js +35 -36
  13. package/cache/NullCacheAdapter.d.ts +16 -16
  14. package/cache/NullCacheAdapter.js +24 -24
  15. package/connections/Connection.d.ts +95 -84
  16. package/connections/Connection.js +165 -168
  17. package/drivers/DatabaseDriver.d.ts +186 -80
  18. package/drivers/DatabaseDriver.js +450 -443
  19. package/drivers/IDatabaseDriver.d.ts +440 -301
  20. package/entity/BaseEntity.d.ts +120 -83
  21. package/entity/BaseEntity.js +43 -43
  22. package/entity/Collection.d.ts +212 -179
  23. package/entity/Collection.js +727 -721
  24. package/entity/EntityAssigner.d.ts +88 -77
  25. package/entity/EntityAssigner.js +231 -230
  26. package/entity/EntityFactory.d.ts +66 -54
  27. package/entity/EntityFactory.js +425 -383
  28. package/entity/EntityHelper.d.ts +34 -22
  29. package/entity/EntityHelper.js +280 -267
  30. package/entity/EntityIdentifier.d.ts +4 -4
  31. package/entity/EntityIdentifier.js +10 -10
  32. package/entity/EntityLoader.d.ts +98 -72
  33. package/entity/EntityLoader.js +753 -723
  34. package/entity/EntityRepository.d.ts +316 -201
  35. package/entity/EntityRepository.js +213 -213
  36. package/entity/PolymorphicRef.d.ts +5 -5
  37. package/entity/PolymorphicRef.js +10 -10
  38. package/entity/Reference.d.ts +126 -82
  39. package/entity/Reference.js +278 -274
  40. package/entity/WrappedEntity.d.ts +115 -72
  41. package/entity/WrappedEntity.js +168 -166
  42. package/entity/defineEntity.d.ts +1315 -636
  43. package/entity/defineEntity.js +527 -518
  44. package/entity/utils.d.ts +13 -3
  45. package/entity/utils.js +71 -73
  46. package/entity/validators.js +43 -43
  47. package/entity/wrap.js +8 -8
  48. package/enums.d.ts +258 -253
  49. package/enums.js +251 -252
  50. package/errors.d.ts +114 -72
  51. package/errors.js +350 -253
  52. package/events/EventManager.d.ts +26 -14
  53. package/events/EventManager.js +79 -77
  54. package/events/EventSubscriber.d.ts +29 -29
  55. package/events/TransactionEventBroadcaster.d.ts +15 -8
  56. package/events/TransactionEventBroadcaster.js +14 -14
  57. package/exceptions.d.ts +23 -40
  58. package/exceptions.js +35 -52
  59. package/hydration/Hydrator.d.ts +42 -17
  60. package/hydration/Hydrator.js +43 -43
  61. package/hydration/ObjectHydrator.d.ts +50 -17
  62. package/hydration/ObjectHydrator.js +481 -416
  63. package/index.d.ts +116 -2
  64. package/index.js +10 -1
  65. package/logging/DefaultLogger.d.ts +34 -32
  66. package/logging/DefaultLogger.js +86 -86
  67. package/logging/Logger.d.ts +41 -41
  68. package/logging/SimpleLogger.d.ts +13 -11
  69. package/logging/SimpleLogger.js +22 -22
  70. package/logging/colors.d.ts +6 -6
  71. package/logging/colors.js +11 -10
  72. package/logging/inspect.js +7 -7
  73. package/metadata/EntitySchema.d.ts +211 -127
  74. package/metadata/EntitySchema.js +397 -398
  75. package/metadata/MetadataDiscovery.d.ts +114 -114
  76. package/metadata/MetadataDiscovery.js +1951 -1863
  77. package/metadata/MetadataProvider.d.ts +24 -21
  78. package/metadata/MetadataProvider.js +82 -84
  79. package/metadata/MetadataStorage.d.ts +38 -32
  80. package/metadata/MetadataStorage.js +118 -118
  81. package/metadata/MetadataValidator.d.ts +39 -39
  82. package/metadata/MetadataValidator.js +381 -338
  83. package/metadata/discover-entities.d.ts +5 -2
  84. package/metadata/discover-entities.js +35 -27
  85. package/metadata/types.d.ts +615 -531
  86. package/naming-strategy/AbstractNamingStrategy.d.ts +54 -39
  87. package/naming-strategy/AbstractNamingStrategy.js +90 -85
  88. package/naming-strategy/EntityCaseNamingStrategy.d.ts +6 -6
  89. package/naming-strategy/EntityCaseNamingStrategy.js +22 -22
  90. package/naming-strategy/MongoNamingStrategy.d.ts +6 -6
  91. package/naming-strategy/MongoNamingStrategy.js +18 -18
  92. package/naming-strategy/NamingStrategy.d.ts +109 -99
  93. package/naming-strategy/UnderscoreNamingStrategy.d.ts +7 -7
  94. package/naming-strategy/UnderscoreNamingStrategy.js +21 -21
  95. package/not-supported.js +7 -4
  96. package/package.json +1 -1
  97. package/platforms/ExceptionConverter.d.ts +1 -1
  98. package/platforms/ExceptionConverter.js +4 -4
  99. package/platforms/Platform.d.ts +310 -299
  100. package/platforms/Platform.js +663 -636
  101. package/serialization/EntitySerializer.d.ts +49 -26
  102. package/serialization/EntitySerializer.js +224 -218
  103. package/serialization/EntityTransformer.d.ts +10 -6
  104. package/serialization/EntityTransformer.js +219 -217
  105. package/serialization/SerializationContext.d.ts +27 -23
  106. package/serialization/SerializationContext.js +105 -105
  107. package/types/ArrayType.d.ts +8 -8
  108. package/types/ArrayType.js +33 -33
  109. package/types/BigIntType.d.ts +17 -10
  110. package/types/BigIntType.js +37 -37
  111. package/types/BlobType.d.ts +3 -3
  112. package/types/BlobType.js +13 -13
  113. package/types/BooleanType.d.ts +4 -4
  114. package/types/BooleanType.js +12 -12
  115. package/types/CharacterType.d.ts +2 -2
  116. package/types/CharacterType.js +6 -6
  117. package/types/DateTimeType.d.ts +5 -5
  118. package/types/DateTimeType.js +15 -15
  119. package/types/DateType.d.ts +5 -5
  120. package/types/DateType.js +15 -15
  121. package/types/DecimalType.d.ts +7 -7
  122. package/types/DecimalType.js +26 -26
  123. package/types/DoubleType.d.ts +3 -3
  124. package/types/DoubleType.js +12 -12
  125. package/types/EnumArrayType.d.ts +5 -5
  126. package/types/EnumArrayType.js +24 -24
  127. package/types/EnumType.d.ts +3 -3
  128. package/types/EnumType.js +11 -11
  129. package/types/FloatType.d.ts +3 -3
  130. package/types/FloatType.js +9 -9
  131. package/types/IntegerType.d.ts +3 -3
  132. package/types/IntegerType.js +9 -9
  133. package/types/IntervalType.d.ts +4 -4
  134. package/types/IntervalType.js +12 -12
  135. package/types/JsonType.d.ts +8 -8
  136. package/types/JsonType.js +32 -32
  137. package/types/MediumIntType.d.ts +1 -1
  138. package/types/MediumIntType.js +3 -3
  139. package/types/SmallIntType.d.ts +3 -3
  140. package/types/SmallIntType.js +9 -9
  141. package/types/StringType.d.ts +4 -4
  142. package/types/StringType.js +12 -12
  143. package/types/TextType.d.ts +3 -3
  144. package/types/TextType.js +9 -9
  145. package/types/TimeType.d.ts +5 -5
  146. package/types/TimeType.js +17 -17
  147. package/types/TinyIntType.d.ts +3 -3
  148. package/types/TinyIntType.js +10 -10
  149. package/types/Type.d.ts +83 -79
  150. package/types/Type.js +82 -82
  151. package/types/Uint8ArrayType.d.ts +4 -4
  152. package/types/Uint8ArrayType.js +21 -21
  153. package/types/UnknownType.d.ts +4 -4
  154. package/types/UnknownType.js +12 -12
  155. package/types/UuidType.d.ts +5 -5
  156. package/types/UuidType.js +19 -19
  157. package/types/index.d.ts +75 -49
  158. package/types/index.js +52 -26
  159. package/typings.d.ts +1250 -737
  160. package/typings.js +244 -231
  161. package/unit-of-work/ChangeSet.d.ts +26 -26
  162. package/unit-of-work/ChangeSet.js +56 -56
  163. package/unit-of-work/ChangeSetComputer.d.ts +12 -12
  164. package/unit-of-work/ChangeSetComputer.js +178 -170
  165. package/unit-of-work/ChangeSetPersister.d.ts +63 -44
  166. package/unit-of-work/ChangeSetPersister.js +442 -421
  167. package/unit-of-work/CommitOrderCalculator.d.ts +40 -40
  168. package/unit-of-work/CommitOrderCalculator.js +89 -88
  169. package/unit-of-work/IdentityMap.d.ts +31 -31
  170. package/unit-of-work/IdentityMap.js +105 -105
  171. package/unit-of-work/UnitOfWork.d.ts +181 -141
  172. package/unit-of-work/UnitOfWork.js +1200 -1183
  173. package/utils/AbstractMigrator.d.ts +111 -91
  174. package/utils/AbstractMigrator.js +275 -275
  175. package/utils/AbstractSchemaGenerator.d.ts +43 -34
  176. package/utils/AbstractSchemaGenerator.js +121 -122
  177. package/utils/AsyncContext.d.ts +3 -3
  178. package/utils/AsyncContext.js +34 -35
  179. package/utils/Configuration.d.ts +852 -808
  180. package/utils/Configuration.js +359 -344
  181. package/utils/Cursor.d.ts +40 -22
  182. package/utils/Cursor.js +135 -127
  183. package/utils/DataloaderUtils.d.ts +58 -43
  184. package/utils/DataloaderUtils.js +203 -198
  185. package/utils/EntityComparator.d.ts +98 -81
  186. package/utils/EntityComparator.js +828 -728
  187. package/utils/NullHighlighter.d.ts +1 -1
  188. package/utils/NullHighlighter.js +3 -3
  189. package/utils/QueryHelper.d.ts +79 -51
  190. package/utils/QueryHelper.js +372 -361
  191. package/utils/RawQueryFragment.d.ts +50 -34
  192. package/utils/RawQueryFragment.js +107 -105
  193. package/utils/RequestContext.d.ts +32 -32
  194. package/utils/RequestContext.js +52 -53
  195. package/utils/TransactionContext.d.ts +16 -16
  196. package/utils/TransactionContext.js +27 -27
  197. package/utils/TransactionManager.d.ts +58 -58
  198. package/utils/TransactionManager.js +199 -197
  199. package/utils/Utils.d.ts +204 -145
  200. package/utils/Utils.js +812 -810
  201. package/utils/clone.js +104 -113
  202. package/utils/env-vars.js +90 -88
  203. package/utils/fs-utils.d.ts +15 -15
  204. package/utils/fs-utils.js +180 -181
  205. package/utils/upsert-utils.d.ts +20 -5
  206. package/utils/upsert-utils.js +114 -116
@@ -1,209 +1,324 @@
1
1
  import type { PopulatePath } from '../enums.js';
2
2
  import type { CreateOptions, EntityManager, MergeOptions } from '../EntityManager.js';
3
3
  import type { AssignOptions } from './EntityAssigner.js';
4
- import type { EntityData, EntityName, Primary, Loaded, FilterQuery, EntityDictionary, AutoPath, RequiredEntityData, Ref, EntityType, EntityDTO, MergeSelected, FromEntityType, IsSubset, MergeLoaded, ArrayElement } from '../typings.js';
5
- import type { CountOptions, DeleteOptions, FindAllOptions, FindByCursorOptions, FindOneOptions, FindOneOrFailOptions, FindOptions, GetReferenceOptions, NativeInsertUpdateOptions, StreamOptions, UpdateOptions, UpsertManyOptions, UpsertOptions } from '../drivers/IDatabaseDriver.js';
4
+ import type {
5
+ EntityData,
6
+ EntityName,
7
+ Primary,
8
+ Loaded,
9
+ FilterQuery,
10
+ EntityDictionary,
11
+ AutoPath,
12
+ RequiredEntityData,
13
+ Ref,
14
+ EntityType,
15
+ EntityDTO,
16
+ MergeSelected,
17
+ FromEntityType,
18
+ IsSubset,
19
+ MergeLoaded,
20
+ ArrayElement,
21
+ } from '../typings.js';
22
+ import type {
23
+ CountOptions,
24
+ DeleteOptions,
25
+ FindAllOptions,
26
+ FindByCursorOptions,
27
+ FindOneOptions,
28
+ FindOneOrFailOptions,
29
+ FindOptions,
30
+ GetReferenceOptions,
31
+ NativeInsertUpdateOptions,
32
+ StreamOptions,
33
+ UpdateOptions,
34
+ UpsertManyOptions,
35
+ UpsertOptions,
36
+ } from '../drivers/IDatabaseDriver.js';
6
37
  import type { EntityLoaderOptions } from './EntityLoader.js';
7
38
  import type { Cursor } from '../utils/Cursor.js';
8
39
  /** Repository class providing a type-safe API for querying and persisting a specific entity type. */
9
40
  export declare class EntityRepository<Entity extends object> {
10
- protected readonly em: EntityManager;
11
- protected readonly entityName: EntityName<Entity>;
12
- constructor(em: EntityManager, entityName: EntityName<Entity>);
13
- /**
14
- * Finds first entity matching your `where` query.
15
- */
16
- findOne<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(where: FilterQuery<Entity>, options?: FindOneOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes> | null>;
17
- /**
18
- * Finds first entity matching your `where` query. If nothing is found, it will throw an error.
19
- * You can override the factory for creating this method via `options.failHandler` locally
20
- * or via `Configuration.findOneOrFailHandler` globally.
21
- */
22
- findOneOrFail<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(where: FilterQuery<Entity>, options?: FindOneOrFailOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes>>;
23
- /**
24
- * Creates or updates the entity, based on whether it is already present in the database.
25
- * This method performs an `insert on conflict merge` query ensuring the database is in sync, returning a managed
26
- * entity instance. The method accepts either `entityName` together with the entity `data`, or just entity instance.
27
- *
28
- * ```ts
29
- * // insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
30
- * const author = await em.getRepository(Author).upsert({ email: 'foo@bar.com', age: 33 });
31
- * ```
32
- *
33
- * The entity data needs to contain either the primary key, or any other unique property. Let's consider the following example, where `Author.email` is a unique property:
34
- *
35
- * ```ts
36
- * // insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
37
- * // select "id" from "author" where "email" = 'foo@bar.com'
38
- * const author = await em.getRepository(Author).upsert({ email: 'foo@bar.com', age: 33 });
39
- * ```
40
- *
41
- * Depending on the driver support, this will either use a returning query, or a separate select query, to fetch the primary key if it's missing from the `data`.
42
- *
43
- * If the entity is already present in current context, there won't be any queries - instead, the entity data will be assigned and an explicit `flush` will be required for those changes to be persisted.
44
- */
45
- upsert<Fields extends string = any>(entityOrData?: EntityData<Entity> | Entity, options?: UpsertOptions<Entity, Fields>): Promise<Entity>;
46
- /**
47
- * Creates or updates the entity, based on whether it is already present in the database.
48
- * This method performs an `insert on conflict merge` query ensuring the database is in sync, returning a managed
49
- * entity instance.
50
- *
51
- * ```ts
52
- * // insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
53
- * const authors = await em.getRepository(Author).upsertMany([{ email: 'foo@bar.com', age: 33 }, ...]);
54
- * ```
55
- *
56
- * The entity data needs to contain either the primary key, or any other unique property. Let's consider the following example, where `Author.email` is a unique property:
57
- *
58
- * ```ts
59
- * // insert into "author" ("age", "email") values (33, 'foo@bar.com'), (666, 'lol@lol.lol') on conflict ("email") do update set "age" = excluded."age"
60
- * // select "id" from "author" where "email" = 'foo@bar.com'
61
- * const author = await em.getRepository(Author).upsertMany([
62
- * { email: 'foo@bar.com', age: 33 },
63
- * { email: 'lol@lol.lol', age: 666 },
64
- * ]);
65
- * ```
66
- *
67
- * Depending on the driver support, this will either use a returning query, or a separate select query, to fetch the primary key if it's missing from the `data`.
68
- *
69
- * If the entity is already present in current context, there won't be any queries - instead, the entity data will be assigned and an explicit `flush` will be required for those changes to be persisted.
70
- */
71
- upsertMany<Fields extends string = any>(entitiesOrData?: EntityData<Entity>[] | Entity[], options?: UpsertManyOptions<Entity, Fields>): Promise<Entity[]>;
72
- /**
73
- * Finds all entities matching your `where` query. You can pass additional options via the `options` parameter.
74
- */
75
- find<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(where: FilterQuery<Entity>, options?: FindOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes>[]>;
76
- /**
77
- * Calls `em.find()` and `em.count()` with the same arguments (where applicable) and returns the results as tuple
78
- * where first element is the array of entities, and the second is the count.
79
- */
80
- findAndCount<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(where: FilterQuery<Entity>, options?: FindOptions<Entity, Hint, Fields, Excludes>): Promise<[Loaded<Entity, Hint, Fields, Excludes>[], number]>;
81
- /**
82
- * @inheritDoc EntityManager.findByCursor
83
- */
84
- findByCursor<Hint extends string = never, Fields extends string = never, Excludes extends string = never, IncludeCount extends boolean = true>(options: FindByCursorOptions<Entity, Hint, Fields, Excludes, IncludeCount>): Promise<Cursor<Entity, Hint, Fields, Excludes, IncludeCount>>;
85
- /**
86
- * Finds all entities of given type. You can pass additional options via the `options` parameter.
87
- */
88
- findAll<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(options?: FindAllOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes>[]>;
89
- /**
90
- * @inheritDoc EntityManager.stream
91
- */
92
- stream<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(options?: StreamOptions<Entity, Hint, Fields, Excludes>): AsyncIterableIterator<Loaded<Entity, Hint, Fields, Excludes>>;
93
- /**
94
- * @inheritDoc EntityManager.insert
95
- */
96
- insert(data: Entity | RequiredEntityData<Entity>, options?: NativeInsertUpdateOptions<Entity>): Promise<Primary<Entity>>;
97
- /**
98
- * @inheritDoc EntityManager.insert
99
- */
100
- insertMany(data: Entity[] | RequiredEntityData<Entity>[], options?: NativeInsertUpdateOptions<Entity>): Promise<Primary<Entity>[]>;
101
- /**
102
- * Fires native update query. Calling this has no side effects on the context (identity map).
103
- */
104
- nativeUpdate(where: FilterQuery<Entity>, data: EntityData<Entity>, options?: UpdateOptions<Entity>): Promise<number>;
105
- /**
106
- * Fires native delete query. Calling this has no side effects on the context (identity map).
107
- */
108
- nativeDelete(where: FilterQuery<Entity>, options?: DeleteOptions<Entity>): Promise<number>;
109
- /**
110
- * Maps raw database result to an entity and merges it to this EntityManager.
111
- */
112
- map(result: EntityDictionary<Entity>, options?: {
113
- schema?: string;
114
- }): Entity;
115
- /**
116
- * Gets a reference to the entity identified by the given type and alternate key property without actually loading it.
117
- * The key option specifies which property to use for identity map lookup instead of the primary key.
118
- */
119
- getReference<K extends string & keyof Entity>(id: Entity[K], options: Omit<GetReferenceOptions, 'key' | 'wrapped'> & {
120
- key: K;
121
- wrapped: true;
122
- }): Ref<Entity>;
123
- /**
124
- * Gets a reference to the entity identified by the given type and alternate key property without actually loading it.
125
- * The key option specifies which property to use for identity map lookup instead of the primary key.
126
- */
127
- getReference<K extends string & keyof Entity>(id: Entity[K], options: Omit<GetReferenceOptions, 'key'> & {
128
- key: K;
129
- wrapped?: false;
130
- }): Entity;
131
- /**
132
- * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
133
- */
134
- getReference(id: Primary<Entity>, options: Omit<GetReferenceOptions, 'wrapped' | 'key'> & {
135
- wrapped: true;
136
- }): Ref<Entity>;
137
- /**
138
- * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
139
- */
140
- getReference(id: Primary<Entity> | Primary<Entity>[]): Entity;
141
- /**
142
- * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
143
- */
144
- getReference(id: Primary<Entity>, options: Omit<GetReferenceOptions, 'wrapped' | 'key'> & {
145
- wrapped: false;
146
- }): Entity;
147
- /**
148
- * Checks whether given property can be populated on the entity.
149
- */
150
- canPopulate(property: string): boolean;
151
- /**
152
- * Loads specified relations in batch. This will execute one query for each relation, that will populate it on all the specified entities.
153
- */
154
- populate<Ent extends Entity | Entity[], Hint extends string = never, Naked extends FromEntityType<Entity> = FromEntityType<Entity>, Fields extends string = never, Excludes extends string = never>(entities: Ent, populate: AutoPath<Naked, Hint, PopulatePath.ALL>[] | false, options?: EntityLoaderOptions<Naked, Fields, Excludes>): Promise<Ent extends object[] ? MergeLoaded<ArrayElement<Ent>, Naked, Hint, Fields, Excludes>[] : MergeLoaded<Ent, Naked, Hint, Fields, Excludes>>;
155
- /**
156
- * Creates new instance of given entity and populates it with given data.
157
- * The entity constructor will be used unless you provide `{ managed: true }` in the `options` parameter.
158
- * The constructor will be given parameters based on the defined constructor of the entity. If the constructor
159
- * parameter matches a property name, its value will be extracted from `data`. If no matching property exists,
160
- * the whole `data` parameter will be passed. This means we can also define `constructor(data: Partial<T>)` and
161
- * `em.create()` will pass the data into it (unless we have a property named `data` too).
162
- *
163
- * The parameters are strictly checked, you need to provide all required properties. You can use `OptionalProps`
164
- * symbol to omit some properties from this check without making them optional. Alternatively, use `partial: true`
165
- * in the options to disable the strict checks for required properties. This option has no effect on runtime.
166
- *
167
- * The newly created entity will be automatically marked for persistence via `em.persist` unless you disable this
168
- * behavior, either locally via `persist: false` option, or globally via `persistOnCreate` ORM config option.
169
- */
170
- create<Convert extends boolean = false, Data extends RequiredEntityData<Entity, never, Convert> = RequiredEntityData<Entity, never, Convert>>(data: Data & IsSubset<RequiredEntityData<Entity, never, Convert>, Data>, options?: CreateOptions<Convert>): Entity;
171
- /**
172
- * Creates new instance of given entity and populates it with given data.
173
- * The entity constructor will be used unless you provide `{ managed: true }` in the `options` parameter.
174
- * The constructor will be given parameters based on the defined constructor of the entity. If the constructor
175
- * parameter matches a property name, its value will be extracted from `data`. If no matching property exists,
176
- * the whole `data` parameter will be pass. This means we can also define `constructor(data: Partial<T>)` and
177
- * `em.create()` will pass the data into it (unless we have a property named `data` too).
178
- *
179
- * The parameters are strictly checked, you need to provide all required properties. You can use `OptionalProps`
180
- * symbol to omit some properties from this check without making them optional. Alternatively, use `partial: true`
181
- * in the options to disable the strict checks for required properties. This option has no effect on runtime.
182
- *
183
- * The newly created entity will be automatically marked for persistence via `em.persist` unless you disable this
184
- * behavior, either locally via `persist: false` option, or globally via `persistOnCreate` ORM config option.
185
- */
186
- create<Convert extends boolean = false, Data extends EntityData<Entity, Convert> = EntityData<Entity, Convert>>(data: Data & IsSubset<EntityData<Entity, Convert>, Data>, options: CreateOptions<Convert> & {
187
- partial: true;
188
- }): Entity;
189
- /**
190
- * Shortcut for `wrap(entity).assign(data, { em })`
191
- */
192
- assign<Ent extends EntityType<Entity>, Naked extends FromEntityType<Ent> = FromEntityType<Ent>, Convert extends boolean = false, Data extends EntityData<Naked, Convert> | Partial<EntityDTO<Naked>> = EntityData<Naked, Convert> | Partial<EntityDTO<Naked>>>(entity: Ent | Partial<Ent>, data: Data & IsSubset<EntityData<Naked, Convert>, Data>, options?: AssignOptions<Convert>): MergeSelected<Ent, Naked, keyof Data & string>;
193
- /**
194
- * Merges given entity to this EntityManager so it becomes managed. You can force refreshing of existing entities
195
- * via second parameter. By default it will return already loaded entities without modifying them.
196
- */
197
- merge(data: Entity | EntityData<Entity>, options?: MergeOptions): Entity;
198
- /**
199
- * Returns total number of entities matching your `where` query.
200
- */
201
- count<Hint extends string = never>(where?: FilterQuery<Entity>, options?: CountOptions<Entity, Hint>): Promise<number>;
202
- /** Returns the entity class name associated with this repository. */
203
- getEntityName(): string;
204
- /**
205
- * Returns the underlying EntityManager instance
206
- */
207
- getEntityManager(): EntityManager;
208
- protected validateRepositoryType(entities: Entity[] | Entity, method: string): void;
41
+ protected readonly em: EntityManager;
42
+ protected readonly entityName: EntityName<Entity>;
43
+ constructor(em: EntityManager, entityName: EntityName<Entity>);
44
+ /**
45
+ * Finds first entity matching your `where` query.
46
+ */
47
+ findOne<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(
48
+ where: FilterQuery<Entity>,
49
+ options?: FindOneOptions<Entity, Hint, Fields, Excludes>,
50
+ ): Promise<Loaded<Entity, Hint, Fields, Excludes> | null>;
51
+ /**
52
+ * Finds first entity matching your `where` query. If nothing is found, it will throw an error.
53
+ * You can override the factory for creating this method via `options.failHandler` locally
54
+ * or via `Configuration.findOneOrFailHandler` globally.
55
+ */
56
+ findOneOrFail<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(
57
+ where: FilterQuery<Entity>,
58
+ options?: FindOneOrFailOptions<Entity, Hint, Fields, Excludes>,
59
+ ): Promise<Loaded<Entity, Hint, Fields, Excludes>>;
60
+ /**
61
+ * Creates or updates the entity, based on whether it is already present in the database.
62
+ * This method performs an `insert on conflict merge` query ensuring the database is in sync, returning a managed
63
+ * entity instance. The method accepts either `entityName` together with the entity `data`, or just entity instance.
64
+ *
65
+ * ```ts
66
+ * // insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
67
+ * const author = await em.getRepository(Author).upsert({ email: 'foo@bar.com', age: 33 });
68
+ * ```
69
+ *
70
+ * The entity data needs to contain either the primary key, or any other unique property. Let's consider the following example, where `Author.email` is a unique property:
71
+ *
72
+ * ```ts
73
+ * // insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
74
+ * // select "id" from "author" where "email" = 'foo@bar.com'
75
+ * const author = await em.getRepository(Author).upsert({ email: 'foo@bar.com', age: 33 });
76
+ * ```
77
+ *
78
+ * Depending on the driver support, this will either use a returning query, or a separate select query, to fetch the primary key if it's missing from the `data`.
79
+ *
80
+ * If the entity is already present in current context, there won't be any queries - instead, the entity data will be assigned and an explicit `flush` will be required for those changes to be persisted.
81
+ */
82
+ upsert<Fields extends string = any>(
83
+ entityOrData?: EntityData<Entity> | Entity,
84
+ options?: UpsertOptions<Entity, Fields>,
85
+ ): Promise<Entity>;
86
+ /**
87
+ * Creates or updates the entity, based on whether it is already present in the database.
88
+ * This method performs an `insert on conflict merge` query ensuring the database is in sync, returning a managed
89
+ * entity instance.
90
+ *
91
+ * ```ts
92
+ * // insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
93
+ * const authors = await em.getRepository(Author).upsertMany([{ email: 'foo@bar.com', age: 33 }, ...]);
94
+ * ```
95
+ *
96
+ * The entity data needs to contain either the primary key, or any other unique property. Let's consider the following example, where `Author.email` is a unique property:
97
+ *
98
+ * ```ts
99
+ * // insert into "author" ("age", "email") values (33, 'foo@bar.com'), (666, 'lol@lol.lol') on conflict ("email") do update set "age" = excluded."age"
100
+ * // select "id" from "author" where "email" = 'foo@bar.com'
101
+ * const author = await em.getRepository(Author).upsertMany([
102
+ * { email: 'foo@bar.com', age: 33 },
103
+ * { email: 'lol@lol.lol', age: 666 },
104
+ * ]);
105
+ * ```
106
+ *
107
+ * Depending on the driver support, this will either use a returning query, or a separate select query, to fetch the primary key if it's missing from the `data`.
108
+ *
109
+ * If the entity is already present in current context, there won't be any queries - instead, the entity data will be assigned and an explicit `flush` will be required for those changes to be persisted.
110
+ */
111
+ upsertMany<Fields extends string = any>(
112
+ entitiesOrData?: EntityData<Entity>[] | Entity[],
113
+ options?: UpsertManyOptions<Entity, Fields>,
114
+ ): Promise<Entity[]>;
115
+ /**
116
+ * Finds all entities matching your `where` query. You can pass additional options via the `options` parameter.
117
+ */
118
+ find<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(
119
+ where: FilterQuery<Entity>,
120
+ options?: FindOptions<Entity, Hint, Fields, Excludes>,
121
+ ): Promise<Loaded<Entity, Hint, Fields, Excludes>[]>;
122
+ /**
123
+ * Calls `em.find()` and `em.count()` with the same arguments (where applicable) and returns the results as tuple
124
+ * where first element is the array of entities, and the second is the count.
125
+ */
126
+ findAndCount<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(
127
+ where: FilterQuery<Entity>,
128
+ options?: FindOptions<Entity, Hint, Fields, Excludes>,
129
+ ): Promise<[Loaded<Entity, Hint, Fields, Excludes>[], number]>;
130
+ /**
131
+ * @inheritDoc EntityManager.findByCursor
132
+ */
133
+ findByCursor<
134
+ Hint extends string = never,
135
+ Fields extends string = never,
136
+ Excludes extends string = never,
137
+ IncludeCount extends boolean = true,
138
+ >(
139
+ options: FindByCursorOptions<Entity, Hint, Fields, Excludes, IncludeCount>,
140
+ ): Promise<Cursor<Entity, Hint, Fields, Excludes, IncludeCount>>;
141
+ /**
142
+ * Finds all entities of given type. You can pass additional options via the `options` parameter.
143
+ */
144
+ findAll<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(
145
+ options?: FindAllOptions<Entity, Hint, Fields, Excludes>,
146
+ ): Promise<Loaded<Entity, Hint, Fields, Excludes>[]>;
147
+ /**
148
+ * @inheritDoc EntityManager.stream
149
+ */
150
+ stream<Hint extends string = never, Fields extends string = never, Excludes extends string = never>(
151
+ options?: StreamOptions<Entity, Hint, Fields, Excludes>,
152
+ ): AsyncIterableIterator<Loaded<Entity, Hint, Fields, Excludes>>;
153
+ /**
154
+ * @inheritDoc EntityManager.insert
155
+ */
156
+ insert(
157
+ data: Entity | RequiredEntityData<Entity>,
158
+ options?: NativeInsertUpdateOptions<Entity>,
159
+ ): Promise<Primary<Entity>>;
160
+ /**
161
+ * @inheritDoc EntityManager.insert
162
+ */
163
+ insertMany(
164
+ data: Entity[] | RequiredEntityData<Entity>[],
165
+ options?: NativeInsertUpdateOptions<Entity>,
166
+ ): Promise<Primary<Entity>[]>;
167
+ /**
168
+ * Fires native update query. Calling this has no side effects on the context (identity map).
169
+ */
170
+ nativeUpdate(where: FilterQuery<Entity>, data: EntityData<Entity>, options?: UpdateOptions<Entity>): Promise<number>;
171
+ /**
172
+ * Fires native delete query. Calling this has no side effects on the context (identity map).
173
+ */
174
+ nativeDelete(where: FilterQuery<Entity>, options?: DeleteOptions<Entity>): Promise<number>;
175
+ /**
176
+ * Maps raw database result to an entity and merges it to this EntityManager.
177
+ */
178
+ map(
179
+ result: EntityDictionary<Entity>,
180
+ options?: {
181
+ schema?: string;
182
+ },
183
+ ): Entity;
184
+ /**
185
+ * Gets a reference to the entity identified by the given type and alternate key property without actually loading it.
186
+ * The key option specifies which property to use for identity map lookup instead of the primary key.
187
+ */
188
+ getReference<K extends string & keyof Entity>(
189
+ id: Entity[K],
190
+ options: Omit<GetReferenceOptions, 'key' | 'wrapped'> & {
191
+ key: K;
192
+ wrapped: true;
193
+ },
194
+ ): Ref<Entity>;
195
+ /**
196
+ * Gets a reference to the entity identified by the given type and alternate key property without actually loading it.
197
+ * The key option specifies which property to use for identity map lookup instead of the primary key.
198
+ */
199
+ getReference<K extends string & keyof Entity>(
200
+ id: Entity[K],
201
+ options: Omit<GetReferenceOptions, 'key'> & {
202
+ key: K;
203
+ wrapped?: false;
204
+ },
205
+ ): Entity;
206
+ /**
207
+ * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
208
+ */
209
+ getReference(
210
+ id: Primary<Entity>,
211
+ options: Omit<GetReferenceOptions, 'wrapped' | 'key'> & {
212
+ wrapped: true;
213
+ },
214
+ ): Ref<Entity>;
215
+ /**
216
+ * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
217
+ */
218
+ getReference(id: Primary<Entity> | Primary<Entity>[]): Entity;
219
+ /**
220
+ * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
221
+ */
222
+ getReference(
223
+ id: Primary<Entity>,
224
+ options: Omit<GetReferenceOptions, 'wrapped' | 'key'> & {
225
+ wrapped: false;
226
+ },
227
+ ): Entity;
228
+ /**
229
+ * Checks whether given property can be populated on the entity.
230
+ */
231
+ canPopulate(property: string): boolean;
232
+ /**
233
+ * Loads specified relations in batch. This will execute one query for each relation, that will populate it on all the specified entities.
234
+ */
235
+ populate<
236
+ Ent extends Entity | Entity[],
237
+ Hint extends string = never,
238
+ Naked extends FromEntityType<Entity> = FromEntityType<Entity>,
239
+ Fields extends string = never,
240
+ Excludes extends string = never,
241
+ >(
242
+ entities: Ent,
243
+ populate: AutoPath<Naked, Hint, PopulatePath.ALL>[] | false,
244
+ options?: EntityLoaderOptions<Naked, Fields, Excludes>,
245
+ ): Promise<
246
+ Ent extends object[]
247
+ ? MergeLoaded<ArrayElement<Ent>, Naked, Hint, Fields, Excludes>[]
248
+ : MergeLoaded<Ent, Naked, Hint, Fields, Excludes>
249
+ >;
250
+ /**
251
+ * Creates new instance of given entity and populates it with given data.
252
+ * The entity constructor will be used unless you provide `{ managed: true }` in the `options` parameter.
253
+ * The constructor will be given parameters based on the defined constructor of the entity. If the constructor
254
+ * parameter matches a property name, its value will be extracted from `data`. If no matching property exists,
255
+ * the whole `data` parameter will be passed. This means we can also define `constructor(data: Partial<T>)` and
256
+ * `em.create()` will pass the data into it (unless we have a property named `data` too).
257
+ *
258
+ * The parameters are strictly checked, you need to provide all required properties. You can use `OptionalProps`
259
+ * symbol to omit some properties from this check without making them optional. Alternatively, use `partial: true`
260
+ * in the options to disable the strict checks for required properties. This option has no effect on runtime.
261
+ *
262
+ * The newly created entity will be automatically marked for persistence via `em.persist` unless you disable this
263
+ * behavior, either locally via `persist: false` option, or globally via `persistOnCreate` ORM config option.
264
+ */
265
+ create<
266
+ Convert extends boolean = false,
267
+ Data extends RequiredEntityData<Entity, never, Convert> = RequiredEntityData<Entity, never, Convert>,
268
+ >(data: Data & IsSubset<RequiredEntityData<Entity, never, Convert>, Data>, options?: CreateOptions<Convert>): Entity;
269
+ /**
270
+ * Creates new instance of given entity and populates it with given data.
271
+ * The entity constructor will be used unless you provide `{ managed: true }` in the `options` parameter.
272
+ * The constructor will be given parameters based on the defined constructor of the entity. If the constructor
273
+ * parameter matches a property name, its value will be extracted from `data`. If no matching property exists,
274
+ * the whole `data` parameter will be pass. This means we can also define `constructor(data: Partial<T>)` and
275
+ * `em.create()` will pass the data into it (unless we have a property named `data` too).
276
+ *
277
+ * The parameters are strictly checked, you need to provide all required properties. You can use `OptionalProps`
278
+ * symbol to omit some properties from this check without making them optional. Alternatively, use `partial: true`
279
+ * in the options to disable the strict checks for required properties. This option has no effect on runtime.
280
+ *
281
+ * The newly created entity will be automatically marked for persistence via `em.persist` unless you disable this
282
+ * behavior, either locally via `persist: false` option, or globally via `persistOnCreate` ORM config option.
283
+ */
284
+ create<Convert extends boolean = false, Data extends EntityData<Entity, Convert> = EntityData<Entity, Convert>>(
285
+ data: Data & IsSubset<EntityData<Entity, Convert>, Data>,
286
+ options: CreateOptions<Convert> & {
287
+ partial: true;
288
+ },
289
+ ): Entity;
290
+ /**
291
+ * Shortcut for `wrap(entity).assign(data, { em })`
292
+ */
293
+ assign<
294
+ Ent extends EntityType<Entity>,
295
+ Naked extends FromEntityType<Ent> = FromEntityType<Ent>,
296
+ Convert extends boolean = false,
297
+ Data extends EntityData<Naked, Convert> | Partial<EntityDTO<Naked>> =
298
+ | EntityData<Naked, Convert>
299
+ | Partial<EntityDTO<Naked>>,
300
+ >(
301
+ entity: Ent | Partial<Ent>,
302
+ data: Data & IsSubset<EntityData<Naked, Convert>, Data>,
303
+ options?: AssignOptions<Convert>,
304
+ ): MergeSelected<Ent, Naked, keyof Data & string>;
305
+ /**
306
+ * Merges given entity to this EntityManager so it becomes managed. You can force refreshing of existing entities
307
+ * via second parameter. By default it will return already loaded entities without modifying them.
308
+ */
309
+ merge(data: Entity | EntityData<Entity>, options?: MergeOptions): Entity;
310
+ /**
311
+ * Returns total number of entities matching your `where` query.
312
+ */
313
+ count<Hint extends string = never>(
314
+ where?: FilterQuery<Entity>,
315
+ options?: CountOptions<Entity, Hint>,
316
+ ): Promise<number>;
317
+ /** Returns the entity class name associated with this repository. */
318
+ getEntityName(): string;
319
+ /**
320
+ * Returns the underlying EntityManager instance
321
+ */
322
+ getEntityManager(): EntityManager;
323
+ protected validateRepositoryType(entities: Entity[] | Entity, method: string): void;
209
324
  }