Class: MongoDbAdapter

Defined in: src/nosql/adapters/MongoDbAdapter.ts:75

MongoDB adapter for entityTS implementing INoSqlAdapter.

Provides connection pooling, document CRUD, aggregation pipelines, multi-document ACID transactions via ClientSession, and streaming cursors.

Implements

• INoSqlAdapter

Constructors

Constructor

new MongoDbAdapter(config): MongoDbAdapter

Defined in: src/nosql/adapters/MongoDbAdapter.ts:81

Parameters

Parameter	Type
config	string | MongoDbAdapterConfig

Returns

MongoDbAdapter

Methods

connect()

connect(): Promise<void>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:88

Returns

Promise<void>

Implementation of

INoSqlAdapter.connect

---

disconnect()

disconnect(): Promise<void>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:131

Returns

Promise<void>

Implementation of

INoSqlAdapter.disconnect

---

ping()

ping(): Promise<boolean>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:141

Returns

Promise<boolean>

Implementation of

INoSqlAdapter.ping

---

getCollection()

getCollection<T>(name): T

Defined in: src/nosql/adapters/MongoDbAdapter.ts:154

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
name	string

Returns

T

Implementation of

INoSqlAdapter.getCollection

---

insertOne()

insertOne<T>(collection, doc, options?): Promise<InsertOneResult>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:163

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
doc	T
options?	InsertOptions

Returns

Promise<InsertOneResult>

Implementation of

INoSqlAdapter.insertOne

---

insertMany()

insertMany<T>(collection, docs, options?): Promise<InsertManyResult>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:188

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
docs	T[]
options?	InsertOptions

Returns

Promise<InsertManyResult>

Implementation of

INoSqlAdapter.insertMany

---

find()

find<T>(collection, filter?, options?): Promise<T[]>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:214

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	FindOptions

Returns

Promise<T[]>

Implementation of

INoSqlAdapter.find

---

findOne()

findOne<T>(collection, filter?, options?): Promise<T | null>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:253

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	Omit<FindOptions, "limit">

Returns

Promise<T | null>

Implementation of

INoSqlAdapter.findOne

---

updateOne()

updateOne(collection, filter, update, options?): Promise<UpdateResult>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:284

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
update	NoSqlUpdate
options?	UpdateOptions

Returns

Promise<UpdateResult>

Implementation of

INoSqlAdapter.updateOne

---

updateMany()

updateMany(collection, filter, update, options?): Promise<UpdateResult>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:315

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
update	NoSqlUpdate
options?	UpdateOptions

Returns

Promise<UpdateResult>

Implementation of

INoSqlAdapter.updateMany

---

deleteOne()

deleteOne(collection, filter, options?): Promise<DeleteResult>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:346

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
options?	DeleteOptions

Returns

Promise<DeleteResult>

Implementation of

INoSqlAdapter.deleteOne

---

deleteMany()

deleteMany(collection, filter, options?): Promise<DeleteResult>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:371

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
options?	DeleteOptions

Returns

Promise<DeleteResult>

Implementation of

INoSqlAdapter.deleteMany

---

countDocuments()

countDocuments(collection, filter?, options?): Promise<number>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:396

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	CountOptions

Returns

Promise<number>

Implementation of

INoSqlAdapter.countDocuments

---

aggregate()

aggregate<T>(collection, pipeline, options?): Promise<T[]>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:423

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
pipeline	AggregationStage[]
options?	AggregateOptions

Returns

Promise<T[]>

Implementation of

INoSqlAdapter.aggregate

---

beginTransaction()

beginTransaction(): Promise<NoSqlTransaction>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:449

Returns

Promise<NoSqlTransaction>

Implementation of

INoSqlAdapter.beginTransaction

---

executeStream()

executeStream<T>(collection, filter?, options?): AsyncIterable<T>

Defined in: src/nosql/adapters/MongoDbAdapter.ts:489

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	FindOptions

Returns

AsyncIterable<T>

Implementation of

INoSqlAdapter.executeStream

Properties

provider

readonly provider: NoSqlProvider = 'mongodb'

Defined in: src/nosql/adapters/MongoDbAdapter.ts:76

Implementation of

INoSqlAdapter.provider