@mikro-orm/core 7.0.2-dev.9 → 7.0.2

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 (207) hide show
  1. package/EntityManager.d.ts +883 -579
  2. package/EntityManager.js +1897 -1865
  3. package/MikroORM.d.ts +103 -72
  4. package/MikroORM.js +178 -177
  5. package/README.md +128 -294
  6. package/cache/CacheAdapter.d.ts +38 -36
  7. package/cache/FileCacheAdapter.d.ts +30 -24
  8. package/cache/FileCacheAdapter.js +80 -78
  9. package/cache/GeneratedCacheAdapter.d.ts +19 -20
  10. package/cache/GeneratedCacheAdapter.js +31 -30
  11. package/cache/MemoryCacheAdapter.d.ts +19 -20
  12. package/cache/MemoryCacheAdapter.js +36 -36
  13. package/cache/NullCacheAdapter.d.ts +17 -16
  14. package/cache/NullCacheAdapter.js +25 -24
  15. package/connections/Connection.d.ts +99 -75
  16. package/connections/Connection.js +166 -160
  17. package/drivers/DatabaseDriver.d.ts +187 -69
  18. package/drivers/DatabaseDriver.js +451 -432
  19. package/drivers/IDatabaseDriver.d.ts +464 -281
  20. package/drivers/IDatabaseDriver.js +1 -0
  21. package/entity/BaseEntity.d.ts +121 -73
  22. package/entity/BaseEntity.js +44 -33
  23. package/entity/Collection.d.ts +216 -157
  24. package/entity/Collection.js +728 -707
  25. package/entity/EntityAssigner.d.ts +90 -76
  26. package/entity/EntityAssigner.js +232 -229
  27. package/entity/EntityFactory.d.ts +68 -40
  28. package/entity/EntityFactory.js +427 -366
  29. package/entity/EntityHelper.d.ts +34 -22
  30. package/entity/EntityHelper.js +280 -267
  31. package/entity/EntityIdentifier.d.ts +4 -4
  32. package/entity/EntityIdentifier.js +10 -10
  33. package/entity/EntityLoader.d.ts +105 -56
  34. package/entity/EntityLoader.js +754 -722
  35. package/entity/EntityRepository.d.ts +317 -200
  36. package/entity/EntityRepository.js +214 -212
  37. package/entity/PolymorphicRef.d.ts +5 -5
  38. package/entity/PolymorphicRef.js +10 -10
  39. package/entity/Reference.d.ts +130 -66
  40. package/entity/Reference.js +280 -260
  41. package/entity/WrappedEntity.d.ts +116 -53
  42. package/entity/WrappedEntity.js +169 -147
  43. package/entity/defineEntity.d.ts +1290 -614
  44. package/entity/defineEntity.js +521 -511
  45. package/entity/utils.d.ts +13 -3
  46. package/entity/utils.js +71 -73
  47. package/entity/validators.js +43 -43
  48. package/entity/wrap.js +8 -8
  49. package/enums.d.ts +275 -138
  50. package/enums.js +268 -137
  51. package/errors.d.ts +120 -72
  52. package/errors.js +356 -253
  53. package/events/EventManager.d.ts +27 -10
  54. package/events/EventManager.js +80 -73
  55. package/events/EventSubscriber.d.ts +33 -29
  56. package/events/TransactionEventBroadcaster.d.ts +16 -7
  57. package/events/TransactionEventBroadcaster.js +15 -13
  58. package/exceptions.d.ts +23 -40
  59. package/exceptions.js +35 -52
  60. package/hydration/Hydrator.d.ts +43 -16
  61. package/hydration/Hydrator.js +44 -42
  62. package/hydration/ObjectHydrator.d.ts +51 -17
  63. package/hydration/ObjectHydrator.js +480 -416
  64. package/index.d.ts +116 -2
  65. package/index.js +10 -1
  66. package/logging/DefaultLogger.d.ts +35 -30
  67. package/logging/DefaultLogger.js +87 -84
  68. package/logging/Logger.d.ts +45 -40
  69. package/logging/SimpleLogger.d.ts +13 -11
  70. package/logging/SimpleLogger.js +22 -22
  71. package/logging/colors.d.ts +6 -6
  72. package/logging/colors.js +11 -10
  73. package/logging/inspect.js +7 -7
  74. package/metadata/EntitySchema.d.ts +214 -108
  75. package/metadata/EntitySchema.js +398 -379
  76. package/metadata/MetadataDiscovery.d.ts +115 -111
  77. package/metadata/MetadataDiscovery.js +1948 -1857
  78. package/metadata/MetadataProvider.d.ts +25 -14
  79. package/metadata/MetadataProvider.js +83 -77
  80. package/metadata/MetadataStorage.d.ts +39 -19
  81. package/metadata/MetadataStorage.js +119 -106
  82. package/metadata/MetadataValidator.d.ts +39 -39
  83. package/metadata/MetadataValidator.js +381 -338
  84. package/metadata/discover-entities.d.ts +5 -2
  85. package/metadata/discover-entities.js +27 -27
  86. package/metadata/types.d.ts +615 -531
  87. package/naming-strategy/AbstractNamingStrategy.d.ts +55 -39
  88. package/naming-strategy/AbstractNamingStrategy.js +91 -85
  89. package/naming-strategy/EntityCaseNamingStrategy.d.ts +6 -6
  90. package/naming-strategy/EntityCaseNamingStrategy.js +22 -22
  91. package/naming-strategy/MongoNamingStrategy.d.ts +7 -6
  92. package/naming-strategy/MongoNamingStrategy.js +19 -18
  93. package/naming-strategy/NamingStrategy.d.ts +109 -99
  94. package/naming-strategy/UnderscoreNamingStrategy.d.ts +8 -7
  95. package/naming-strategy/UnderscoreNamingStrategy.js +22 -21
  96. package/not-supported.js +7 -4
  97. package/package.json +1 -1
  98. package/platforms/ExceptionConverter.d.ts +2 -1
  99. package/platforms/ExceptionConverter.js +5 -4
  100. package/platforms/Platform.d.ts +310 -236
  101. package/platforms/Platform.js +661 -573
  102. package/serialization/EntitySerializer.d.ts +49 -25
  103. package/serialization/EntitySerializer.js +224 -216
  104. package/serialization/EntityTransformer.d.ts +11 -5
  105. package/serialization/EntityTransformer.js +220 -216
  106. package/serialization/SerializationContext.d.ts +27 -18
  107. package/serialization/SerializationContext.js +105 -100
  108. package/types/ArrayType.d.ts +9 -8
  109. package/types/ArrayType.js +34 -33
  110. package/types/BigIntType.d.ts +17 -10
  111. package/types/BigIntType.js +37 -37
  112. package/types/BlobType.d.ts +4 -3
  113. package/types/BlobType.js +14 -13
  114. package/types/BooleanType.d.ts +5 -4
  115. package/types/BooleanType.js +13 -12
  116. package/types/CharacterType.d.ts +3 -2
  117. package/types/CharacterType.js +7 -6
  118. package/types/DateTimeType.d.ts +6 -5
  119. package/types/DateTimeType.js +16 -15
  120. package/types/DateType.d.ts +6 -5
  121. package/types/DateType.js +16 -15
  122. package/types/DecimalType.d.ts +7 -7
  123. package/types/DecimalType.js +26 -26
  124. package/types/DoubleType.d.ts +3 -3
  125. package/types/DoubleType.js +12 -12
  126. package/types/EnumArrayType.d.ts +6 -5
  127. package/types/EnumArrayType.js +25 -24
  128. package/types/EnumType.d.ts +4 -3
  129. package/types/EnumType.js +12 -11
  130. package/types/FloatType.d.ts +4 -3
  131. package/types/FloatType.js +10 -9
  132. package/types/IntegerType.d.ts +4 -3
  133. package/types/IntegerType.js +10 -9
  134. package/types/IntervalType.d.ts +5 -4
  135. package/types/IntervalType.js +13 -12
  136. package/types/JsonType.d.ts +9 -8
  137. package/types/JsonType.js +33 -32
  138. package/types/MediumIntType.d.ts +2 -1
  139. package/types/MediumIntType.js +4 -3
  140. package/types/SmallIntType.d.ts +4 -3
  141. package/types/SmallIntType.js +10 -9
  142. package/types/StringType.d.ts +5 -4
  143. package/types/StringType.js +13 -12
  144. package/types/TextType.d.ts +4 -3
  145. package/types/TextType.js +10 -9
  146. package/types/TimeType.d.ts +6 -5
  147. package/types/TimeType.js +18 -17
  148. package/types/TinyIntType.d.ts +4 -3
  149. package/types/TinyIntType.js +11 -10
  150. package/types/Type.d.ts +88 -73
  151. package/types/Type.js +85 -74
  152. package/types/Uint8ArrayType.d.ts +5 -4
  153. package/types/Uint8ArrayType.js +22 -21
  154. package/types/UnknownType.d.ts +5 -4
  155. package/types/UnknownType.js +13 -12
  156. package/types/UuidType.d.ts +6 -5
  157. package/types/UuidType.js +20 -19
  158. package/types/index.d.ts +77 -49
  159. package/types/index.js +64 -26
  160. package/typings.d.ts +1388 -729
  161. package/typings.js +255 -231
  162. package/unit-of-work/ChangeSet.d.ts +28 -24
  163. package/unit-of-work/ChangeSet.js +58 -54
  164. package/unit-of-work/ChangeSetComputer.d.ts +13 -11
  165. package/unit-of-work/ChangeSetComputer.js +180 -159
  166. package/unit-of-work/ChangeSetPersister.d.ts +64 -41
  167. package/unit-of-work/ChangeSetPersister.js +443 -418
  168. package/unit-of-work/CommitOrderCalculator.d.ts +40 -40
  169. package/unit-of-work/CommitOrderCalculator.js +89 -88
  170. package/unit-of-work/IdentityMap.d.ts +32 -25
  171. package/unit-of-work/IdentityMap.js +106 -99
  172. package/unit-of-work/UnitOfWork.d.ts +182 -127
  173. package/unit-of-work/UnitOfWork.js +1201 -1169
  174. package/utils/AbstractMigrator.d.ts +111 -91
  175. package/utils/AbstractMigrator.js +275 -275
  176. package/utils/AbstractSchemaGenerator.d.ts +43 -34
  177. package/utils/AbstractSchemaGenerator.js +121 -122
  178. package/utils/AsyncContext.d.ts +3 -3
  179. package/utils/AsyncContext.js +34 -35
  180. package/utils/Configuration.d.ts +853 -801
  181. package/utils/Configuration.js +360 -337
  182. package/utils/Cursor.d.ts +40 -22
  183. package/utils/Cursor.js +135 -127
  184. package/utils/DataloaderUtils.d.ts +58 -43
  185. package/utils/DataloaderUtils.js +203 -198
  186. package/utils/EntityComparator.d.ts +99 -80
  187. package/utils/EntityComparator.js +825 -727
  188. package/utils/NullHighlighter.d.ts +2 -1
  189. package/utils/NullHighlighter.js +4 -3
  190. package/utils/QueryHelper.d.ts +79 -51
  191. package/utils/QueryHelper.js +372 -361
  192. package/utils/RawQueryFragment.d.ts +54 -28
  193. package/utils/RawQueryFragment.js +110 -99
  194. package/utils/RequestContext.d.ts +33 -32
  195. package/utils/RequestContext.js +52 -53
  196. package/utils/TransactionContext.d.ts +17 -16
  197. package/utils/TransactionContext.js +28 -27
  198. package/utils/TransactionManager.d.ts +58 -58
  199. package/utils/TransactionManager.js +199 -197
  200. package/utils/Utils.d.ts +210 -145
  201. package/utils/Utils.js +820 -813
  202. package/utils/clone.js +104 -113
  203. package/utils/env-vars.js +90 -88
  204. package/utils/fs-utils.d.ts +15 -15
  205. package/utils/fs-utils.js +180 -181
  206. package/utils/upsert-utils.d.ts +20 -5
  207. package/utils/upsert-utils.js +114 -116
