MariaDbDriver

Hierarchy

• AbstractSqlDriver<MariaDbConnection, MariaDbPlatform>
  • MariaDbDriver

Index

Constructors

• constructor

Properties

• [EntityManagerType]
• config

Methods

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

Constructors

constructor

• new MariaDbDriver(config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>): MariaDbDriver

• Overrides AbstractSqlDriver<MariaDbConnection, MariaDbPlatform>.constructor

  Parameters

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

  Returns MariaDbDriver

Properties

[EntityManagerType]

[EntityManagerType]: SqlEntityManager<MariaDbDriver>

Inherited from AbstractSqlDriver.[EntityManagerType]

readonlyconfig

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

Inherited from AbstractSqlDriver.config

Methods

aggregate

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

• Inherited from AbstractSqlDriver.aggregate

  Parameters

  • entityName: string

  • pipeline: any[]

  Returns Promise<any[]>

close

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

• Inherited from AbstractSqlDriver.close

  Parameters

  • optionalforce: boolean

  Returns Promise<void>

connect

• connect(): Promise<MariaDbConnection>

• Inherited from AbstractSqlDriver.connect

  Returns Promise<MariaDbConnection>

convertException

• convertException(exception: Error): DriverException

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

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

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

• Inherited from AbstractSqlDriver.createEntityManager

  Type parameters

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

  Parameters

  • optionaluseContext: boolean

  Returns D[typeof EntityManagerType]

createQueryBuilder

• createQueryBuilder<T>(entityName: string, ctx?: Transaction<any, any[]>, preferredConnectionType?: ConnectionType, convertCustomTypes?: boolean, loggerContext?: LoggingOptions, alias?: string, em?: SqlEntityManager<AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>>): MariaDbQueryBuilder<T, any, any, any>

• Overrides AbstractSqlDriver.createQueryBuilder

  Type parameters

  • T: Partial<T>

  Parameters

  • entityName: string

  • optionalctx: Transaction<any, any[]>

  • optionalpreferredConnectionType: ConnectionType

  • optionalconvertCustomTypes: boolean

  • optionalloggerContext: LoggingOptions

  • optionalalias: string

  • optionalem: SqlEntityManager<AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>>

  Returns MariaDbQueryBuilder<T, any, any, any>

execute

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

• Inherited from AbstractSqlDriver.execute

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

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

• Inherited from AbstractSqlDriver.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>[]>

• Inherited from AbstractSqlDriver.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): MariaDbConnection

• Inherited from AbstractSqlDriver.getConnection

  Parameters

  • type: ConnectionType = 'write'

  Returns MariaDbConnection

getDependencies

• getDependencies(): string[]

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

  Returns MetadataStorage

getPlatform

• getPlatform(): MariaDbPlatform

• Inherited from AbstractSqlDriver.getPlatform

  Returns MariaDbPlatform

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

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

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

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

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

• Inherited from AbstractSqlDriver.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>): Promise<QueryResult<T>>

• Overrides AbstractSqlDriver.nativeInsertMany

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • data: EntityDictionary<T>[]

  • options: NativeInsertUpdateManyOptions<T> = {}

  Returns Promise<QueryResult<T>>

nativeUpdate

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

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

• Inherited from AbstractSqlDriver.reconnect

  Returns Promise<MariaDbConnection>

setMetadata

• setMetadata(metadata: MetadataStorage): void

• Inherited from AbstractSqlDriver.setMetadata

  Parameters

  • metadata: MetadataStorage

  Returns void

syncCollections

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

• Inherited from AbstractSqlDriver.syncCollections

  Type parameters

  • T: object
  • O: object

  Parameters

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

  • optionaloptions: DriverMethodOptions

  Returns Promise<void>