abstractAbstractSqlDriver <Connection, Platform>

Hierarchy

• DatabaseDriver<Connection>
  • AbstractSqlDriver
    • PostgreSqlDriver
    • MySqlDriver
    • MariaDbDriver
    • SqliteDriver
    • BetterSqliteDriver
    • LibSqlDriver
    • MsSqlDriver

Index

Properties

• [EntityManagerType]
• config

Methods

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

Properties

[EntityManagerType]

[EntityManagerType]: SqlEntityManager<AbstractSqlDriver<Connection, Platform>>

Overrides DatabaseDriver.[EntityManagerType]

readonlyconfig

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

Inherited from DatabaseDriver.config

Methods

aggregate

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

• Inherited from DatabaseDriver.aggregate

  Parameters

  • entityName: string

  • pipeline: any[]

  Returns Promise<any[]>

close

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

• Inherited from DatabaseDriver.close

  Parameters

  • optionalforce: boolean

  Returns Promise<void>

connect

• connect(): Promise<Connection>

• Inherited from DatabaseDriver.connect

  Returns Promise<Connection>

convertException

• convertException(exception: Error): DriverException

• Inherited from DatabaseDriver.convertException

  Converts native db errors to standardized driver exceptions

  ---

  Parameters

  • exception: Error

  Returns DriverException

count

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

• Overrides DatabaseDriver.count

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • where: any

  • options: CountOptions<T, never> = {}

  Returns Promise<number>

countVirtual

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

• Overrides DatabaseDriver.countVirtual

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • where: FilterQuery<T>

  • options: CountOptions<T, any>

  Returns Promise<number>

createEntityManager

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

• Overrides DatabaseDriver.createEntityManager

  Type parameters

  • D: IDatabaseDriver<Connection> = IDatabaseDriver<Connection>

  Parameters

  • optionaluseContext: boolean

  Returns D[typeof EntityManagerType]

execute

• execute<T>(queryOrKnex: string | QueryBuilder<any, any> | Raw<any>, params?: any[], method?: get | all | run, ctx?: any, loggerContext?: LoggingOptions): Promise<T>

• Type parameters

  • T: QueryResult<{ id: number }> | EntityData<Partial<any>> | EntityData<Partial<any>>[] = EntityData<Partial<any>>[]

  Parameters

  • queryOrKnex: string | QueryBuilder<any, any> | Raw<any>

  • params: any[] = []

  • method: get | all | run = 'all'

  • optionalctx: any

  • optionalloggerContext: LoggingOptions

  Returns Promise<T>

find

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

• Overrides DatabaseDriver.find

  Finds selection of entities

  ---

  Type parameters

  • T: object
  • P: string = never
  • F: string = ALL
  • E: string = never

  Parameters

  • entityName: string

  • where: FilterQuery<T>

  • options: FindOptions<T, P, F, E> = {}

  Returns Promise<EntityData<T>[]>

findOne

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

• Overrides DatabaseDriver.findOne

  Finds single entity (table row, document)

  ---

  Type parameters

  • T: object
  • P: string = never
  • F: string = ALL
  • E: string = never

  Parameters

  • entityName: string

  • where: FilterQuery<T>

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

  Returns Promise<null | EntityData<T>>

findVirtual

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

• Overrides DatabaseDriver.findVirtual

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • where: FilterQuery<T>

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

  Returns Promise<EntityData<T>[]>

getConnection

• getConnection(type?: ConnectionType): Connection

• Inherited from DatabaseDriver.getConnection

  Parameters

  • type: ConnectionType = 'write'

  Returns Connection

getDependencies

• getDependencies(): string[]

• Inherited from DatabaseDriver.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

• Inherited from DatabaseDriver.getMetadata

  Returns MetadataStorage

getPlatform

• getPlatform(): Platform

• Overrides DatabaseDriver.getPlatform

  Returns Platform

loadFromPivotTable

• loadFromPivotTable<T, O>(prop: EntityProperty<any, any>, owners: (O extends { [PrimaryKeyProp]?: PK } ? PK extends keyof O ? ReadonlyPrimary<UnwrapPrimary<O[PK]>> : PK extends keyof O[] ? ReadonlyPrimary<PrimaryPropToType<O, 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[]>>

• Overrides DatabaseDriver.loadFromPivotTable

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

  ---

  Type parameters

  • T: object
  • O: object

  Parameters

  • prop: EntityProperty<any, any>

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

  • where: any = ...

  • optionalorderBy: OrderDefinition<T>

  • optionalctx: any

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

  • optionalpivotJoin: boolean

  Returns Promise<Dictionary<T[]>>

lockPessimistic

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

• Overrides DatabaseDriver.lockPessimistic

  Type parameters

  • T: object

  Parameters

  • entity: T

  • options: LockOptions

  Returns Promise<void>

mapResult

• mapResult<T>(result: EntityData<T>, meta: EntityMetadata<T>, populate?: PopulateOptions<T>[], qb?: QueryBuilder<T, any, any, any>, map?: Dictionary): null | EntityData<T>

• Overrides DatabaseDriver.mapResult

  Type parameters

  • T: object

  Parameters

  • result: EntityData<T>

  • meta: EntityMetadata<T>

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

  • optionalqb: QueryBuilder<T, any, any, any>

  • map: Dictionary = {}

  Returns null | EntityData<T>

nativeDelete

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

• Overrides DatabaseDriver.nativeDelete

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • where: any

  • options: DeleteOptions<T> = {}

  Returns Promise<QueryResult<T>>

nativeInsert

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

• Overrides DatabaseDriver.nativeInsert

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • data: EntityDictionary<T>

  • options: NativeInsertUpdateOptions<T> = {}

  Returns Promise<QueryResult<T>>

nativeInsertMany

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

• Overrides DatabaseDriver.nativeInsertMany

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • data: EntityDictionary<T>[]

  • options: NativeInsertUpdateManyOptions<T> = {}

  • optionaltransform: (sql: string) => string

  Returns Promise<QueryResult<T>>

nativeUpdate

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

• Overrides DatabaseDriver.nativeUpdate

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • where: FilterQuery<T>

  • data: EntityDictionary<T>

  • options: NativeInsertUpdateOptions<T> & UpsertOptions<T, never> = {}

  Returns Promise<QueryResult<T>>

nativeUpdateMany

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

• Overrides DatabaseDriver.nativeUpdateMany

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • where: FilterQuery<T>[]

  • data: EntityDictionary<T>[]

  • options: NativeInsertUpdateManyOptions<T> & UpsertManyOptions<T, never> = {}

  Returns Promise<QueryResult<T>>

reconnect

• reconnect(): Promise<Connection>

• Inherited from DatabaseDriver.reconnect

  Returns Promise<Connection>

setMetadata

• setMetadata(metadata: MetadataStorage): void

• Inherited from DatabaseDriver.setMetadata

  Parameters

  • metadata: MetadataStorage

  Returns void

syncCollections

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

• Overrides DatabaseDriver.syncCollections

  Type parameters

  • T: object
  • O: object

  Parameters

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

  • optionaloptions: DriverMethodOptions

  Returns Promise<void>