IDatabaseDriver <C>

Implemented by

• DatabaseDriver

Index

Properties

• [EntityManagerType]
• config

Methods

• aggregate
• close
• connect
• convertException
• count
• createEntityManager
• find
• findOne
• findVirtual
• getConnection
• getDependencies
• getMetadata
• getPlatform
• loadFromPivotTable
• lockPessimistic
• mapResult
• nativeDelete
• nativeInsert
• nativeInsertMany
• nativeUpdate
• nativeUpdateMany
• reconnect
• setMetadata
• syncCollections

Properties

[EntityManagerType]

[EntityManagerType]: EntityManager<IDatabaseDriver<C>>

readonlyconfig

config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

Methods

aggregate

• aggregate(entityName: string, pipeline: any[]): Promise<any[]>

• Parameters

  • entityName: string

  • pipeline: any[]

  Returns Promise<any[]>

close

• close(force?: boolean): Promise<void>

• Parameters

  • optionalforce: boolean

  Returns Promise<void>

connect

• connect(): Promise<C>

• Returns Promise<C>

convertException

• convertException(exception: Error): DriverException

• Converts native db errors to standardized driver exceptions

  ---

  Parameters

  • exception: Error

  Returns DriverException

count

• count(entityName: string, where: FilterQuery<T>, options?: CountOptions<T, P>): Promise<number>

• Parameters

  • entityName: string

  • where: FilterQuery<T>

  • optionaloptions: CountOptions<T, P>

  Returns Promise<number>

createEntityManager

• createEntityManager(useContext?: boolean): D[typeof EntityManagerType]

• Parameters

  • optionaluseContext: boolean

  Returns D[typeof EntityManagerType]

find

• find(entityName: string, where: FilterQuery<T>, options?: FindOptions<T, P, F, E>): Promise<EntityData<T>[]>

• Finds selection of entities

  ---

  Parameters

  • entityName: string

  • where: FilterQuery<T>

  • optionaloptions: FindOptions<T, P, F, E>

  Returns Promise<EntityData<T>[]>

findOne

• findOne(entityName: string, where: FilterQuery<T>, options?: FindOneOptions<T, P, F, E>): Promise<null | EntityData<T>>

• Finds single entity (table row, document)

  ---

  Parameters

  • entityName: string

  • where: FilterQuery<T>

  • optionaloptions: FindOneOptions<T, P, F, E>

  Returns Promise<null | EntityData<T>>

findVirtual

• findVirtual(entityName: string, where: FilterQuery<T>, options: FindOptions<T, any, any, any>): Promise<EntityData<T>[]>

• Parameters

  • entityName: string

  • where: FilterQuery<T>

  • options: FindOptions<T, any, any, any>

  Returns Promise<EntityData<T>[]>

getConnection

• getConnection(type?: ConnectionType): C

• Parameters

  • optionaltype: ConnectionType

  Returns C

getDependencies

• getDependencies(): string[]

• Returns name of the underlying database dependencies (e.g. mongodb or mysql2) for SQL drivers it also returns knex in the array as connectors are not used directly there

  ---

  Returns string[]

getMetadata

• getMetadata(): MetadataStorage

• Returns MetadataStorage

getPlatform

• getPlatform(): Platform

• Returns Platform

loadFromPivotTable

• loadFromPivotTable(prop: EntityProperty<any, any>, owners: (O extends { [PrimaryKeyProp]?: PK } ? PK extends keyof O<O> ? ReadonlyPrimary<UnwrapPrimary<O<O>[PK<PK>]>> : PK extends keyof O<O>[] ? ReadonlyPrimary<PrimaryPropToType<O<O>, PK<PK>>> : PK : O extends { _id?: PK } ? string | ReadonlyPrimary<PK> : O extends { uuid?: PK } ? ReadonlyPrimary<PK> : O extends { id?: PK } ? ReadonlyPrimary<PK> : O)[][], where?: FilterQuery<T>, orderBy?: OrderDefinition<T>, ctx?: any, options?: FindOptions<T, any, any, any>, pivotJoin?: boolean): Promise<Dictionary<T[]>>

