Class Transaction<T>

A wrapper of mongo class for transaction

Type parameters

T: Types

Hierarchy

Transaction

Index

Constructors

constructor

Properties

mongo

Accessors

session

Methods

Constructors

constructor

new Transaction<T>(mongo: Mongo<T>): Transaction<T>

- Defined in Transaction.ts:53
Type parameters
- T: unknown
Parameters
- mongo: Mongo<T>
Returns Transaction<T>

Properties

Readonly mongo

mongo: Mongo<T>

The mongo instance to wrap

Accessors

session

get session(): ClientSession

- Defined in Transaction.ts:57
Returns ClientSession

Methods

all

all(): Promise<Cursor<T>>

- Defined in Transaction.ts:99
Get all document in the collection

Returns Promise<Cursor<T>>

delete

delete(key: string): Promise<DeleteResult>

- Defined in Transaction.ts:84
Delete a document from the collection

Parameters
- key: string
  
  The document key
Returns Promise<DeleteResult>

deleteAll

deleteAll(): Promise<DeleteResult>

- Defined in Transaction.ts:106
Delete all document in the collection

Returns Promise<DeleteResult>

filter

filter(): Filter<T>

- Defined in Transaction.ts:129
Shortcut for creating filter

Returns Filter<T>

get

get(key: string): Promise<null | Doc<T>>

- Defined in Transaction.ts:76
Get a document from the collection

Parameters
- key: string
  
  The document key
Returns Promise<null | Doc<T>>

index

index(indexSpec: { data?: IndexDirection | { [ K in string | number | symbol]: IndexDirection }; key?: IndexDirection }, options?: CreateIndexesOptions): Promise<void>

- Defined in Transaction.ts:111
Create an index in the ocllection

Parameters
- indexSpec: { data?: IndexDirection | { [ K in string | number | symbol]: IndexDirection }; key?: IndexDirection }
  - Optional data?: IndexDirection | { [ K in string | number | symbol]: IndexDirection }
  - Optional key?: IndexDirection
- Optional options: CreateIndexesOptions
Returns Promise<void>

match

match(matcher: RegExp): Promise<Cursor<T>>

- Defined in Transaction.ts:92
Find and match all document key with the matcher in the collection

Parameters
- matcher: RegExp
  
  The matcher in regex
Returns Promise<Cursor<T>>

query

query(match: Match<T>): Query<T>

- Defined in Transaction.ts:124
Create a query object

Parameters
- match: Match<T>
Returns Query<T>

set

set(key: string, value: T): Promise<UpdateResult>

- Defined in Transaction.ts:68
Set a data into the collection

Parameters
- key: string
  
  The data key
- value: T
  
  The data value
Returns Promise<UpdateResult>

Static abortTransaction

abortTransaction(client: MongoClient): Promise<void>

- Defined in Transaction.ts:41
Abort transaction for a mongo client

Parameters
- client: MongoClient
Returns Promise<void>

Static commitTransaction

commitTransaction(client: MongoClient): Promise<void>

- Defined in Transaction.ts:31
Commit transaction for a mongo client

Parameters
- client: MongoClient
Returns Promise<void>

Static startTransaction

startTransaction(client: MongoClient, options?: TransactionOptions): Promise<void>

- Defined in Transaction.ts:16
Start transaction for a mongo client

Parameters
- client: MongoClient
- Optional options: TransactionOptions
Returns Promise<void>

Generated using TypeDoc