Skip to main content

Version: Next

MongoDriver

Hierarchy

DatabaseDriver<MongoConnection>
- MongoDriver

Constructors

constructor

new MongoDriver(config): MongoDriver

Overrides DatabaseDriver<MongoConnection>.constructor
Parameters
- config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>
Returns MongoDriver

Properties

[EntityManagerType]

[EntityManagerType]: MongoEntityManager<MongoDriver>

readonlyinheritedconfig

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

Methods

aggregate

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

Overrides DatabaseDriver.aggregate
Parameters
- entityName: string
- pipeline: any[]
- optionalctx: ClientSession
Returns Promise<any[]>

inheritedclose

close(force): Promise<void>

Inherited from DatabaseDriver.close
Parameters
- optionalforce: boolean
Returns Promise<void>

inheritedconnect

connect(): Promise<MongoConnection>

Inherited from DatabaseDriver.connect
Returns Promise<MongoConnection>

inheritedconvertException

convertException(exception): DriverException

Inherited from DatabaseDriver.convertException
Converts native db errors to standardized driver exceptions
Parameters
- exception: Error
Returns DriverException

count

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

Overrides DatabaseDriver.count
Parameters
- entityName: string
- where: FilterQuery<T>
- options: CountOptions<T, never> = {}
- optionalctx: ClientSession
Returns Promise<number>

inheritedcountVirtual

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

Inherited from DatabaseDriver.countVirtual
Parameters
- entityName: string
- where: FilterQuery<T>
- options: CountOptions<T, any>
Returns Promise<number>

createEntityManager

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

Overrides DatabaseDriver.createEntityManager
Parameters
- optionaluseContext: boolean
Returns D[typeof EntityManagerType]

find

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

Overrides DatabaseDriver.find
Finds selection of entities
Parameters
- entityName: string
- where: FilterQuery<T>
- options: FindOptions<T, P, F, E> = {}
Returns Promise<EntityData<T>[]>

findOne

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

Overrides DatabaseDriver.findOne
Finds single entity (table row, document)
Parameters
- entityName: string
- where: FilterQuery<T>
- options: FindOneOptions<T, P, F, E> = ...
Returns Promise<null | EntityData<T>>

findVirtual

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

Overrides DatabaseDriver.findVirtual
Parameters
- entityName: string
- where: FilterQuery<T>
- options: FindOptions<T, any, any, any>
Returns Promise<EntityData<T>[]>

inheritedgetConnection

getConnection(type): MongoConnection

Inherited from DatabaseDriver.getConnection
Parameters
- type: ConnectionType = 'write'
Returns MongoConnection

inheritedgetDependencies

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

inheritedgetMetadata

getMetadata(): MetadataStorage

Inherited from DatabaseDriver.getMetadata
Returns MetadataStorage

getPlatform

getPlatform(): MongoPlatform

Overrides DatabaseDriver.getPlatform
Returns MongoPlatform

inheritedloadFromPivotTable

loadFromPivotTable<T, O>(prop, owners, where, orderBy, ctx, options, pivotJoin): Promise<Dictionary<T[]>>

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

inheritedlockPessimistic

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

Inherited from DatabaseDriver.lockPessimistic
Parameters
- entity: T
- options: LockOptions
Returns Promise<void>

inheritedmapResult

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

Inherited from DatabaseDriver.mapResult
Parameters
- result: EntityDictionary<T>
- optionalmeta: EntityMetadata<T>
- populate: PopulateOptions<T>[] = []
Returns null | EntityData<T>

nativeDelete

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

Overrides DatabaseDriver.nativeDelete
Parameters
- entityName: string
- where: FilterQuery<T>
- options: { ctx?: ClientSession } = {}
Returns Promise<QueryResult<T>>

nativeInsert

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

Overrides DatabaseDriver.nativeInsert
Parameters
- entityName: string
- data: EntityDictionary<T>
- options: NativeInsertUpdateOptions<T> = {}
Returns Promise<QueryResult<T>>

nativeInsertMany

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

Overrides DatabaseDriver.nativeInsertMany
Parameters
- entityName: string
- data: EntityDictionary<T>[]
- options: NativeInsertUpdateManyOptions<T> = {}
Returns Promise<QueryResult<T>>

nativeUpdate

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

Overrides DatabaseDriver.nativeUpdate
Parameters
- entityName: string
- where: FilterQuery<T>
- data: EntityDictionary<T>
- options: NativeInsertUpdateOptions<T> & UpsertOptions<T, never> = {}
Returns Promise<QueryResult<T>>

nativeUpdateMany

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

Overrides DatabaseDriver.nativeUpdateMany
Parameters
- entityName: string
- where: FilterQuery<T>[]
- data: EntityDictionary<T>[]
- options: NativeInsertUpdateOptions<T> & UpsertManyOptions<T, never> = {}
Returns Promise<QueryResult<T>>

inheritedreconnect

reconnect(): Promise<MongoConnection>

Inherited from DatabaseDriver.reconnect
Returns Promise<MongoConnection>

inheritedsetMetadata

setMetadata(metadata): void

Inherited from DatabaseDriver.setMetadata
Parameters
- metadata: MetadataStorage
Returns void

inheritedsyncCollections

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

Inherited from DatabaseDriver.syncCollections
Parameters
- collections: Iterable<Collection<T, O>, any, any>
- optionaloptions: DriverMethodOptions
Returns Promise<void>