Class: DatabaseDriver<C>#
core.DatabaseDriver
Type parameters#
| Name | Type |
|---|---|
C | Connection |
Hierarchy#
DatabaseDriver
Implements#
Constructors#
constructor#
+ Protectednew DatabaseDriver<C>(config: Configuration<IDatabaseDriver<Connection>>, dependencies: string[]): DatabaseDriver<C>
Type parameters:#
| Name | Type |
|---|---|
C | Connection<C> |
Parameters:#
| Name | Type |
|---|---|
config | Configuration<IDatabaseDriver<Connection>> |
dependencies | string[] |
Returns: DatabaseDriver<C>
Defined in: packages/core/src/drivers/DatabaseDriver.ts:22
Properties#
__@EntityManagerType@43871#
• __@EntityManagerType@43871: EntityManager<DatabaseDriver<C>>
Implementation of: IDatabaseDriver.__@EntityManagerType@43871
Defined in: packages/core/src/drivers/DatabaseDriver.ts:15
comparator#
• Protected comparator: EntityComparator
Defined in: packages/core/src/drivers/DatabaseDriver.ts:21
config#
• Protected Readonly config: Configuration<IDatabaseDriver<Connection>>
connection#
• Protected Readonly connection: C
Defined in: packages/core/src/drivers/DatabaseDriver.ts:17
dependencies#
• Protected Readonly dependencies: string[]
logger#
• Protected Readonly logger: Logger
Defined in: packages/core/src/drivers/DatabaseDriver.ts:20
metadata#
• Protected metadata: MetadataStorage
Defined in: packages/core/src/drivers/DatabaseDriver.ts:22
platform#
• Protected Readonly platform: Platform
Defined in: packages/core/src/drivers/DatabaseDriver.ts:19
replicas#
• Protected Readonly replicas: C[]
Defined in: packages/core/src/drivers/DatabaseDriver.ts:18
Methods#
aggregate#
â–¸ aggregate(entityName: string, pipeline: any[]): Promise<any[]>
Parameters:#
| Name | Type |
|---|---|
entityName | string |
pipeline | any[] |
Returns: Promise<any[]>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:49
close#
â–¸ close(force?: boolean): Promise<void>
Parameters:#
| Name | Type |
|---|---|
force? | boolean |
Returns: Promise<void>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:93
connect#
â–¸ connect(): Promise<C>
Returns: Promise<C>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:71
convertException#
â–¸ convertException(exception: Error): DriverException
Converts native db errors to standardized driver exceptions
Parameters:#
| Name | Type |
|---|---|
exception | Error |
Returns: DriverException
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:244
count#
â–¸ Abstractcount<T>(entityName: string, where: FilterQuery<T>, options?: CountOptions<T>, ctx?: any): Promise<number>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
where | FilterQuery<T> |
options? | CountOptions<T> |
ctx? | any |
Returns: Promise<number>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:43
createEntityManager#
â–¸ createEntityManager<D>(useContext?: boolean): D[typeof EntityManagerType]
Type parameters:#
| Name | Type | Default |
|---|---|---|
D | IDatabaseDriver<Connection, D> | IDatabaseDriver<Connection\> |
Parameters:#
| Name | Type |
|---|---|
useContext? | boolean |
Returns: D[typeof EntityManagerType]
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:45
createReplicas#
â–¸ ProtectedcreateReplicas(cb: (c: ConnectionOptions) => C): C[]
Parameters:#
| Name | Type |
|---|---|
cb | (c: ConnectionOptions) => C |
Returns: C[]
Defined in: packages/core/src/drivers/DatabaseDriver.ts:205
ensureIndexes#
â–¸ ensureIndexes(): Promise<void>
Returns: Promise<void>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:117
find#
â–¸ Abstractfind<T>(entityName: string, where: FilterQuery<T>, options?: FindOptions<T, Populate<T>>, ctx?: any): Promise<EntityData<T>[]>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
where | FilterQuery<T> |
options? | FindOptions<T, Populate<T>> |
ctx? | any |
Returns: Promise<EntityData<T>[]>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:27
findOne#
â–¸ AbstractfindOne<T>(entityName: string, where: FilterQuery<T>, options?: FindOneOptions<T, Populate<T>>, ctx?: any): Promise<null | EntityData<T>>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
where | FilterQuery<T> |
options? | FindOneOptions<T, Populate<T>> |
ctx? | any |
Returns: Promise<null | EntityData<T>>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:29
getConnection#
â–¸ getConnection(type?: read | write): C
Parameters:#
| Name | Type | Default value |
|---|---|---|
type | read | write | 'write' |
Returns: C
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:83
getDependencies#
â–¸ getDependencies(): string[]
Returns: string[]
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:113
getPivotInverseProperty#
â–¸ ProtectedgetPivotInverseProperty(prop: EntityProperty<any>): EntityProperty<any>
Parameters:#
| Name | Type |
|---|---|
prop | EntityProperty<any> |
Returns: EntityProperty<any>
Defined in: packages/core/src/drivers/DatabaseDriver.ts:190
getPivotOrderBy#
â–¸ ProtectedgetPivotOrderBy(prop: EntityProperty<any>, orderBy?: QueryOrderMap): QueryOrderMap
Parameters:#
| Name | Type |
|---|---|
prop | EntityProperty<any> |
orderBy? | QueryOrderMap |
Returns: QueryOrderMap
Defined in: packages/core/src/drivers/DatabaseDriver.ts:169
getPlatform#
â–¸ getPlatform(): Platform
Returns: Platform
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:98
getPrimaryKeyFields#
â–¸ ProtectedgetPrimaryKeyFields(entityName: string): string[]
Parameters:#
| Name | Type |
|---|---|
entityName | string |
Returns: string[]
Defined in: packages/core/src/drivers/DatabaseDriver.ts:185
inlineEmbeddables#
â–¸ ProtectedinlineEmbeddables<T>(meta: EntityMetadata<T>, data: T, where?: boolean): void
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
meta | EntityMetadata<T> |
data | T |
where? | boolean |
Returns: void
Defined in: packages/core/src/drivers/DatabaseDriver.ts:121
loadFromPivotTable#
â–¸ loadFromPivotTable<T, O>(prop: EntityProperty<any>, owners: Primary<O>[][], where?: { __@PrimaryKeyType@41543?: any } | NonNullable<Query<T>>, orderBy?: QueryOrderMap, ctx?: any, options?: FindOptions<T, Populate<T>>): Promise<Dictionary<T[]>>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
O | AnyEntity<O> |
Parameters:#
| Name | Type |
|---|---|
prop | EntityProperty<any> |
owners | Primary<O>[][] |
where? | { __@PrimaryKeyType@41543?: any } | NonNullable<Query<T>> |
orderBy? | QueryOrderMap |
ctx? | any |
options? | FindOptions<T, Populate<T>> |
Returns: Promise<Dictionary<T[]>>
Defined in: packages/core/src/drivers/DatabaseDriver.ts:53
lockPessimistic#
â–¸ lockPessimistic<T>(entity: T, mode: LockMode, ctx?: any): Promise<void>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entity | T |
mode | LockMode |
ctx? | any |
Returns: Promise<void>
Defined in: packages/core/src/drivers/DatabaseDriver.ts:218
mapResult#
â–¸ mapResult<T>(result: EntityData<T>, meta: EntityMetadata<T>, populate?: PopulateOptions<T>[]): null | EntityData<T>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type | Default value |
|---|---|---|
result | EntityData<T> | - |
meta | EntityMetadata<T> | - |
populate | PopulateOptions<T>[] | ... |
Returns: null | EntityData<T>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:63
nativeDelete#
â–¸ AbstractnativeDelete<T>(entityName: string, where: FilterQuery<T>, ctx?: any): Promise<QueryResult>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
where | FilterQuery<T> |
ctx? | any |
Returns: Promise<QueryResult>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:41
nativeInsert#
â–¸ AbstractnativeInsert<T>(entityName: string, data: EntityData<T>, ctx?: any, convertCustomTypes?: boolean): Promise<QueryResult>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
data | EntityData<T> |
ctx? | any |
convertCustomTypes? | boolean |
Returns: Promise<QueryResult>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:31
nativeInsertMany#
â–¸ AbstractnativeInsertMany<T>(entityName: string, data: EntityData<T>[], ctx?: any, processCollections?: boolean, convertCustomTypes?: boolean): Promise<QueryResult>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
data | EntityData<T>[] |
ctx? | any |
processCollections? | boolean |
convertCustomTypes? | boolean |
Returns: Promise<QueryResult>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:33
nativeUpdate#
â–¸ AbstractnativeUpdate<T>(entityName: string, where: FilterQuery<T>, data: EntityData<T>, ctx?: any, convertCustomTypes?: boolean): Promise<QueryResult>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
where | FilterQuery<T> |
data | EntityData<T> |
ctx? | any |
convertCustomTypes? | boolean |
Returns: Promise<QueryResult>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:35
nativeUpdateMany#
â–¸ nativeUpdateMany<T>(entityName: string, where: FilterQuery<T>[], data: EntityData<T>[], ctx?: any, processCollections?: boolean, convertCustomTypes?: boolean): Promise<QueryResult>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type |
|---|---|
entityName | string |
where | FilterQuery<T>[] |
data | EntityData<T>[] |
ctx? | any |
processCollections? | boolean |
convertCustomTypes? | boolean |
Returns: Promise<QueryResult>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:37
reconnect#
â–¸ reconnect(): Promise<C>
Returns: Promise<C>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:78
rethrow#
â–¸ Protectedrethrow<T>(promise: Promise<T>): Promise<T>
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
promise | Promise<T> |
Returns: Promise<T>
Defined in: packages/core/src/drivers/DatabaseDriver.ts:252
setMetadata#
â–¸ setMetadata(metadata: MetadataStorage): void
Parameters:#
| Name | Type |
|---|---|
metadata | MetadataStorage |
Returns: void
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:102
shouldHaveColumn#
â–¸ shouldHaveColumn<T>(prop: EntityProperty<T>, populate: PopulateOptions<T>[], includeFormulas?: boolean): boolean
internal
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
Parameters:#
| Name | Type | Default value |
|---|---|---|
prop | EntityProperty<T> | - |
populate | PopulateOptions<T>[] | - |
includeFormulas | boolean | true |
Returns: boolean
Defined in: packages/core/src/drivers/DatabaseDriver.ts:225
syncCollection#
â–¸ syncCollection<T, O>(coll: Collection<T, O>, ctx?: any): Promise<void>
Type parameters:#
| Name | Type |
|---|---|
T | AnyEntity<T> |
O | AnyEntity<O> |
Parameters:#
| Name | Type |
|---|---|
coll | Collection<T, O> |
ctx? | any |
Returns: Promise<void>
Implementation of: IDatabaseDriver
Defined in: packages/core/src/drivers/DatabaseDriver.ts:57