Class: EntityLoader#
core.EntityLoader
Constructors#
constructor#
+ new EntityLoader(em: EntityManager<IDatabaseDriver<Connection>>): EntityLoader
Parameters:#
| Name | Type |
|---|---|
em | EntityManager<IDatabaseDriver<Connection>> |
Returns: EntityLoader
Defined in: packages/core/src/entity/EntityLoader.ts:25
Properties#
driver#
• Private Readonly driver: IDatabaseDriver<Connection>
Defined in: packages/core/src/entity/EntityLoader.ts:25
metadata#
• Private Readonly metadata: MetadataStorage
Defined in: packages/core/src/entity/EntityLoader.ts:24
Methods#
buildFields#
â–¸ PrivatebuildFields<T>(prop: EntityProperty<T>, options: Required<Options<T>>): string[]
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
prop | EntityProperty<T> |
options | Required<Options<T>> |
Returns: string[]
Defined in: packages/core/src/entity/EntityLoader.ts:306
expandNestedPopulate#
â–¸ PrivateexpandNestedPopulate<T>(entityName: string, parts: string[], strategy?: LoadStrategy): PopulateOptions<T>
Expands books.perex like populate to use children array instead of the dot syntax
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
parts | string[] |
strategy? | LoadStrategy |
Returns: PopulateOptions<T>
Defined in: packages/core/src/entity/EntityLoader.ts:117
filterCollections#
â–¸ PrivatefilterCollections<T>(entities: T[], field: keyof T, refresh: boolean): T[]
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entities | T[] |
field | keyof T |
refresh | boolean |
Returns: T[]
Defined in: packages/core/src/entity/EntityLoader.ts:344
filterReferences#
â–¸ PrivatefilterReferences<T>(entities: T[], field: keyof T, refresh: boolean): T[keyof T][]
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entities | T[] |
field | keyof T |
refresh | boolean |
Returns: T[keyof T][]
Defined in: packages/core/src/entity/EntityLoader.ts:352
findChildren#
â–¸ PrivatefindChildren<T>(entities: T[], prop: EntityProperty<any>, populate: PopulateOptions<T>, options: Required<Options<T>>): Promise<AnyEntity<any>[]>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entities | T[] |
prop | EntityProperty<any> |
populate | PopulateOptions<T> |
options | Required<Options<T>> |
Returns: Promise<AnyEntity<any>[]>
Defined in: packages/core/src/entity/EntityLoader.ts:211
findChildrenFromPivotTable#
â–¸ PrivatefindChildrenFromPivotTable<T>(filtered: T[], prop: EntityProperty<T>, options: Required<Options<T>>, orderBy?: QueryOrderMap, populate?: PopulateOptions<T>): Promise<AnyEntity<any>[]>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
filtered | T[] |
prop | EntityProperty<T> |
options | Required<Options<T>> |
orderBy? | QueryOrderMap |
populate? | PopulateOptions<T> |
Returns: Promise<AnyEntity<any>[]>
Defined in: packages/core/src/entity/EntityLoader.ts:276
getChildReferences#
â–¸ PrivategetChildReferences<T>(entities: T[], prop: EntityProperty<T>, refresh: boolean): AnyEntity<any>[]
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entities | T[] |
prop | EntityProperty<T> |
refresh | boolean |
Returns: AnyEntity<any>[]
Defined in: packages/core/src/entity/EntityLoader.ts:327
initializeCollections#
â–¸ PrivateinitializeCollections<T>(filtered: T[], prop: EntityProperty<any>, field: keyof T, children: AnyEntity<any>[]): void
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
filtered | T[] |
prop | EntityProperty<any> |
field | keyof T |
children | AnyEntity<any>[] |
Returns: void
Defined in: packages/core/src/entity/EntityLoader.ts:180
initializeManyToMany#
â–¸ PrivateinitializeManyToMany<T>(filtered: T[], children: AnyEntity<any>[], prop: EntityProperty<any>, field: keyof T): void
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
filtered | T[] |
children | AnyEntity<any>[] |
prop | EntityProperty<any> |
field | keyof T |
Returns: void
Defined in: packages/core/src/entity/EntityLoader.ts:204
initializeOneToMany#
â–¸ PrivateinitializeOneToMany<T>(filtered: T[], children: AnyEntity<any>[], prop: EntityProperty<any>, field: keyof T): void
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
filtered | T[] |
children | AnyEntity<any>[] |
prop | EntityProperty<any> |
field | keyof T |
Returns: void
Defined in: packages/core/src/entity/EntityLoader.ts:190
lookupAllRelationships#
â–¸ PrivatelookupAllRelationships<T>(entityName: string, prefix?: string, visited?: string[]): PopulateOptions<T>[]
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type | Default value |
|---|---|---|
entityName | string | - |
prefix | string | '' |
visited | string[] | - |
Returns: PopulateOptions<T>[]
Defined in: packages/core/src/entity/EntityLoader.ts:362
lookupEagerLoadedRelationships#
â–¸ PrivatelookupEagerLoadedRelationships<T>(entityName: string, populate: PopulateOptions<T>[], prefix?: string, visited?: string[]): PopulateOptions<T>[]
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type | Default value |
|---|---|---|
entityName | string | - |
populate | PopulateOptions<T>[] | - |
prefix | string | '' |
visited | string[] | - |
Returns: PopulateOptions<T>[]
Defined in: packages/core/src/entity/EntityLoader.ts:388
mergeNestedPopulate#
â–¸ PrivatemergeNestedPopulate<T>(populate: PopulateOptions<T>[]): PopulateOptions<T>[]
merge multiple populates for the same entity with different children
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
populate | PopulateOptions<T>[] |
Returns: PopulateOptions<T>[]
Defined in: packages/core/src/entity/EntityLoader.ts:89
normalizePopulate#
â–¸ normalizePopulate<T>(entityName: string, populate: true | PopulateOptions<T>[], lookup?: boolean): PopulateOptions<T>[]
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type | Default value |
|---|---|---|
entityName | string | - |
populate | true | PopulateOptions<T>[] | - |
lookup | boolean | true |
Returns: PopulateOptions<T>[]
Defined in: packages/core/src/entity/EntityLoader.ts:58
populate#
â–¸ populate<T>(entityName: string, entities: T[], populate: boolean | PopulateOptions<T>[], options: Options<T>): Promise<void>
Loads specified relations in batch. This will execute one query for each relation, that will populate it on all of the specified entities.
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
entities | T[] |
populate | boolean | PopulateOptions<T>[] |
options | Options<T> |
Returns: Promise<void>
Defined in: packages/core/src/entity/EntityLoader.ts:32
populateField#
â–¸ PrivatepopulateField<T>(entityName: string, entities: T[], populate: PopulateOptions<T>, options: Required<Options<T>>): Promise<void>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
entities | T[] |
populate | PopulateOptions<T> |
options | Required<Options<T>> |
Returns: Promise<void>
Defined in: packages/core/src/entity/EntityLoader.ts:244
populateMany#
â–¸ PrivatepopulateMany<T>(entityName: string, entities: T[], populate: PopulateOptions<T>, options: Required<Options<T>>): Promise<AnyEntity<any>[]>
preload everything in one call (this will update already existing references in IM)
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
entities | T[] |
populate | PopulateOptions<T> |
options | Required<Options<T>> |
Returns: Promise<AnyEntity<any>[]>
Defined in: packages/core/src/entity/EntityLoader.ts:133