• When driver uses pivot tables for M:N, this method will load identifiers for given collections from them

  ---

  Parameters

  • prop: EntityProperty<any, any>

  • owners: (O extends { [PrimaryKeyProp]?: PK } ? PK extends keyof O<O> ? ReadonlyPrimary<UnwrapPrimary<O<O>[PK<PK>]>> : PK extends keyof O<O>[] ? ReadonlyPrimary<PrimaryPropToType<O<O>, PK<PK>>> : PK : O extends { _id?: PK } ? string | ReadonlyPrimary<PK> : O extends { uuid?: PK } ? ReadonlyPrimary<PK> : O extends { id?: PK } ? ReadonlyPrimary<PK> : O)[][]

  • optionalwhere: FilterQuery<T>

  • optionalorderBy: OrderDefinition<T>

  • optionalctx: any

  • optionaloptions: FindOptions<T, any, any, any>

  • optionalpivotJoin: boolean

  Returns Promise<Dictionary<T[]>>

lockPessimistic

• lockPessimistic(entity: T, options: LockOptions): Promise<void>

• Parameters

  • entity: T

  • options: LockOptions

  Returns Promise<void>

mapResult

• mapResult(result: EntityDictionary<T>, meta: EntityMetadata<T>, populate?: PopulateOptions<T>[]): null | EntityData<T>

• Parameters

  • result: EntityDictionary<T>

  • meta: EntityMetadata<T>

  • optionalpopulate: PopulateOptions<T>[]

  Returns null | EntityData<T>

nativeDelete

• nativeDelete(entityName: string, where: FilterQuery<T>, options?: NativeDeleteOptions<T>): Promise<QueryResult<T>>

• Parameters

  • entityName: string

  • where: FilterQuery<T>

  • optionaloptions: NativeDeleteOptions<T>

  Returns Promise<QueryResult<T>>

nativeInsert

• nativeInsert(entityName: string, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>

• Parameters

  • entityName: string

  • data: EntityDictionary<T>

  • optionaloptions: NativeInsertUpdateOptions<T>

  Returns Promise<QueryResult<T>>

nativeInsertMany

• nativeInsertMany(entityName: string, data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>, transform?: (sql: string) => string): Promise<QueryResult<T>>

• Parameters

  • entityName: string

  • data: EntityDictionary<T>[]

  • optionaloptions: NativeInsertUpdateManyOptions<T>

  • optionaltransform: (sql: string) => string

  Returns Promise<QueryResult<T>>

nativeUpdate

• nativeUpdate(entityName: string, where: FilterQuery<T>, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>

• Parameters

  • entityName: string

  • where: FilterQuery<T>

  • data: EntityDictionary<T>

  • optionaloptions: NativeInsertUpdateOptions<T>

  Returns Promise<QueryResult<T>>

nativeUpdateMany

• nativeUpdateMany(entityName: string, where: FilterQuery<T>[], data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>): Promise<QueryResult<T>>

• Parameters

  • entityName: string

  • where: FilterQuery<T>[]

  • data: EntityDictionary<T>[]

  • optionaloptions: NativeInsertUpdateManyOptions<T>

  Returns Promise<QueryResult<T>>

reconnect

• reconnect(): Promise<C>

• Returns Promise<C>

setMetadata

• setMetadata(metadata: MetadataStorage): void

• Parameters

  • metadata: MetadataStorage

  Returns void

syncCollections

• syncCollections(collections: Iterable<Collection<T, O>, any, any>, options?: DriverMethodOptions): Promise<void>

• Parameters

  • collections: Iterable<Collection<T, O>, any, any>

  • optionaloptions: DriverMethodOptions

  Returns Promise<void>