Skip to main content

Version: 5.9

MongoDriver

Hierarchy

DatabaseDriver<MongoConnection>
- MongoDriver

Constructors

constructor

new MongoDriver(config: Configuration<IDatabaseDriver<Connection>>): MongoDriver

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

Properties

[EntityManagerType]

[EntityManagerType]: MongoEntityManager<MongoDriver>

readonlyconfig

config: Configuration<IDatabaseDriver<Connection>>

Methods

aggregate

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

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

close

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

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

connect

connect(): Promise<MongoConnection>

Inherited from DatabaseDriver.connect
Returns Promise<MongoConnection>

convertException

convertException(exception: Error): DriverException

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

count

count<T>(entityName: string, where: FilterQuery<T>, options?: CountOptions<T, never>, ctx?: ClientSession): Promise<number>

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

countVirtual

countVirtual<T>(entityName: string, where: FilterQuery<T>, options: CountOptions<T, any>): Promise<number>

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

createCollections

createCollections(): Promise<void>

@deprecated
use orm.getSchemaGenerator().createSchema() instead
Returns Promise<void>

createEntityManager

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

Overrides DatabaseDriver.createEntityManager
Type parameters
- D: IDatabaseDriver<Connection, D> = IDatabaseDriver<Connection>
Parameters
- optionaluseContext: boolean
Returns D[typeof EntityManagerType]

dropCollections

dropCollections(): Promise<void>

@deprecated
use orm.getSchemaGenerator().dropSchema() instead
Returns Promise<void>

ensureIndexes

ensureIndexes(): Promise<void>

Overrides DatabaseDriver.ensureIndexes
@deprecated
use orm.getSchemaGenerator().ensureIndexes() instead
Returns Promise<void>

find

find<T, P>(entityName: string, where: FilterQuery<T>, options?: FindOptions<T, P>): Promise<EntityData<T>[]>

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

findOne

findOne<T, P>(entityName: string, where: FilterQuery<T>, options?: FindOneOptions<T, P>): Promise<null | EntityData<T>>

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

findVirtual

findVirtual<T>(entityName: string, where: FilterQuery<T>, options: FindOptions<T, any>): Promise<EntityData<T>[]>

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

getConnection

getConnection(type?: ConnectionType): MongoConnection

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

getDependencies

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

getMetadata

getMetadata(): MetadataStorage

Inherited from DatabaseDriver.getMetadata
Returns MetadataStorage

getPlatform

getPlatform(): MongoPlatform

Overrides DatabaseDriver.getPlatform
Returns MongoPlatform

init

init(): Promise<void>

Inherited from DatabaseDriver.init
Returns Promise<void>

loadFromPivotTable

loadFromPivotTable<T, O>(prop: EntityProperty<any>, owners: Primary<O>[][], where?: FilterQuery<any>, orderBy?: QueryOrderMap<T>[], ctx?: any, options?: FindOptions<T, any>): 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
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

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

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

mapResult

mapResult<T>(result: EntityDictionary<T>, meta?: EntityMetadata<T>, populate?: PopulateOptions<T>[]): null | EntityData<T>

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

nativeDelete

nativeDelete<T>(entityName: string, where: FilterQuery<T>, options?: { ctx?: ClientSession }): Promise<QueryResult<T>>

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

nativeInsert

nativeInsert<T>(entityName: string, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>

Overrides DatabaseDriver.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 DatabaseDriver.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>): Promise<QueryResult<T>>

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

nativeUpdateMany

nativeUpdateMany<T>(entityName: string, where: FilterQuery<T>[], data: EntityDictionary<T>[], options?: NativeInsertUpdateOptions<T> & UpsertManyOptions<T>): Promise<QueryResult<T>>

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

reconnect

reconnect(): Promise<MongoConnection>

Inherited from DatabaseDriver.reconnect
Returns Promise<MongoConnection>

refreshCollections

refreshCollections(options?: CreateSchemaOptions): Promise<void>

@deprecated
use orm.getSchemaGenerator().refreshDatabase() instead
Parameters
- options: CreateSchemaOptions = {}
Returns Promise<void>

setMetadata

setMetadata(metadata: MetadataStorage): void

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

syncCollection

syncCollection<T, O>(coll: Collection<T, O>, options?: DriverMethodOptions): Promise<void>

Inherited from DatabaseDriver.syncCollection
Type parameters
- T: object
- O: object
Parameters
- coll: Collection<T, O>
- optionaloptions: DriverMethodOptions
Returns Promise<void>