Class: MikroORM<D>#
core.MikroORM
Helper class for bootstrapping the MikroORM.
Type parameters#
| Name | Type | Default |
|---|---|---|
D | IDatabaseDriver | IDatabaseDriver |
Hierarchy#
- MikroORM
Constructors#
constructor#
+ new MikroORM<D>(options: Options<D> | Configuration<D>): MikroORM<D>
Type parameters:#
| Name | Type | Default |
|---|---|---|
D | IDatabaseDriver<Connection, D> | IDatabaseDriver<Connection\> |
Parameters:#
| Name | Type |
|---|---|
options | Options<D> | Configuration<D> |
Returns: MikroORM<D>
Defined in: packages/core/src/MikroORM.ts:47
Properties#
config#
• Readonly config: Configuration<D>
Defined in: packages/core/src/MikroORM.ts:16
driver#
• Private Readonly driver: D
Defined in: packages/core/src/MikroORM.ts:18
em#
• em: D[typeof EntityManagerType] & EntityManager<IDatabaseDriver<Connection>>
Defined in: packages/core/src/MikroORM.ts:15
logger#
• Private Readonly logger: Logger
Defined in: packages/core/src/MikroORM.ts:19
metadata#
• Private metadata: MetadataStorage
Defined in: packages/core/src/MikroORM.ts:17
Methods#
close#
â–¸ close(force?: boolean): Promise<void>
Closes the database connection.
Parameters:#
| Name | Type | Default value |
|---|---|---|
force | boolean | false |
Returns: Promise<void>
Defined in: packages/core/src/MikroORM.ts:94
connect#
â–¸ connect(): Promise<D>
Connects to the database.
Returns: Promise<D>
Defined in: packages/core/src/MikroORM.ts:69
getEntityGenerator#
â–¸ getEntityGenerator<T>(): T
Gets the EntityGenerator.
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | IEntityGenerator | IEntityGenerator |
Returns: T
Defined in: packages/core/src/MikroORM.ts:115
getMetadata#
â–¸ getMetadata(): MetadataStorage
Gets the MetadataStorage.
Returns: MetadataStorage
Defined in: packages/core/src/MikroORM.ts:101
getMigrator#
â–¸ getMigrator<T>(): T
Gets the Migrator.
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | IMigrator | IMigrator |
Returns: T
Defined in: packages/core/src/MikroORM.ts:124
getSchemaGenerator#
â–¸ getSchemaGenerator<T>(): T
Gets the SchemaGenerator.
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | ISchemaGenerator | ISchemaGenerator |
Returns: T
Defined in: packages/core/src/MikroORM.ts:108
isConnected#
â–¸ isConnected(): Promise<boolean>
Checks whether the database connection is active.
Returns: Promise<boolean>
Defined in: packages/core/src/MikroORM.ts:87
init#
â–¸ Staticinit<D>(options?: Options<D> | Configuration<D>, connect?: boolean): Promise<MikroORM<D>>
Initialize the ORM, load entity metadata, create EntityManager and connect to the database.
If you omit the options parameter, your CLI config will be used.
Type parameters:#
| Name | Type | Default |
|---|---|---|
D | IDatabaseDriver<Connection, D> | IDatabaseDriver<Connection\> |
Parameters:#
| Name | Type | Default value |
|---|---|---|
options? | Options<D> | Configuration<D> | - |
connect | boolean | true |
Returns: Promise<MikroORM<D>>
Defined in: packages/core/src/MikroORM.ts:25