Skip to main content

Version: 6.2

IDatabaseDriver <C>

Implemented by

DatabaseDriver

Properties

[EntityManagerType]

[EntityManagerType]: EntityManager<IDatabaseDriver<C>>

readonlyconfig

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

Methods

aggregate

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

Parameters
- entityName: string
- pipeline: any[]
Returns Promise<any[]>

close

close(force): Promise<void>

Parameters
- optionalforce: boolean
Returns Promise<void>

connect

connect(): Promise<C>

Returns Promise<C>

convertException

convertException(exception): DriverException

Converts native db errors to standardized driver exceptions
Parameters
- exception: Error
Returns DriverException

count

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

Type parameters
- T: object
- P: string = never
Parameters
- entityName: string
- where: FilterQuery<T>
- optionaloptions: CountOptions<T, P>
Returns Promise<number>

createEntityManager

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

Type parameters
- D: IDatabaseDriver<Connection> = IDatabaseDriver<Connection>
Parameters
- optionaluseContext: boolean
Returns D[typeof EntityManagerType]

find

find<T, P, F, E>(entityName, where, options): Promise<EntityData<T>[]>

Finds selection of entities
Type parameters
- T: object
- P: string = never
- F: string = *
- E: string = never
Parameters
- entityName: string
- where: FilterQuery<T>
- optionaloptions: FindOptions<T, P, F, E>
Returns Promise<EntityData<T>[]>

findOne

findOne<T, P, F, E>(entityName, where, options): Promise<null | EntityData<T>>

Finds single entity (table row, document)
Type parameters
- T: object
- P: string = never
- F: string = *
- E: string = never
Parameters
- entityName: string
- where: FilterQuery<T>
- optionaloptions: FindOneOptions<T, P, F, E>
Returns Promise<null | EntityData<T>>

findVirtual

findVirtual<T>(entityName, where, options): Promise<EntityData<T>[]>

Type parameters
- T: object
Parameters
- entityName: string
- where: FilterQuery<T>
- options: FindOptions<T, any, any, any>
Returns Promise<EntityData<T>[]>

getConnection

getConnection(type): 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<T, O>(prop, owners, where, orderBy, ctx, options, pivotJoin): Promise<Dictionary<T[]>>

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)[][]
- optionalwhere: FilterQuery<T>
- optionalorderBy: OrderDefinition<T>
- optionalctx: any
- optionaloptions: FindOptions<T, any, any, any>
- optionalpivotJoin: boolean
Returns Promise<Dictionary<T[]>>

lockPessimistic

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

Type parameters
- T: object
Parameters
- entity: T
- options: LockOptions
Returns Promise<void>

mapResult

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

Type parameters
- T: object
Parameters
- result: EntityDictionary<T>
- meta: EntityMetadata<T>
- optionalpopulate: PopulateOptions<T>[]
Returns null | EntityData<T>

nativeDelete

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

Type parameters
- T: object
Parameters
- entityName: string
- where: FilterQuery<T>
- optionaloptions: NativeDeleteOptions<T>
Returns Promise<QueryResult<T>>

nativeInsert

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

Type parameters
- T: object
Parameters
- entityName: string
- data: EntityDictionary<T>
- optionaloptions: NativeInsertUpdateOptions<T>
Returns Promise<QueryResult<T>>

nativeInsertMany

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

Type parameters
- T: object
Parameters
- entityName: string
- data: EntityDictionary<T>[]
- optionaloptions: NativeInsertUpdateManyOptions<T>
- optionaltransform: (sql) => string
Returns Promise<QueryResult<T>>

nativeUpdate

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

Type parameters
- T: object
Parameters
- entityName: string
- where: FilterQuery<T>
- data: EntityDictionary<T>
- optionaloptions: NativeInsertUpdateOptions<T>
Returns Promise<QueryResult<T>>

nativeUpdateMany

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

Type parameters
- T: object
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): void

Parameters
- metadata: MetadataStorage
Returns void

syncCollections

syncCollections<T, O>(collections, options): Promise<void>

Type parameters
- T: object
- O: object
Parameters
- collections: Iterable<Collection<T, O>>
- optionaloptions: DriverMethodOptions
Returns Promise<void>