@mikro-orm/core 6.4.17-dev.10 → 6.4.17-dev.100
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.
- package/EntityManager.d.ts +11 -2
- package/EntityManager.js +39 -53
- package/README.md +1 -2
- package/connections/Connection.d.ts +4 -2
- package/connections/Connection.js +2 -2
- package/decorators/Entity.d.ts +14 -0
- package/decorators/Indexed.d.ts +2 -2
- package/decorators/Transactional.d.ts +1 -0
- package/decorators/Transactional.js +3 -3
- package/drivers/IDatabaseDriver.d.ts +4 -0
- package/entity/ArrayCollection.d.ts +3 -1
- package/entity/ArrayCollection.js +7 -2
- package/entity/EntityFactory.d.ts +6 -0
- package/entity/EntityFactory.js +17 -6
- package/entity/EntityHelper.js +4 -1
- package/entity/EntityLoader.js +26 -18
- package/entity/Reference.d.ts +5 -0
- package/entity/Reference.js +16 -0
- package/entity/WrappedEntity.js +1 -1
- package/entity/defineEntity.d.ts +537 -0
- package/entity/defineEntity.js +703 -0
- package/entity/index.d.ts +2 -0
- package/entity/index.js +2 -0
- package/entity/utils.d.ts +7 -0
- package/entity/utils.js +16 -3
- package/enums.d.ts +13 -1
- package/enums.js +13 -1
- package/errors.d.ts +5 -0
- package/errors.js +13 -1
- package/hydration/ObjectHydrator.js +1 -1
- package/index.d.ts +1 -1
- package/index.mjs +16 -0
- package/metadata/MetadataDiscovery.d.ts +0 -1
- package/metadata/MetadataDiscovery.js +16 -13
- package/package.json +4 -4
- package/platforms/Platform.d.ts +3 -1
- package/types/BooleanType.d.ts +1 -1
- package/types/DecimalType.js +1 -1
- package/types/DoubleType.js +1 -1
- package/typings.d.ts +31 -11
- package/typings.js +21 -4
- package/unit-of-work/ChangeSetPersister.d.ts +4 -2
- package/unit-of-work/ChangeSetPersister.js +14 -10
- package/unit-of-work/UnitOfWork.d.ts +1 -1
- package/unit-of-work/UnitOfWork.js +22 -6
- package/utils/Configuration.d.ts +7 -1
- package/utils/Configuration.js +1 -0
- package/utils/ConfigurationLoader.js +2 -2
- package/utils/Cursor.js +3 -0
- package/utils/EntityComparator.d.ts +6 -2
- package/utils/EntityComparator.js +29 -8
- package/utils/QueryHelper.d.ts +6 -0
- package/utils/QueryHelper.js +47 -4
- package/utils/RawQueryFragment.d.ts +34 -0
- package/utils/RawQueryFragment.js +35 -0
- package/utils/TransactionManager.d.ts +65 -0
- package/utils/TransactionManager.js +203 -0
- package/utils/Utils.d.ts +2 -2
- package/utils/Utils.js +32 -8
- package/utils/index.d.ts +1 -0
- package/utils/index.js +1 -0
- package/utils/upsert-utils.js +9 -1
|
@@ -13,16 +13,18 @@ class ChangeSetPersister {
|
|
|
13
13
|
factory;
|
|
14
14
|
validator;
|
|
15
15
|
config;
|
|
16
|
+
em;
|
|
16
17
|
platform;
|
|
17
18
|
comparator;
|
|
18
19
|
usesReturningStatement;
|
|
19
|
-
constructor(driver, metadata, hydrator, factory, validator, config) {
|
|
20
|
+
constructor(driver, metadata, hydrator, factory, validator, config, em) {
|
|
20
21
|
this.driver = driver;
|
|
21
22
|
this.metadata = metadata;
|
|
22
23
|
this.hydrator = hydrator;
|
|
23
24
|
this.factory = factory;
|
|
24
25
|
this.validator = validator;
|
|
25
26
|
this.config = config;
|
|
27
|
+
this.em = em;
|
|
26
28
|
this.platform = this.driver.getPlatform();
|
|
27
29
|
this.comparator = this.config.getComparator(this.metadata);
|
|
28
30
|
this.usesReturningStatement = this.platform.usesReturningStatement() || this.platform.usesOutputStatement();
|
|
@@ -63,7 +65,7 @@ class ChangeSetPersister {
|
|
|
63
65
|
for (let i = 0; i < changeSets.length; i += size) {
|
|
64
66
|
const chunk = changeSets.slice(i, i + size);
|
|
65
67
|
const pks = chunk.map(cs => cs.getPrimaryKey());
|
|
66
|
-
options = this.
|
|
68
|
+
options = this.prepareOptions(meta, options);
|
|
67
69
|
await this.driver.nativeDelete(meta.root.className, { [pk]: { $in: pks } }, options);
|
|
68
70
|
}
|
|
69
71
|
}
|
|
@@ -91,7 +93,7 @@ class ChangeSetPersister {
|
|
|
91
93
|
}
|
|
92
94
|
async persistNewEntity(meta, changeSet, options) {
|
|
93
95
|
const wrapped = (0, entity_1.helper)(changeSet.entity);
|
|
94
|
-
options = this.
|
|
96
|
+
options = this.prepareOptions(meta, options, {
|
|
95
97
|
convertCustomTypes: false,
|
|
96
98
|
});
|
|
97
99
|
const res = await this.driver.nativeInsertMany(meta.className, [changeSet.payload], options);
|
|
@@ -117,15 +119,17 @@ class ChangeSetPersister {
|
|
|
117
119
|
}
|
|
118
120
|
}
|
|
119
121
|
}
|
|
120
|
-
|
|
122
|
+
prepareOptions(meta, options, additionalOptions) {
|
|
123
|
+
const loggerContext = utils_1.Utils.merge({ id: this.em._id }, this.em.getLoggerContext({ disableContextResolution: true }));
|
|
121
124
|
return {
|
|
122
125
|
...options,
|
|
123
126
|
...additionalOptions,
|
|
124
127
|
schema: options?.schema ?? meta.schema,
|
|
128
|
+
loggerContext,
|
|
125
129
|
};
|
|
126
130
|
}
|
|
127
131
|
async persistNewEntitiesBatch(meta, changeSets, options) {
|
|
128
|
-
options = this.
|
|
132
|
+
options = this.prepareOptions(meta, options, {
|
|
129
133
|
convertCustomTypes: false,
|
|
130
134
|
processCollections: false,
|
|
131
135
|
});
|
|
@@ -176,7 +180,7 @@ class ChangeSetPersister {
|
|
|
176
180
|
}
|
|
177
181
|
async persistManagedEntitiesBatch(meta, changeSets, options) {
|
|
178
182
|
await this.checkOptimisticLocks(meta, changeSets, options);
|
|
179
|
-
options = this.
|
|
183
|
+
options = this.prepareOptions(meta, options, {
|
|
180
184
|
convertCustomTypes: false,
|
|
181
185
|
processCollections: false,
|
|
182
186
|
});
|
|
@@ -236,7 +240,7 @@ class ChangeSetPersister {
|
|
|
236
240
|
}
|
|
237
241
|
async updateEntity(meta, changeSet, options) {
|
|
238
242
|
const cond = changeSet.getPrimaryKey(true);
|
|
239
|
-
options = this.
|
|
243
|
+
options = this.prepareOptions(meta, options, {
|
|
240
244
|
convertCustomTypes: false,
|
|
241
245
|
});
|
|
242
246
|
if (meta.concurrencyCheckKeys.size === 0 && (!meta.versionProperty || changeSet.entity[meta.versionProperty] == null)) {
|
|
@@ -263,7 +267,7 @@ class ChangeSetPersister {
|
|
|
263
267
|
return cond;
|
|
264
268
|
});
|
|
265
269
|
const primaryKeys = meta.primaryKeys.concat(...meta.concurrencyCheckKeys);
|
|
266
|
-
options = this.
|
|
270
|
+
options = this.prepareOptions(meta, options, {
|
|
267
271
|
fields: primaryKeys,
|
|
268
272
|
});
|
|
269
273
|
const res = await this.driver.find(meta.root.className, { $or }, options);
|
|
@@ -322,12 +326,12 @@ class ChangeSetPersister {
|
|
|
322
326
|
}
|
|
323
327
|
return val;
|
|
324
328
|
});
|
|
325
|
-
options = this.
|
|
329
|
+
options = this.prepareOptions(meta, options, {
|
|
326
330
|
fields: utils_1.Utils.unique(reloadProps.map(prop => prop.name)),
|
|
327
331
|
});
|
|
328
332
|
const data = await this.driver.find(meta.className, { [pk]: { $in: pks } }, options);
|
|
329
333
|
const map = new Map();
|
|
330
|
-
data.forEach(item => map.set(utils_1.Utils.getCompositeKeyHash(item, meta,
|
|
334
|
+
data.forEach(item => map.set(utils_1.Utils.getCompositeKeyHash(item, meta, false, this.platform, true), item));
|
|
331
335
|
for (const changeSet of changeSets) {
|
|
332
336
|
const data = map.get((0, entity_1.helper)(changeSet.entity).getSerializedPrimaryKey());
|
|
333
337
|
this.hydrator.hydrate(changeSet.entity, meta, data, this.factory, 'full', false, true);
|
|
@@ -38,7 +38,7 @@ export declare class UnitOfWork {
|
|
|
38
38
|
/**
|
|
39
39
|
* Returns entity from the identity map. For composite keys, you need to pass an array of PKs in the same order as they are defined in `meta.primaryKeys`.
|
|
40
40
|
*/
|
|
41
|
-
getById<T extends object>(entityName: string, id: Primary<T> | Primary<T>[], schema?: string): T | undefined;
|
|
41
|
+
getById<T extends object>(entityName: string, id: Primary<T> | Primary<T>[], schema?: string, convertCustomTypes?: boolean): T | undefined;
|
|
42
42
|
tryGetById<T extends object>(entityName: string, where: FilterQuery<T>, schema?: string, strict?: boolean): T | null;
|
|
43
43
|
/**
|
|
44
44
|
* Returns map of all managed entities.
|
|
@@ -42,7 +42,7 @@ class UnitOfWork {
|
|
|
42
42
|
this.eventManager = this.em.getEventManager();
|
|
43
43
|
this.comparator = this.em.getComparator();
|
|
44
44
|
this.changeSetComputer = new ChangeSetComputer_1.ChangeSetComputer(this.em.getValidator(), this.collectionUpdates, this.metadata, this.platform, this.em.config, this.em);
|
|
45
|
-
this.changeSetPersister = new ChangeSetPersister_1.ChangeSetPersister(this.em.getDriver(), this.metadata, this.em.config.getHydrator(this.metadata), this.em.getEntityFactory(), this.em.getValidator(), this.em.config);
|
|
45
|
+
this.changeSetPersister = new ChangeSetPersister_1.ChangeSetPersister(this.em.getDriver(), this.metadata, this.em.config.getHydrator(this.metadata), this.em.getEntityFactory(), this.em.getValidator(), this.em.config, this.em);
|
|
46
46
|
}
|
|
47
47
|
merge(entity, visited) {
|
|
48
48
|
const wrapped = (0, entity_1.helper)(entity);
|
|
@@ -88,7 +88,7 @@ class UnitOfWork {
|
|
|
88
88
|
}
|
|
89
89
|
wrapped.__loadedProperties.add(key);
|
|
90
90
|
if ([enums_1.ReferenceKind.MANY_TO_ONE, enums_1.ReferenceKind.ONE_TO_ONE].includes(prop.kind) && Utils_1.Utils.isPlainObject(data[prop.name])) {
|
|
91
|
-
data[prop.name] = Utils_1.Utils.getPrimaryKeyValues(data[prop.name], prop.targetMeta
|
|
91
|
+
data[prop.name] = Utils_1.Utils.getPrimaryKeyValues(data[prop.name], prop.targetMeta, true);
|
|
92
92
|
}
|
|
93
93
|
else if (prop.kind === enums_1.ReferenceKind.EMBEDDED && !prop.object && Utils_1.Utils.isPlainObject(data[prop.name])) {
|
|
94
94
|
for (const p of prop.targetMeta.props) {
|
|
@@ -96,7 +96,7 @@ class UnitOfWork {
|
|
|
96
96
|
const prefix = prop.prefix === false ? '' : prop.prefix === true ? prop.name + '_' : prop.prefix;
|
|
97
97
|
data[prefix + p.name] = data[prop.name][p.name];
|
|
98
98
|
}
|
|
99
|
-
data[prop.name] = Utils_1.Utils.getPrimaryKeyValues(data[prop.name], prop.targetMeta
|
|
99
|
+
data[prop.name] = Utils_1.Utils.getPrimaryKeyValues(data[prop.name], prop.targetMeta, true);
|
|
100
100
|
}
|
|
101
101
|
if (forceUndefined) {
|
|
102
102
|
if (data[key] === null) {
|
|
@@ -124,7 +124,7 @@ class UnitOfWork {
|
|
|
124
124
|
/**
|
|
125
125
|
* Returns entity from the identity map. For composite keys, you need to pass an array of PKs in the same order as they are defined in `meta.primaryKeys`.
|
|
126
126
|
*/
|
|
127
|
-
getById(entityName, id, schema) {
|
|
127
|
+
getById(entityName, id, schema, convertCustomTypes) {
|
|
128
128
|
if (id == null || (Array.isArray(id) && id.length === 0)) {
|
|
129
129
|
return undefined;
|
|
130
130
|
}
|
|
@@ -134,7 +134,16 @@ class UnitOfWork {
|
|
|
134
134
|
hash = '' + id;
|
|
135
135
|
}
|
|
136
136
|
else {
|
|
137
|
-
|
|
137
|
+
let keys = Array.isArray(id) ? Utils_1.Utils.flatten(id) : [id];
|
|
138
|
+
keys = meta.getPrimaryProps(true).map((p, i) => {
|
|
139
|
+
if (!convertCustomTypes && p.customType) {
|
|
140
|
+
return p.customType.convertToDatabaseValue(keys[i], this.platform, {
|
|
141
|
+
key: p.name,
|
|
142
|
+
mode: 'hydration',
|
|
143
|
+
});
|
|
144
|
+
}
|
|
145
|
+
return keys[i];
|
|
146
|
+
});
|
|
138
147
|
hash = Utils_1.Utils.getPrimaryKeyHash(keys);
|
|
139
148
|
}
|
|
140
149
|
schema ??= meta.schema ?? this.em.config.getSchema();
|
|
@@ -312,9 +321,11 @@ class UnitOfWork {
|
|
|
312
321
|
const platform = this.em.getPlatform();
|
|
313
322
|
const runInTransaction = !this.em.isInTransaction() && platform.supportsTransactions() && this.em.config.get('implicitTransactions');
|
|
314
323
|
if (runInTransaction) {
|
|
324
|
+
const loggerContext = Utils_1.Utils.merge({ id: this.em._id }, this.em.getLoggerContext({ disableContextResolution: true }));
|
|
315
325
|
await this.em.getConnection('write').transactional(trx => this.persistToDatabase(groups, trx), {
|
|
316
326
|
ctx: oldTx,
|
|
317
327
|
eventBroadcaster: new events_1.TransactionEventBroadcaster(this.em, this),
|
|
328
|
+
loggerContext,
|
|
318
329
|
});
|
|
319
330
|
}
|
|
320
331
|
else {
|
|
@@ -888,7 +899,12 @@ class UnitOfWork {
|
|
|
888
899
|
}
|
|
889
900
|
async commitCollectionUpdates(ctx) {
|
|
890
901
|
this.filterCollectionUpdates();
|
|
891
|
-
|
|
902
|
+
const loggerContext = Utils_1.Utils.merge({ id: this.em._id }, this.em.getLoggerContext({ disableContextResolution: true }));
|
|
903
|
+
await this.em.getDriver().syncCollections(this.collectionUpdates, {
|
|
904
|
+
ctx,
|
|
905
|
+
schema: this.em.schema,
|
|
906
|
+
loggerContext,
|
|
907
|
+
});
|
|
892
908
|
for (const coll of this.collectionUpdates) {
|
|
893
909
|
coll.takeSnapshot();
|
|
894
910
|
}
|
package/utils/Configuration.d.ts
CHANGED
|
@@ -77,6 +77,7 @@ export declare class Configuration<D extends IDatabaseDriver = IDatabaseDriver,
|
|
|
77
77
|
upsertManaged: true;
|
|
78
78
|
forceEntityConstructor: false;
|
|
79
79
|
forceUndefined: false;
|
|
80
|
+
processOnCreateHooksEarly: false;
|
|
80
81
|
ensureDatabase: true;
|
|
81
82
|
ensureIndexes: false;
|
|
82
83
|
batchSize: number;
|
|
@@ -345,6 +346,11 @@ export interface MikroORMOptions<D extends IDatabaseDriver = IDatabaseDriver, EM
|
|
|
345
346
|
upsertManaged: boolean;
|
|
346
347
|
forceEntityConstructor: boolean | (Constructor<AnyEntity> | string)[];
|
|
347
348
|
forceUndefined: boolean;
|
|
349
|
+
/**
|
|
350
|
+
* Property `onCreate` hooks are normally executed during `flush` operation.
|
|
351
|
+
* With this option, they will be processed early inside `em.create()` method.
|
|
352
|
+
*/
|
|
353
|
+
processOnCreateHooksEarly: boolean;
|
|
348
354
|
forceUtcTimezone?: boolean;
|
|
349
355
|
timezone?: string;
|
|
350
356
|
ensureDatabase: boolean | EnsureDatabaseOptions;
|
|
@@ -353,7 +359,7 @@ export interface MikroORMOptions<D extends IDatabaseDriver = IDatabaseDriver, EM
|
|
|
353
359
|
useBatchUpdates?: boolean;
|
|
354
360
|
batchSize: number;
|
|
355
361
|
hydrator: HydratorConstructor;
|
|
356
|
-
loadStrategy: LoadStrategy |
|
|
362
|
+
loadStrategy: LoadStrategy | `${LoadStrategy}`;
|
|
357
363
|
dataloader: DataloaderType | boolean;
|
|
358
364
|
populateWhere?: PopulateHint | `${PopulateHint}`;
|
|
359
365
|
flushMode: FlushMode | 'commit' | 'auto' | 'always';
|
package/utils/Configuration.js
CHANGED
|
@@ -213,7 +213,7 @@ class ConfigurationLoader {
|
|
|
213
213
|
const baseDir = options instanceof Configuration_1.Configuration ? options.get('baseDir') : options?.baseDir;
|
|
214
214
|
const path = process.env.MIKRO_ORM_ENV ?? ((baseDir ?? process.cwd()) + '/.env');
|
|
215
215
|
const env = {};
|
|
216
|
-
dotenv_1.default.config({ path, processEnv: env });
|
|
216
|
+
dotenv_1.default.config({ path, processEnv: env, quiet: true });
|
|
217
217
|
// only propagate known env vars
|
|
218
218
|
for (const key of Object.keys(env)) {
|
|
219
219
|
if (key.startsWith('MIKRO_ORM_')) {
|
|
@@ -347,7 +347,7 @@ class ConfigurationLoader {
|
|
|
347
347
|
// inspired by https://github.com/facebook/docusaurus/pull/3386
|
|
348
348
|
static checkPackageVersion() {
|
|
349
349
|
const coreVersion = Utils_1.Utils.getORMVersion();
|
|
350
|
-
if (process.env.MIKRO_ORM_ALLOW_VERSION_MISMATCH) {
|
|
350
|
+
if (process.env.MIKRO_ORM_ALLOW_VERSION_MISMATCH || coreVersion === 'N/A') {
|
|
351
351
|
return coreVersion;
|
|
352
352
|
}
|
|
353
353
|
const deps = this.getORMPackages();
|
package/utils/Cursor.js
CHANGED
|
@@ -110,6 +110,9 @@ class Cursor {
|
|
|
110
110
|
if (Utils_1.Utils.isEntity(value, true)) {
|
|
111
111
|
value = (0, wrap_1.helper)(value).getPrimaryKey();
|
|
112
112
|
}
|
|
113
|
+
if (Utils_1.Utils.isScalarReference(value)) {
|
|
114
|
+
value = value.unwrap();
|
|
115
|
+
}
|
|
113
116
|
if (object) {
|
|
114
117
|
return ({ [prop]: value });
|
|
115
118
|
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type { EntityData, EntityDictionary, EntityMetadata, EntityProperty, IMetadataStorage } from '../typings';
|
|
2
2
|
import type { Platform } from '../platforms';
|
|
3
|
-
type Comparator<T> = (a: T, b: T
|
|
3
|
+
type Comparator<T> = (a: T, b: T, options?: {
|
|
4
|
+
includeInverseSides?: boolean;
|
|
5
|
+
}) => EntityData<T>;
|
|
4
6
|
type ResultMapper<T> = (result: EntityData<T>) => EntityData<T> | null;
|
|
5
7
|
type SnapshotGenerator<T> = (entity: T) => EntityData<T>;
|
|
6
8
|
type CompositeKeyPart = string | CompositeKeyPart[];
|
|
@@ -18,7 +20,9 @@ export declare class EntityComparator {
|
|
|
18
20
|
/**
|
|
19
21
|
* Computes difference between two entities.
|
|
20
22
|
*/
|
|
21
|
-
diffEntities<T>(entityName: string, a: EntityData<T>, b: EntityData<T
|
|
23
|
+
diffEntities<T>(entityName: string, a: EntityData<T>, b: EntityData<T>, options?: {
|
|
24
|
+
includeInverseSides?: boolean;
|
|
25
|
+
}): EntityData<T>;
|
|
22
26
|
matching<T>(entityName: string, a: EntityData<T>, b: EntityData<T>): boolean;
|
|
23
27
|
/**
|
|
24
28
|
* Removes ORM specific code from entities and prepares it for serializing. Used before change set computation.
|
|
@@ -23,9 +23,9 @@ class EntityComparator {
|
|
|
23
23
|
/**
|
|
24
24
|
* Computes difference between two entities.
|
|
25
25
|
*/
|
|
26
|
-
diffEntities(entityName, a, b) {
|
|
26
|
+
diffEntities(entityName, a, b, options) {
|
|
27
27
|
const comparator = this.getEntityComparator(entityName);
|
|
28
|
-
return Utils_1.Utils.callCompiledFunction(comparator, a, b);
|
|
28
|
+
return Utils_1.Utils.callCompiledFunction(comparator, a, b, options);
|
|
29
29
|
}
|
|
30
30
|
matching(entityName, a, b) {
|
|
31
31
|
const diff = this.diffEntities(entityName, a, b);
|
|
@@ -158,6 +158,7 @@ class EntityComparator {
|
|
|
158
158
|
const lines = [];
|
|
159
159
|
const context = new Map();
|
|
160
160
|
context.set('getCompositeKeyValue', (val) => Utils_1.Utils.flatten(Utils_1.Utils.getCompositeKeyValue(val, meta, 'convertToDatabaseValue', this.platform)));
|
|
161
|
+
context.set('getPrimaryKeyHash', (val) => Utils_1.Utils.getPrimaryKeyHash(Utils_1.Utils.asArray(val)));
|
|
161
162
|
if (meta.primaryKeys.length > 1) {
|
|
162
163
|
lines.push(` const pks = entity.__helper.__pk ? getCompositeKeyValue(entity.__helper.__pk) : [`);
|
|
163
164
|
meta.primaryKeys.forEach(pk => {
|
|
@@ -173,14 +174,23 @@ class EntityComparator {
|
|
|
173
174
|
}
|
|
174
175
|
else {
|
|
175
176
|
const pk = meta.primaryKeys[0];
|
|
176
|
-
|
|
177
|
+
const prop = meta.properties[pk];
|
|
178
|
+
if (prop.kind !== enums_1.ReferenceKind.SCALAR) {
|
|
177
179
|
lines.push(` if (entity${this.wrap(pk)} != null && (entity${this.wrap(pk)}.__entity || entity${this.wrap(pk)}.__reference)) return entity${this.wrap(pk)}.__helper.getSerializedPrimaryKey();`);
|
|
178
180
|
}
|
|
179
181
|
const serializedPrimaryKey = meta.props.find(p => p.serializedPrimaryKey);
|
|
180
182
|
if (serializedPrimaryKey) {
|
|
181
183
|
lines.push(` return '' + entity.${serializedPrimaryKey.name};`);
|
|
182
184
|
}
|
|
183
|
-
|
|
185
|
+
else if (prop.customType) {
|
|
186
|
+
const convertorKey = this.registerCustomType(meta.properties[pk], context);
|
|
187
|
+
const idx = this.tmpIndex++;
|
|
188
|
+
lines.push(` const val_${idx} = convertToDatabaseValue_${convertorKey}(entity${this.wrap(pk)});`);
|
|
189
|
+
lines.push(` return getPrimaryKeyHash(val_${idx});`);
|
|
190
|
+
}
|
|
191
|
+
else {
|
|
192
|
+
lines.push(` return '' + entity${this.wrap(pk)};`);
|
|
193
|
+
}
|
|
184
194
|
}
|
|
185
195
|
const code = `// compiled pk serializer for entity ${meta.className}\n`
|
|
186
196
|
+ `return function(entity) {\n${lines.join('\n')}\n}`;
|
|
@@ -534,11 +544,22 @@ class EntityComparator {
|
|
|
534
544
|
context.set('compareBuffers', Utils_1.compareBuffers);
|
|
535
545
|
context.set('compareObjects', Utils_1.compareObjects);
|
|
536
546
|
context.set('equals', Utils_1.equals);
|
|
537
|
-
meta.comparableProps
|
|
538
|
-
|
|
539
|
-
|
|
547
|
+
for (const prop of meta.comparableProps) {
|
|
548
|
+
// skip properties that are not hydrated
|
|
549
|
+
if (prop.hydrate !== false) {
|
|
550
|
+
lines.push(this.getPropertyComparator(prop, context));
|
|
551
|
+
}
|
|
552
|
+
}
|
|
553
|
+
// also compare 1:1 inverse sides, important for `factory.mergeData`
|
|
554
|
+
lines.push(`if (options?.includeInverseSides) {`);
|
|
555
|
+
for (const prop of meta.bidirectionalRelations) {
|
|
556
|
+
if (prop.kind === enums_1.ReferenceKind.ONE_TO_ONE && !prop.owner && prop.hydrate !== false) {
|
|
557
|
+
lines.push(this.getPropertyComparator(prop, context));
|
|
558
|
+
}
|
|
559
|
+
}
|
|
560
|
+
lines.push(`}`);
|
|
540
561
|
const code = `// compiled comparator for entity ${meta.className}\n`
|
|
541
|
-
+ `return function(last, current) {\n const diff = {};\n${lines.join('\n')}\n return diff;\n}`;
|
|
562
|
+
+ `return function(last, current, options) {\n const diff = {};\n${lines.join('\n')}\n return diff;\n}`;
|
|
542
563
|
const comparator = Utils_1.Utils.createFunction(context, code);
|
|
543
564
|
this.comparators.set(entityName, comparator);
|
|
544
565
|
return comparator;
|
package/utils/QueryHelper.d.ts
CHANGED
|
@@ -1,10 +1,16 @@
|
|
|
1
1
|
import type { Dictionary, EntityMetadata, EntityProperty, FilterDef, FilterQuery } from '../typings';
|
|
2
2
|
import type { Platform } from '../platforms';
|
|
3
3
|
import type { MetadataStorage } from '../metadata/MetadataStorage';
|
|
4
|
+
/** @internal */
|
|
4
5
|
export declare class QueryHelper {
|
|
5
6
|
static readonly SUPPORTED_OPERATORS: string[];
|
|
6
7
|
static processParams(params: unknown): any;
|
|
7
8
|
static processObjectParams<T extends object>(params?: T): T;
|
|
9
|
+
/**
|
|
10
|
+
* converts `{ account: { $or: [ [Object], [Object] ] } }`
|
|
11
|
+
* to `{ $or: [ { account: [Object] }, { account: [Object] } ] }`
|
|
12
|
+
*/
|
|
13
|
+
static liftGroupOperators<T extends object>(where: Dictionary, meta: EntityMetadata<T>, metadata: MetadataStorage, key?: string): string | undefined;
|
|
8
14
|
static inlinePrimaryKeyObjects<T extends object>(where: Dictionary, meta: EntityMetadata<T>, metadata: MetadataStorage, key?: string): boolean;
|
|
9
15
|
static processWhere<T extends object>(options: ProcessWhereOptions<T>): FilterQuery<T>;
|
|
10
16
|
static getActiveFilters(entityName: string, options: Dictionary<boolean | Dictionary> | string[] | boolean, filters: Dictionary<FilterDef>): FilterDef[];
|
package/utils/QueryHelper.js
CHANGED
|
@@ -7,6 +7,7 @@ const enums_1 = require("../enums");
|
|
|
7
7
|
const JsonType_1 = require("../types/JsonType");
|
|
8
8
|
const wrap_1 = require("../entity/wrap");
|
|
9
9
|
const RawQueryFragment_1 = require("./RawQueryFragment");
|
|
10
|
+
/** @internal */
|
|
10
11
|
class QueryHelper {
|
|
11
12
|
static SUPPORTED_OPERATORS = ['>', '<', '<=', '>=', '!', '!='];
|
|
12
13
|
static processParams(params) {
|
|
@@ -36,11 +37,52 @@ class QueryHelper {
|
|
|
36
37
|
});
|
|
37
38
|
return params;
|
|
38
39
|
}
|
|
40
|
+
/**
|
|
41
|
+
* converts `{ account: { $or: [ [Object], [Object] ] } }`
|
|
42
|
+
* to `{ $or: [ { account: [Object] }, { account: [Object] } ] }`
|
|
43
|
+
*/
|
|
44
|
+
static liftGroupOperators(where, meta, metadata, key) {
|
|
45
|
+
if (!Utils_1.Utils.isPlainObject(where)) {
|
|
46
|
+
return undefined;
|
|
47
|
+
}
|
|
48
|
+
const keys = Object.keys(where);
|
|
49
|
+
const groupOperator = keys.find(k => {
|
|
50
|
+
return Utils_1.Utils.isGroupOperator(k) && Array.isArray(where[k]) && where[k].every(cond => {
|
|
51
|
+
return Utils_1.Utils.isPlainObject(cond) && Object.keys(cond).every(k2 => {
|
|
52
|
+
if (Utils_1.Utils.isOperator(k2, false)) {
|
|
53
|
+
if (k2 === '$not') {
|
|
54
|
+
return Object.keys(cond[k2]).every(k3 => meta.primaryKeys.includes(k3));
|
|
55
|
+
}
|
|
56
|
+
return true;
|
|
57
|
+
}
|
|
58
|
+
return meta.primaryKeys.includes(k2);
|
|
59
|
+
});
|
|
60
|
+
});
|
|
61
|
+
});
|
|
62
|
+
if (groupOperator) {
|
|
63
|
+
return groupOperator;
|
|
64
|
+
}
|
|
65
|
+
for (const k of keys) {
|
|
66
|
+
const value = where[k];
|
|
67
|
+
const prop = meta.properties[k];
|
|
68
|
+
if (!prop || ![enums_1.ReferenceKind.MANY_TO_ONE, enums_1.ReferenceKind.ONE_TO_ONE].includes(prop.kind)) {
|
|
69
|
+
continue;
|
|
70
|
+
}
|
|
71
|
+
const op = this.liftGroupOperators(value, prop.targetMeta, metadata, k);
|
|
72
|
+
if (op) {
|
|
73
|
+
delete where[k];
|
|
74
|
+
where[op] = value[op].map((v) => {
|
|
75
|
+
return { [k]: v };
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
return undefined;
|
|
80
|
+
}
|
|
39
81
|
static inlinePrimaryKeyObjects(where, meta, metadata, key) {
|
|
40
82
|
if (Array.isArray(where)) {
|
|
41
83
|
where.forEach((item, i) => {
|
|
42
84
|
if (this.inlinePrimaryKeyObjects(item, meta, metadata, key)) {
|
|
43
|
-
where[i] = Utils_1.Utils.getPrimaryKeyValues(item, meta
|
|
85
|
+
where[i] = Utils_1.Utils.getPrimaryKeyValues(item, meta, false);
|
|
44
86
|
}
|
|
45
87
|
});
|
|
46
88
|
}
|
|
@@ -50,7 +92,7 @@ class QueryHelper {
|
|
|
50
92
|
if (meta.primaryKeys.every(pk => pk in where) && Utils_1.Utils.getObjectKeysSize(where) === meta.primaryKeys.length) {
|
|
51
93
|
return !!key && !enums_1.GroupOperator[key] && key !== '$not' && Object.keys(where).every(k => !Utils_1.Utils.isPlainObject(where[k]) || Object.keys(where[k]).every(v => {
|
|
52
94
|
if (Utils_1.Utils.isOperator(v, false)) {
|
|
53
|
-
return
|
|
95
|
+
return true;
|
|
54
96
|
}
|
|
55
97
|
if (meta.properties[k].primary && [enums_1.ReferenceKind.ONE_TO_ONE, enums_1.ReferenceKind.MANY_TO_ONE].includes(meta.properties[k].kind)) {
|
|
56
98
|
return this.inlinePrimaryKeyObjects(where[k], meta.properties[k].targetMeta, metadata, v);
|
|
@@ -61,7 +103,7 @@ class QueryHelper {
|
|
|
61
103
|
Object.keys(where).forEach(k => {
|
|
62
104
|
const meta2 = metadata.find(meta.properties[k]?.type) || meta;
|
|
63
105
|
if (this.inlinePrimaryKeyObjects(where[k], meta2, metadata, k)) {
|
|
64
|
-
where[k] = Utils_1.Utils.getPrimaryKeyValues(where[k], meta2
|
|
106
|
+
where[k] = Utils_1.Utils.getPrimaryKeyValues(where[k], meta2, true);
|
|
65
107
|
}
|
|
66
108
|
});
|
|
67
109
|
return false;
|
|
@@ -72,6 +114,7 @@ class QueryHelper {
|
|
|
72
114
|
const meta = metadata.find(entityName);
|
|
73
115
|
// inline PK-only objects in M:N queries, so we don't join the target entity when not needed
|
|
74
116
|
if (meta && root) {
|
|
117
|
+
QueryHelper.liftGroupOperators(where, meta, metadata);
|
|
75
118
|
QueryHelper.inlinePrimaryKeyObjects(where, meta, metadata);
|
|
76
119
|
}
|
|
77
120
|
if (options.platform.getConfig().get('ignoreUndefinedInQuery') && where && typeof where === 'object') {
|
|
@@ -121,7 +164,7 @@ class QueryHelper {
|
|
|
121
164
|
value = QueryHelper.processCustomType(prop, value, platform, undefined, true);
|
|
122
165
|
}
|
|
123
166
|
const isJsonProperty = prop?.customType instanceof JsonType_1.JsonType && Utils_1.Utils.isPlainObject(value) && !platform.isRaw(value) && Object.keys(value)[0] !== '$eq';
|
|
124
|
-
if (isJsonProperty) {
|
|
167
|
+
if (isJsonProperty && prop?.kind !== enums_1.ReferenceKind.EMBEDDED) {
|
|
125
168
|
return this.processJsonCondition(o, value, [prop.fieldNames[0]], platform, aliased);
|
|
126
169
|
}
|
|
127
170
|
if (Array.isArray(value) && !Utils_1.Utils.isOperator(key) && !QueryHelper.isSupportedOperator(key) && !key.includes('?') && options.type !== 'orderBy') {
|
|
@@ -70,6 +70,24 @@ export declare const ALIAS_REPLACEMENT_RE = "\\[::alias::\\]";
|
|
|
70
70
|
* ```ts
|
|
71
71
|
* @Filter({ name: 'long', cond: () => ({ [raw('length(perex)')]: { $gt: 10000 } }) })
|
|
72
72
|
* ```
|
|
73
|
+
*
|
|
74
|
+
* The `raw` helper can be used within indexes and uniques to write database-agnostic SQL expressions. In that case, you can use `'??'` to tag your database identifiers (table name, column names, index name, ...) inside your expression, and pass those identifiers as a second parameter to the `raw` helper. Internally, those will automatically be quoted according to the database in use:
|
|
75
|
+
*
|
|
76
|
+
* ```ts
|
|
77
|
+
* // On postgres, will produce: create index "index custom_idx_on_name" on "library.author" ("country")
|
|
78
|
+
* // On mysql, will produce: create index `index custom_idx_on_name` on `library.author` (`country`)
|
|
79
|
+
* @Index({ name: 'custom_idx_on_name', expression: (table, columns) => raw(`create index ?? on ?? (??)`, ['custom_idx_on_name', table, columns.name]) })
|
|
80
|
+
* @Entity({ schema: 'library' })
|
|
81
|
+
* export class Author { ... }
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
84
|
+
* You can also use the `quote` tag function to write database-agnostic SQL expressions. The end-result is the same as using the `raw` function regarding database identifiers quoting, only to have a more elegant expression syntax:
|
|
85
|
+
*
|
|
86
|
+
* ```ts
|
|
87
|
+
* @Index({ name: 'custom_idx_on_name', expression: (table, columns) => quote`create index ${'custom_idx_on_name'} on ${table} (${columns.name})` })
|
|
88
|
+
* @Entity({ schema: 'library' })
|
|
89
|
+
* export class Author { ... }
|
|
90
|
+
* ```
|
|
73
91
|
*/
|
|
74
92
|
export declare function raw<T extends object = any, R = any>(sql: EntityKey<T> | EntityKey<T>[] | AnyString | ((alias: string) => string) | RawQueryFragment, params?: readonly unknown[] | Dictionary<unknown>): R;
|
|
75
93
|
/**
|
|
@@ -94,3 +112,19 @@ export declare namespace sql {
|
|
|
94
112
|
var upper: <T extends object>(key: string | ((alias: string) => string)) => string;
|
|
95
113
|
}
|
|
96
114
|
export declare function createSqlFunction<T extends object, R = string>(func: string, key: string | ((alias: string) => string)): R;
|
|
115
|
+
/**
|
|
116
|
+
* Tag function providing quoting of db identifiers (table name, columns names, index names, ...).
|
|
117
|
+
*
|
|
118
|
+
* Within the template literal on which the tag function is applied, all placeholders are considered to be database identifiers, and will thus be quoted as so according to the database in use.
|
|
119
|
+
*
|
|
120
|
+
* ```ts
|
|
121
|
+
* // On postgres, will produce: create index "index custom_idx_on_name" on "library.author" ("name")
|
|
122
|
+
* // On mysql, will produce: create index `index custom_idx_on_name` on `library.author` (`name`)
|
|
123
|
+
* @Index({ name: 'custom_idx_on_name', expression: (table, columns) => quote`create index ${'custom_idx_on_name'} on ${table} (${columns.name})` })
|
|
124
|
+
* @Entity({ schema: 'library' })
|
|
125
|
+
* export class Author { ... }
|
|
126
|
+
* ```
|
|
127
|
+
*/
|
|
128
|
+
export declare function quote(expParts: readonly string[], ...values: (string | {
|
|
129
|
+
toString(): string;
|
|
130
|
+
})[]): any;
|
|
@@ -4,6 +4,7 @@ exports.ALIAS_REPLACEMENT_RE = exports.ALIAS_REPLACEMENT = exports.RawQueryFragm
|
|
|
4
4
|
exports.raw = raw;
|
|
5
5
|
exports.sql = sql;
|
|
6
6
|
exports.createSqlFunction = createSqlFunction;
|
|
7
|
+
exports.quote = quote;
|
|
7
8
|
const node_async_hooks_1 = require("node:async_hooks");
|
|
8
9
|
const node_util_1 = require("node:util");
|
|
9
10
|
const Utils_1 = require("./Utils");
|
|
@@ -150,6 +151,24 @@ exports.ALIAS_REPLACEMENT_RE = '\\[::alias::\\]';
|
|
|
150
151
|
* ```ts
|
|
151
152
|
* @Filter({ name: 'long', cond: () => ({ [raw('length(perex)')]: { $gt: 10000 } }) })
|
|
152
153
|
* ```
|
|
154
|
+
*
|
|
155
|
+
* The `raw` helper can be used within indexes and uniques to write database-agnostic SQL expressions. In that case, you can use `'??'` to tag your database identifiers (table name, column names, index name, ...) inside your expression, and pass those identifiers as a second parameter to the `raw` helper. Internally, those will automatically be quoted according to the database in use:
|
|
156
|
+
*
|
|
157
|
+
* ```ts
|
|
158
|
+
* // On postgres, will produce: create index "index custom_idx_on_name" on "library.author" ("country")
|
|
159
|
+
* // On mysql, will produce: create index `index custom_idx_on_name` on `library.author` (`country`)
|
|
160
|
+
* @Index({ name: 'custom_idx_on_name', expression: (table, columns) => raw(`create index ?? on ?? (??)`, ['custom_idx_on_name', table, columns.name]) })
|
|
161
|
+
* @Entity({ schema: 'library' })
|
|
162
|
+
* export class Author { ... }
|
|
163
|
+
* ```
|
|
164
|
+
*
|
|
165
|
+
* You can also use the `quote` tag function to write database-agnostic SQL expressions. The end-result is the same as using the `raw` function regarding database identifiers quoting, only to have a more elegant expression syntax:
|
|
166
|
+
*
|
|
167
|
+
* ```ts
|
|
168
|
+
* @Index({ name: 'custom_idx_on_name', expression: (table, columns) => quote`create index ${'custom_idx_on_name'} on ${table} (${columns.name})` })
|
|
169
|
+
* @Entity({ schema: 'library' })
|
|
170
|
+
* export class Author { ... }
|
|
171
|
+
* ```
|
|
153
172
|
*/
|
|
154
173
|
function raw(sql, params) {
|
|
155
174
|
if (sql instanceof RawQueryFragment) {
|
|
@@ -207,3 +226,19 @@ sql.ref = (...keys) => raw('??', [keys.join('.')]);
|
|
|
207
226
|
sql.now = (length) => raw('current_timestamp' + (length == null ? '' : `(${length})`));
|
|
208
227
|
sql.lower = (key) => createSqlFunction('lower', key);
|
|
209
228
|
sql.upper = (key) => createSqlFunction('upper', key);
|
|
229
|
+
/**
|
|
230
|
+
* Tag function providing quoting of db identifiers (table name, columns names, index names, ...).
|
|
231
|
+
*
|
|
232
|
+
* Within the template literal on which the tag function is applied, all placeholders are considered to be database identifiers, and will thus be quoted as so according to the database in use.
|
|
233
|
+
*
|
|
234
|
+
* ```ts
|
|
235
|
+
* // On postgres, will produce: create index "index custom_idx_on_name" on "library.author" ("name")
|
|
236
|
+
* // On mysql, will produce: create index `index custom_idx_on_name` on `library.author` (`name`)
|
|
237
|
+
* @Index({ name: 'custom_idx_on_name', expression: (table, columns) => quote`create index ${'custom_idx_on_name'} on ${table} (${columns.name})` })
|
|
238
|
+
* @Entity({ schema: 'library' })
|
|
239
|
+
* export class Author { ... }
|
|
240
|
+
* ```
|
|
241
|
+
*/
|
|
242
|
+
function quote(expParts, ...values) {
|
|
243
|
+
return raw(expParts.join('??'), values);
|
|
244
|
+
}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import type { EntityManager } from '../EntityManager';
|
|
2
|
+
import { type TransactionOptions } from '../enums';
|
|
3
|
+
/**
|
|
4
|
+
* Manages transaction lifecycle and propagation for EntityManager.
|
|
5
|
+
*/
|
|
6
|
+
export declare class TransactionManager {
|
|
7
|
+
private readonly em;
|
|
8
|
+
constructor(em: EntityManager);
|
|
9
|
+
/**
|
|
10
|
+
* Main entry point for handling transactional operations with propagation support.
|
|
11
|
+
*/
|
|
12
|
+
handle<T>(cb: (em: EntityManager) => T | Promise<T>, options?: TransactionOptions): Promise<T>;
|
|
13
|
+
/**
|
|
14
|
+
* Executes the callback with the specified propagation type.
|
|
15
|
+
*/
|
|
16
|
+
private executeWithPropagation;
|
|
17
|
+
/**
|
|
18
|
+
* Suspends the current transaction and returns the suspended resources.
|
|
19
|
+
*/
|
|
20
|
+
private suspendTransaction;
|
|
21
|
+
/**
|
|
22
|
+
* Resumes a previously suspended transaction.
|
|
23
|
+
*/
|
|
24
|
+
private resumeTransaction;
|
|
25
|
+
/**
|
|
26
|
+
* Executes operation without transaction context.
|
|
27
|
+
*/
|
|
28
|
+
private executeWithoutTransaction;
|
|
29
|
+
/**
|
|
30
|
+
* Creates new independent transaction, suspending any existing one.
|
|
31
|
+
*/
|
|
32
|
+
private executeWithNewTransaction;
|
|
33
|
+
/**
|
|
34
|
+
* Creates new transaction context.
|
|
35
|
+
*/
|
|
36
|
+
private createNewTransaction;
|
|
37
|
+
/**
|
|
38
|
+
* Executes nested transaction with savepoint.
|
|
39
|
+
*/
|
|
40
|
+
private executeNestedTransaction;
|
|
41
|
+
/**
|
|
42
|
+
* Creates a fork of the EntityManager with the given options.
|
|
43
|
+
*/
|
|
44
|
+
private createFork;
|
|
45
|
+
/**
|
|
46
|
+
* Determines if changes should be propagated to the upper context.
|
|
47
|
+
*/
|
|
48
|
+
private shouldPropagateToUpperContext;
|
|
49
|
+
/**
|
|
50
|
+
* Merges entities from fork to parent EntityManager.
|
|
51
|
+
*/
|
|
52
|
+
private mergeEntitiesToParent;
|
|
53
|
+
/**
|
|
54
|
+
* Registers a deletion handler to unset entity identities after flush.
|
|
55
|
+
*/
|
|
56
|
+
private registerDeletionHandler;
|
|
57
|
+
/**
|
|
58
|
+
* Processes transaction execution.
|
|
59
|
+
*/
|
|
60
|
+
private processTransaction;
|
|
61
|
+
/**
|
|
62
|
+
* Executes transaction workflow with entity synchronization.
|
|
63
|
+
*/
|
|
64
|
+
private executeTransactionFlow;
|
|
65
|
+
}
|