Skip to main content

Version: 6.4

abstractDatabaseDriver <C>

Hierarchy

DatabaseDriver
- AbstractSqlDriver
- MongoDriver

Implements

IDatabaseDriver<C>

Properties

[EntityManagerType]

[EntityManagerType]: EntityManager<DatabaseDriver<C>>

readonlyconfig

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

Methods

aggregate

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

Implementation of IDatabaseDriver.aggregate
Parameters
- entityName: string
- pipeline: any[]
Returns Promise<any[]>

close

close(force): 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): DriverException

Implementation of IDatabaseDriver.convertException
Converts native db errors to standardized driver exceptions
Parameters
- exception: Error
Returns DriverException

abstractcount

count(entityName, where, options): Promise<number>

Implementation of IDatabaseDriver.count
Parameters
- entityName: string
- where: FilterQuery<T>
- optionaloptions: CountOptions<T, P>
Returns Promise<number>

countVirtual

countVirtual(entityName, where, options): Promise<number>

Parameters
- entityName: string
- where: FilterQuery<T>
- options: CountOptions<T, any>
Returns Promise<number>

createEntityManager

createEntityManager(useContext): D[typeof EntityManagerType]

Implementation of IDatabaseDriver.createEntityManager
Parameters
- optionaluseContext: boolean
Returns D[typeof EntityManagerType]

abstractfind

find(entityName, where, options): 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, where, options): 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, where, options): 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): 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, owners, where, orderBy, ctx, options, pivotJoin): 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, options): Promise<void>

Implementation of IDatabaseDriver.lockPessimistic
Parameters
- entity: T
- options: LockOptions
Returns Promise<void>

mapResult

mapResult(result, meta, populate): null | EntityData<T>

Implementation of IDatabaseDriver.mapResult
Parameters
- result: EntityDictionary<T>
- optionalmeta: EntityMetadata<T>
- populate: PopulateOptions<T>[] = []
Returns null | EntityData<T>

abstractnativeDelete

nativeDelete(entityName, where, options): Promise<QueryResult<T>>

Implementation of IDatabaseDriver.nativeDelete
Parameters
- entityName: string
- where: FilterQuery<T>
- optionaloptions: DeleteOptions<T>
Returns Promise<QueryResult<T>>

abstractnativeInsert

nativeInsert(entityName, data, options): Promise<QueryResult<T>>

Implementation of IDatabaseDriver.nativeInsert
Parameters
- entityName: string
- data: EntityDictionary<T>
- optionaloptions: NativeInsertUpdateOptions<T>
Returns Promise<QueryResult<T>>

abstractnativeInsertMany

nativeInsertMany(entityName, data, options, transform): Promise<QueryResult<T>>

Implementation of IDatabaseDriver.nativeInsertMany
Parameters
- entityName: string
- data: EntityDictionary<T>[]
- optionaloptions: NativeInsertUpdateManyOptions<T>
- optionaltransform: (sql) => string
Returns Promise<QueryResult<T>>

abstractnativeUpdate

nativeUpdate(entityName, where, data, options): 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, where, data, options): 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): void

Implementation of IDatabaseDriver.setMetadata
Parameters
- metadata: MetadataStorage
Returns void

syncCollections

syncCollections(collections, options): Promise<void>

Implementation of IDatabaseDriver.syncCollections
Parameters
- collections: Iterable<Collection<T, O>, any, any>
- optionaloptions: DriverMethodOptions
Returns Promise<void>