Class MongoClient

Hierarchy

MongoClient

Index

Constructors

Properties

config connectionPool inCloseProcedure serializer

Methods

close connect dropDatabase execute getConnection resolveCollectionName

Constructors

constructor

new MongoClient(connectionString: string): MongoClient
Parameters
- connectionString: string
Returns MongoClient
- Defined in packages/mongo/src/client/client.ts:29

Properties

`Readonly` config

config: MongoClientConfig

connectionPool

connectionPool: MongoConnectionPool

`Protected` inCloseProcedure

inCloseProcedure: boolean = false

`Protected` serializer

serializer: BSONBinarySerializer = mongoBinarySerializer

Methods

close

close(): void
Returns void
- Defined in packages/mongo/src/client/client.ts:44

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in packages/mongo/src/client/client.ts:40

dropDatabase

dropDatabase(dbName: string): Promise<void>
Parameters
- dbName: string
Returns Promise<void>
- Defined in packages/mongo/src/client/client.ts:49

execute

execute<T>(command: T): Promise<ReturnType<T["execute"]>>
Type Parameters
- T extends Command<T>
Parameters
- command: T
Returns Promise<ReturnType<T["execute"]>>
- Defined in packages/mongo/src/client/client.ts:73

getConnection

getConnection(request?: ConnectionRequest, transaction?: MongoDatabaseTransaction): Promise<MongoConnection>
Returns an existing or new connection, that needs to be released once done using it.
Parameters
- request: ConnectionRequest = {}
- Optional transaction: MongoDatabaseTransaction
Returns Promise<MongoConnection>
- Defined in packages/mongo/src/client/client.ts:56

resolveCollectionName

resolveCollectionName(schema: ReflectionClass<any>): string
Parameters
- schema: ReflectionClass<any>
Returns string
- Defined in packages/mongo/src/client/client.ts:36

Generated using TypeDoc