MongoConnection

Hierarchy

• Connection
  • MongoConnection

Index

Constructors

• constructor

Methods

• aggregate
• begin
• bulkUpdateMany
• checkConnection
• close
• commit
• connect
• countDocuments
• createClient
• createCollection
• deleteMany
• dropCollection
• ensureConnection
• execute
• executeDump
• find
• getClient
• getCollection
• getConnectionOptions
• getDb
• getPlatform
• insertMany
• insertOne
• isConnected
• listCollections
• mapOptions
• rollback
• setMetadata
• setPlatform
• stream
• streamAggregate
• transactional
• updateMany

Constructors

constructor

• new MongoConnection(config, options, type): MongoConnection

• Overrides Connection.constructor

  Parameters

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

  • optionaloptions: ConnectionOptions

  • type: ConnectionType = 'write'

  Returns MongoConnection

Methods

aggregate

• aggregate<T>(entityName, pipeline, ctx, loggerContext): Promise<T[]>

• Parameters

  • entityName: EntityName<T>

  • pipeline: any[]

  • optionalctx: ClientSession

  • optionalloggerContext: LoggingOptions

  Returns Promise<T[]>

begin

• begin(options): Promise<ClientSession>

• Overrides Connection.begin

  Parameters

  • options: { ctx?: ClientSession; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel } & TransactionOptions = {}

  Returns Promise<ClientSession>

bulkUpdateMany

• bulkUpdateMany<T>(entityName, where, data, ctx, upsert, upsertOptions): Promise<QueryResult<T>>

• Parameters

  • entityName: EntityName<T>

  • where: FilterQuery<T>[]

  • data: Partial<T>[]

  • optionalctx: ClientSession

  • optionalupsert: boolean

  • optionalupsertOptions: UpsertManyOptions<T, never>

  Returns Promise<QueryResult<T>>

checkConnection

• checkConnection(): Promise<{ ok: true } | { error?: Error; ok: false; reason: string }>

• Overrides Connection.checkConnection

  Are we connected to the database

  ---

  Returns Promise<{ ok: true } | { error?: Error; ok: false; reason: string }>

close

• close(force): Promise<void>

• Overrides Connection.close

  Closes the database connection (aka disconnect)

  ---

  Parameters

  • optionalforce: boolean

  Returns Promise<void>

commit

• commit(ctx, eventBroadcaster): Promise<void>

• Overrides Connection.commit

  Parameters

  • ctx: ClientSession

  • optionaleventBroadcaster: TransactionEventBroadcaster

  Returns Promise<void>

connect

• connect(options): Promise<void>

• Overrides Connection.connect

  Establishes connection to database

  ---

  Parameters

  • optionaloptions: { skipOnConnect?: boolean }

  • optionalskipOnConnect: boolean

  Returns Promise<void>

countDocuments

• countDocuments<T>(entityName, where, ctx): Promise<number>

• Parameters

  • entityName: EntityName<T>

  • where: FilterQuery<T>

  • optionalctx: ClientSession

  Returns Promise<number>

createClient

• createClient(): void

• Returns void

createCollection

• createCollection<T>(name): Promise<Collection<T>>

• Parameters

  • name: EntityName<T>

  Returns Promise<Collection<T>>

deleteMany

• deleteMany<T>(entityName, where, ctx): Promise<QueryResult<T>>

• Parameters

  • entityName: EntityName<T>

  • where: FilterQuery<T>

  • optionalctx: ClientSession

  Returns Promise<QueryResult<T>>

dropCollection

• dropCollection(name): Promise<boolean>

• Parameters

  • name: EntityName<Partial<any>>

  Returns Promise<boolean>

inheritedensureConnection

• ensureConnection(): Promise<void>

• Inherited from Connection.ensureConnection

  Ensure the connection exists, this is used to support lazy connect when using new MikroORM() instead of the async init method.

  ---

  Returns Promise<void>

execute

• execute(query): Promise<any>

• Overrides Connection.execute

  Parameters

  • query: string

  Returns Promise<any>

inheritedexecuteDump

• executeDump(dump): Promise<void>

• Inherited from Connection.executeDump

  Execute raw SQL queries, handy from running schema dump loaded from a file. This method doesn't support transactions, as opposed to orm.schema.execute(), which is used internally.

  ---

  Parameters

  • dump: string

  Returns Promise<void>