@@ -1,207 +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';
39
+ /** Repository class providing a type-safe API for querying and persisting a specific entity type. */
8
40
  export declare class EntityRepository<Entity extends object> {
9
- protected readonly em: EntityManager;
10
- protected readonly entityName: EntityName<Entity>;
11
- constructor(em: EntityManager, entityName: EntityName<Entity>);
12
- /**
13
- * Finds first entity matching your `where` query.
14
- */
15
- findOne<Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(where: FilterQuery<Entity>, options?: FindOneOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes> | null>;
16
- /**
17
- * Finds first entity matching your `where` query. If nothing is found, it will throw an error.
18
- * You can override the factory for creating this method via `options.failHandler` locally
19
- * or via `Configuration.findOneOrFailHandler` globally.
20
- */
21
- findOneOrFail<Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(where: FilterQuery<Entity>, options?: FindOneOrFailOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes>>;
22
- /**
23
- * Creates or updates the entity, based on whether it is already present in the database.
24
- * This method performs an `insert on conflict merge` query ensuring the database is in sync, returning a managed
25
- * entity instance. The method accepts either `entityName` together with the entity `data`, or just entity instance.
26
- *
27
- * ```ts
28
- * // insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
29
- * const author = await em.getRepository(Author).upsert({ email: 'foo@bar.com', age: 33 });
30
- * ```
31
- *
32
- * 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:
33
- *
34
- * ```ts
35
- * // insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
36
- * // select "id" from "author" where "email" = 'foo@bar.com'
37
- * const author = await em.getRepository(Author).upsert({ email: 'foo@bar.com', age: 33 });
38
- * ```
39
- *
40
- * 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`.
41
- *
42
- * 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.
43
- */
44
- upsert<Fields extends string = any>(entityOrData?: EntityData<Entity> | Entity, options?: UpsertOptions<Entity, Fields>): Promise<Entity>;
45
- /**
46
- * Creates or updates the entity, based on whether it is already present in the database.
47
- * This method performs an `insert on conflict merge` query ensuring the database is in sync, returning a managed
48
- * entity instance.
49
- *
50
- * ```ts
51
- * // insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
52
- * const authors = await em.getRepository(Author).upsertMany([{ email: 'foo@bar.com', age: 33 }, ...]);
53
- * ```
54
- *
55
- * 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:
56
- *
57
- * ```ts
58
- * // insert into "author" ("age", "email") values (33, 'foo@bar.com'), (666, 'lol@lol.lol') on conflict ("email") do update set "age" = excluded."age"
59
- * // select "id" from "author" where "email" = 'foo@bar.com'
60
- * const author = await em.getRepository(Author).upsertMany([
61
- * { email: 'foo@bar.com', age: 33 },
62
- * { email: 'lol@lol.lol', age: 666 },
63
- * ]);
64
- * ```
65
- *
66
- * 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`.
67
- *
68
- * 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.
69
- */
70
- upsertMany<Fields extends string = any>(entitiesOrData?: EntityData<Entity>[] | Entity[], options?: UpsertManyOptions<Entity, Fields>): Promise<Entity[]>;
71
- /**
72
- * Finds all entities matching your `where` query. You can pass additional options via the `options` parameter.
73
- */
74
- find<Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(where: FilterQuery<Entity>, options?: FindOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes>[]>;
75
- /**
76
- * Calls `em.find()` and `em.count()` with the same arguments (where applicable) and returns the results as tuple
77
- * where first element is the array of entities, and the second is the count.
78
- */
79
- findAndCount<Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(where: FilterQuery<Entity>, options?: FindOptions<Entity, Hint, Fields, Excludes>): Promise<[Loaded<Entity, Hint, Fields, Excludes>[], number]>;
80
- /**
81
- * @inheritDoc EntityManager.findByCursor
82
- */
83
- findByCursor<Hint extends string = never, Fields extends string = '*', Excludes extends string = never, IncludeCount extends boolean = true>(options: FindByCursorOptions<Entity, Hint, Fields, Excludes, IncludeCount>): Promise<Cursor<Entity, Hint, Fields, Excludes, IncludeCount>>;
84
- /**
85
- * Finds all entities of given type. You can pass additional options via the `options` parameter.
86
- */
87
- findAll<Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(options?: FindAllOptions<Entity, Hint, Fields, Excludes>): Promise<Loaded<Entity, Hint, Fields, Excludes>[]>;
88
- /**
89
- * @inheritDoc EntityManager.stream
90
- */
91
- stream<Hint extends string = never, Fields extends string = '*', Excludes extends string = never>(options?: StreamOptions<Entity, Hint, Fields, Excludes>): AsyncIterableIterator<Loaded<Entity, Hint, Fields, Excludes>>;
92
- /**
93
- * @inheritDoc EntityManager.insert
94
- */
95
- insert(data: Entity | RequiredEntityData<Entity>, options?: NativeInsertUpdateOptions<Entity>): Promise<Primary<Entity>>;
96
- /**
97
- * @inheritDoc EntityManager.insert
98
- */
99
- insertMany(data: Entity[] | RequiredEntityData<Entity>[], options?: NativeInsertUpdateOptions<Entity>): Promise<Primary<Entity>[]>;
100
- /**
101
- * Fires native update query. Calling this has no side effects on the context (identity map).
102
- */
103
- nativeUpdate(where: FilterQuery<Entity>, data: EntityData<Entity>, options?: UpdateOptions<Entity>): Promise<number>;
104
- /**
105
- * Fires native delete query. Calling this has no side effects on the context (identity map).
106
- */
107
- nativeDelete(where: FilterQuery<Entity>, options?: DeleteOptions<Entity>): Promise<number>;
108
- /**
109
- * Maps raw database result to an entity and merges it to this EntityManager.
110
- */
111
- map(result: EntityDictionary<Entity>, options?: {
112
- schema?: string;
113
- }): Entity;
114
- /**
115
- * Gets a reference to the entity identified by the given type and alternate key property without actually loading it.
116
- * The key option specifies which property to use for identity map lookup instead of the primary key.
117
- */
118
- getReference<K extends string & keyof Entity>(id: Entity[K], options: Omit<GetReferenceOptions, 'key' | 'wrapped'> & {
119
- key: K;
120
- wrapped: true;
121
- }): Ref<Entity>;
122
- /**
123
- * Gets a reference to the entity identified by the given type and alternate key property without actually loading it.
124
- * The key option specifies which property to use for identity map lookup instead of the primary key.
125
- */
126
- getReference<K extends string & keyof Entity>(id: Entity[K], options: Omit<GetReferenceOptions, 'key'> & {
127
- key: K;
128
- wrapped?: false;
129
- }): Entity;
130
- /**
131
- * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
132
- */
133
- getReference(id: Primary<Entity>, options: Omit<GetReferenceOptions, 'wrapped' | 'key'> & {
134
- wrapped: true;
135
- }): Ref<Entity>;
136
- /**
137
- * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
138
- */
139
- getReference(id: Primary<Entity> | Primary<Entity>[]): Entity;
140
- /**
141
- * Gets a reference to the entity identified by the given type and identifier without actually loading it, if the entity is not yet loaded
142
- */
143
- getReference(id: Primary<Entity>, options: Omit<GetReferenceOptions, 'wrapped' | 'key'> & {
144
- wrapped: false;
145
- }): Entity;
146
- /**
147
- * Checks whether given property can be populated on the entity.
148
- */
149
- canPopulate(property: string): boolean;
150
- /**
151
- * Loads specified relations in batch. This will execute one query for each relation, that will populate it on all the specified entities.
152
- */
153
- 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>>;
154
- /**
155
- * Creates new instance of given entity and populates it with given data.
156
- * The entity constructor will be used unless you provide `{ managed: true }` in the `options` parameter.
157
- * The constructor will be given parameters based on the defined constructor of the entity. If the constructor
158
- * parameter matches a property name, its value will be extracted from `data`. If no matching property exists,
159
- * the whole `data` parameter will be passed. This means we can also define `constructor(data: Partial<T>)` and
160
- * `em.create()` will pass the data into it (unless we have a property named `data` too).
161
- *
162
- * The parameters are strictly checked, you need to provide all required properties. You can use `OptionalProps`
163
- * symbol to omit some properties from this check without making them optional. Alternatively, use `partial: true`
164
- * in the options to disable the strict checks for required properties. This option has no effect on runtime.
165
- *
166
- * The newly created entity will be automatically marked for persistence via `em.persist` unless you disable this
167
- * behavior, either locally via `persist: false` option, or globally via `persistOnCreate` ORM config option.
168
- */
169
- 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;
170
- /**
171
- * Creates new instance of given entity and populates it with given data.
172
- * The entity constructor will be used unless you provide `{ managed: true }` in the `options` parameter.
173
- * The constructor will be given parameters based on the defined constructor of the entity. If the constructor
174
- * parameter matches a property name, its value will be extracted from `data`. If no matching property exists,
175
- * the whole `data` parameter will be pass. This means we can also define `constructor(data: Partial<T>)` and
176
- * `em.create()` will pass the data into it (unless we have a property named `data` too).
177
- *
178
- * The parameters are strictly checked, you need to provide all required properties. You can use `OptionalProps`
179
- * symbol to omit some properties from this check without making them optional. Alternatively, use `partial: true`
180
- * in the options to disable the strict checks for required properties. This option has no effect on runtime.
181
- *
182
- * The newly created entity will be automatically marked for persistence via `em.persist` unless you disable this
183
- * behavior, either locally via `persist: false` option, or globally via `persistOnCreate` ORM config option.
184
- */
185
- create<Convert extends boolean = false, Data extends EntityData<Entity, Convert> = EntityData<Entity, Convert>>(data: Data & IsSubset<EntityData<Entity, Convert>, Data>, options: CreateOptions<Convert> & {
186
- partial: true;
187
- }): Entity;
188
- /**
189
- * Shortcut for `wrap(entity).assign(data, { em })`
190
- */
191
- 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>;
192
- /**
193
- * Merges given entity to this EntityManager so it becomes managed. You can force refreshing of existing entities
194
- * via second parameter. By default it will return already loaded entities without modifying them.
195
- */
196
- merge(data: Entity | EntityData<Entity>, options?: MergeOptions): Entity;
197
- /**
198
- * Returns total number of entities matching your `where` query.
199
- */
200
- count<Hint extends string = never>(where?: FilterQuery<Entity>, options?: CountOptions<Entity, Hint>): Promise<number>;
201
- getEntityName(): string;
202
- /**
203
- * Returns the underlying EntityManager instance
204
- */
205
- getEntityManager(): EntityManager;
206
- 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 = '*', 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 = '*', 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 = '*', 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 = '*', 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 = '*',
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 = '*', 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 = '*', 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;
207
324
  }