abstractDatabaseDriver <C>

Hierarchy

• DatabaseDriver
  • AbstractSqlDriver
  • MongoDriver

Implements

• IDatabaseDriver<C>

Index

Properties

• [EntityManagerType]
• config

Methods

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

Properties

[EntityManagerType]

[EntityManagerType]: EntityManager<DatabaseDriver<C>>

Implementation of IDatabaseDriver.[EntityManagerType]

readonlyconfig

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

Implementation of IDatabaseDriver.config

Methods

aggregate

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

• Implementation of IDatabaseDriver.aggregate

  Parameters

  • entityName: string

  • pipeline: any[]

  Returns Promise<any[]>

close

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

• Implementation of IDatabaseDriver.close

  Parameters

  • optionalforce: boolean

  Returns Promise<void>

connect

• connect(): Promise<C>

• Implementation of IDatabaseDriver.connect

  Returns Promise<C>

convertException

• convertException(exception: Error): DriverException

• Implementation of IDatabaseDriver.convertException

  Converts native db errors to standardized driver exceptions

  ---

  Parameters

  • exception: Error

  Returns DriverException

abstractcount

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

• Implementation of IDatabaseDriver.count

  Parameters

  • entityName: string

  • where: FilterQuery<T>

  • optionaloptions: CountOptions<T, P>

  Returns Promise<number>

countVirtual

• countVirtual(entityName: string, where: FilterQuery<T>, options: CountOptions<T, any>): Promise<number>

• Parameters

  • entityName: string

  • where: FilterQuery<T>

  • options: CountOptions<T, any>

  Returns Promise<number>

createEntityManager

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

• Implementation of IDatabaseDriver.createEntityManager

  Parameters

  • optionaluseContext: boolean

  Returns D[typeof EntityManagerType]

abstractfind

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

• Implementation of IDatabaseDriver.find

  Finds selection of entities

  ---

  Parameters

  • entityName: string

  • where: FilterQuery<T>

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

  Returns Promise<EntityData<T>[]>

abstractfindOne

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

• Implementation of IDatabaseDriver.findOne

  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>[]>

• Implementation of IDatabaseDriver.findVirtual

  Parameters

  • entityName: string

  • where: FilterQuery<T>

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

  Returns Promise<EntityData<T>[]>

getConnection

• getConnection(type?: ConnectionType): C

• Implementation of IDatabaseDriver.getConnection

  Parameters

  • type: ConnectionType = 'write'

  Returns C

getDependencies

• getDependencies(): string[]

• Implementation of IDatabaseDriver.getDependencies

  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

• Implementation of IDatabaseDriver.getMetadata

  Returns MetadataStorage

getPlatform

• getPlatform(): Platform

• Implementation of IDatabaseDriver.getPlatform

  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?: any, orderBy?: OrderDefinition<T>, ctx?: any, options?: FindOptions<T, any, any, any>, pivotJoin?: boolean): Promise<Dictionary<T[]>>

• Implementation of IDatabaseDriver.loadFromPivotTable

  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: any

  • 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>

• Implementation of IDatabaseDriver.lockPessimistic

  Parameters

  • entity: T

  • options: LockOptions

  Returns Promise<void>

mapResult

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

• Implementation of IDatabaseDriver.mapResult

  Parameters

  • result: EntityDictionary<T>

  • optionalmeta: EntityMetadata<T>

  • populate: PopulateOptions<T>[] = []

  Returns null | EntityData<T>

abstractnativeDelete

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

• Implementation of IDatabaseDriver.nativeDelete

  Parameters

  • entityName: string

  • where: FilterQuery<T>

  • optionaloptions: DeleteOptions<T>

  Returns Promise<QueryResult<T>>

abstractnativeInsert

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

• Implementation of IDatabaseDriver.nativeInsert

  Parameters

  • entityName: string

  • data: EntityDictionary<T>

  • optionaloptions: NativeInsertUpdateOptions<T>

  Returns Promise<QueryResult<T>>

abstractnativeInsertMany

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

• Implementation of IDatabaseDriver.nativeInsertMany

  Parameters

  • entityName: string

  • data: EntityDictionary<T>[]

  • optionaloptions: NativeInsertUpdateManyOptions<T>

  • optionaltransform: (sql: string) => string

  Returns Promise<QueryResult<T>>

abstractnativeUpdate

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

• Implementation of IDatabaseDriver.nativeUpdate

  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>>

• Implementation of IDatabaseDriver.nativeUpdateMany

  Parameters

  • entityName: string

  • where: FilterQuery<T>[]

  • data: EntityDictionary<T>[]

  • optionaloptions: NativeInsertUpdateManyOptions<T>

  Returns Promise<QueryResult<T>>

reconnect

• reconnect(): Promise<C>

• Implementation of IDatabaseDriver.reconnect

  Returns Promise<C>

setMetadata

• setMetadata(metadata: MetadataStorage): void

• Implementation of IDatabaseDriver.setMetadata

  Parameters

  • metadata: MetadataStorage

  Returns void

syncCollections

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

• Implementation of IDatabaseDriver.syncCollections

  Parameters

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

  • optionaloptions: DriverMethodOptions

  Returns Promise<void>