find

• find<T>(entityName, where, orderBy, limit, offset, fields, ctx, loggerContext): Promise<EntityData<T>[]>

• Parameters

  • entityName: EntityName<T>

  • where: FilterQuery<T>

  • optionalorderBy: QueryOrderMap<T> | QueryOrderMap<T>[]

  • optionallimit: number

  • optionaloffset: number

  • optionalfields: string[]

  • optionalctx: ClientSession

  • optionalloggerContext: LoggingOptions

  Returns Promise<EntityData<T>[]>

getClient

• getClient(): MongoClient

• Returns MongoClient

getCollection

• getCollection<T>(name): Collection<T>

• Parameters

  • name: EntityName<T>

  Returns Collection<T>

inheritedgetConnectionOptions

• getConnectionOptions(): ConnectionConfig

• Inherited from Connection.getConnectionOptions

  Returns ConnectionConfig

getDb

• getDb(): Db

• Returns Db

inheritedgetPlatform

• getPlatform(): Platform

• Inherited from Connection.getPlatform

  Returns Platform

insertMany

• insertMany<T>(entityName, data, ctx): Promise<QueryResult<T>>

• Parameters

  • entityName: EntityName<T>

  • data: Partial<T>[]

  • optionalctx: ClientSession

  Returns Promise<QueryResult<T>>

insertOne

• insertOne<T>(entityName, data, ctx): Promise<QueryResult<T>>

• Parameters

  • entityName: EntityName<T>

  • data: Partial<T>

  • optionalctx: ClientSession

  Returns Promise<QueryResult<T>>

isConnected

• isConnected(): Promise<boolean>

• Overrides Connection.isConnected

  Are we connected to the database

  ---

  Returns Promise<boolean>

listCollections

• listCollections(): Promise<string[]>

• Returns Promise<string[]>

mapOptions

• mapOptions(overrides): MongoClientOptions

• Parameters

  • overrides: MongoClientOptions

  Returns MongoClientOptions

rollback

• rollback(ctx, eventBroadcaster): Promise<void>

• Overrides Connection.rollback

  Parameters

  • ctx: ClientSession

  • optionaleventBroadcaster: TransactionEventBroadcaster

  Returns Promise<void>

inheritedsetMetadata

• setMetadata(metadata): void

• Inherited from Connection.setMetadata

  Parameters

  • metadata: MetadataStorage

  Returns void

inheritedsetPlatform

• setPlatform(platform): void

• Inherited from Connection.setPlatform

  Parameters

  • platform: Platform

  Returns void

stream

• stream<T>(entityName, where, orderBy, limit, offset, fields, ctx, loggerContext): AsyncIterableIterator<T, any, any>

• Parameters

  • entityName: EntityName<T>

  • where: FilterQuery<T>

  • optionalorderBy: QueryOrderMap<T> | QueryOrderMap<T>[]

  • optionallimit: number

  • optionaloffset: number

  • optionalfields: string[]

  • optionalctx: ClientSession

  • optionalloggerContext: LoggingOptions

  Returns AsyncIterableIterator<T, any, any>

streamAggregate

• streamAggregate<T>(entityName, pipeline, ctx, loggerContext, stream): AsyncIterableIterator<T, any, any>

• Parameters

  • entityName: EntityName<T>

  • pipeline: any[]

  • optionalctx: ClientSession

  • optionalloggerContext: LoggingOptions

  • stream: boolean = false

  Returns AsyncIterableIterator<T, any, any>

transactional

• transactional<T>(cb, options): Promise<T>

• Overrides Connection.transactional

  Parameters

  • cb: (trx) => Promise<T>

  • options: { ctx?: ClientSession; eventBroadcaster?: TransactionEventBroadcaster; isolationLevel?: IsolationLevel } & TransactionOptions = {}

  Returns Promise<T>

updateMany

• updateMany<T>(entityName, where, data, ctx, upsert, upsertOptions): Promise<QueryResult<T>>

• Parameters

  • entityName: EntityName<T>

  • where: FilterQuery<T>

  • data: Partial<T>

  • optionalctx: ClientSession

  • optionalupsert: boolean

  • optionalupsertOptions: UpsertOptions<T, never>

  Returns Promise<QueryResult<T>>