abstractDatabaseDriver <C>
Hierarchy
- DatabaseDriver
Implements
Index
Properties
Methods
- aggregate
- close
- connect
- convertException
- count
- countVirtual
- createEntityManager
- ensureIndexes
- find
- findOne
- findVirtual
- getConnection
- getDependencies
- getMetadata
- getPlatform
- init
- loadFromPivotTable
- lockPessimistic
- mapResult
- nativeDelete
- nativeInsert
- nativeInsertMany
- nativeUpdate
- nativeUpdateMany
- reconnect
- setMetadata
- syncCollection
Properties
[EntityManagerType]
readonlyconfig
Methods
aggregate
Parameters
entityName: string
pipeline: any[]
Returns Promise<any[]>
close
Parameters
optionalforce: boolean
Returns Promise<void>
connect
Returns Promise<C>
convertException
Parameters
exception: Error
Returns DriverException
abstractcount
Type parameters
- T: object
- P: string = never
Parameters
entityName: string
where: FilterQuery<T>
optionaloptions: CountOptions<T, P>
Returns Promise<number>
countVirtual
Type parameters
- T: object
Parameters
entityName: string
where: FilterQuery<T>
options: CountOptions<T, never>
Returns Promise<number>
createEntityManager
Type parameters
- D: IDatabaseDriver<Connection, D> = IDatabaseDriver<Connection>
Parameters
optionaluseContext: boolean
Returns D[typeof EntityManagerType]
ensureIndexes
Returns Promise<void>
abstractfind
Finds selection of entities
Type parameters
- T: object
- P: string = never
Parameters
entityName: string
where: FilterQuery<T>
optionaloptions: FindOptions<T, P>
Returns Promise<EntityData<T>[]>
abstractfindOne
Finds single entity (table row, document)
Type parameters
- T: object
- P: string = never
Parameters
entityName: string
where: FilterQuery<T>
optionaloptions: FindOneOptions<T, P>
Returns Promise<null | EntityData<T>>
findVirtual
Type parameters
- T: object
Parameters
entityName: string
where: FilterQuery<T>
options: FindOptions<T, any>
Returns Promise<EntityData<T>[]>
getConnection
Parameters
type: ConnectionType = 'write'
Returns C
getDependencies
Returns name of the underlying database dependencies (e.g.
mongodb
ormysql2
) for SQL drivers it also returnsknex
in the array as connectors are not used directly thereReturns string[]
getMetadata
Returns MetadataStorage
getPlatform
Returns Platform
init
Returns Promise<void>
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>
owners: Primary<O>[][]
optionalwhere: FilterQuery<any>
optionalorderBy: QueryOrderMap<T>[]
optionalctx: any
optionaloptions: FindOptions<T, any>
Returns Promise<Dictionary<T[]>>
lockPessimistic
Type parameters
- T
Parameters
entity: T
options: LockOptions
Returns Promise<void>
mapResult
Type parameters
- T: object
Parameters
result: EntityDictionary<T>
optionalmeta: EntityMetadata<T>
populate: PopulateOptions<T>[] = []
Returns null | EntityData<T>
abstractnativeDelete
Type parameters
- T: object
Parameters
entityName: string
where: FilterQuery<T>
optionaloptions: DeleteOptions<T>
Returns Promise<QueryResult<T>>
abstractnativeInsert
Type parameters
- T: object
Parameters
entityName: string
data: EntityDictionary<T>
optionaloptions: NativeInsertUpdateOptions<T>
Returns Promise<QueryResult<T>>
abstractnativeInsertMany
Type parameters
- T: object
Parameters
entityName: string
data: EntityDictionary<T>[]
optionaloptions: NativeInsertUpdateManyOptions<T>
Returns Promise<QueryResult<T>>
abstractnativeUpdate
Type parameters
- T: object
Parameters
entityName: string
where: FilterQuery<T>
data: EntityDictionary<T>
optionaloptions: NativeInsertUpdateOptions<T>
Returns Promise<QueryResult<T>>
nativeUpdateMany
Type parameters
- T: object
Parameters
entityName: string
where: FilterQuery<T>[]
data: EntityDictionary<T>[]
optionaloptions: NativeInsertUpdateManyOptions<T>
Returns Promise<QueryResult<T>>
reconnect
Returns Promise<C>
setMetadata
Parameters
metadata: MetadataStorage
Returns void
syncCollection
Type parameters
- T: object
- O: object
Parameters
coll: Collection<T, O>
optionaloptions: DriverMethodOptions
Returns Promise<void>
Converts native db errors to standardized driver exceptions