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