Class MongodbLockAdapter

To utilize the MongodbLockAdapter, you must install the "mongodb" package.

Note in order to use MongodbLockAdapter correctly, ensure you use a single, consistent database across all server instances.

IMPORT_PATH: "@daiso-tech/core/lock/adapters"

Implements

Index

Constructors

constructor

Methods

deInit find init insert refresh remove removeExpiredKeys update

Constructors

constructor

new MongodbLockAdapter(
__namedParameters: MongodbLockAdapterSettings,
): MongodbLockAdapter

Parameters

__namedParameters: MongodbLockAdapterSettings

Returns MongodbLockAdapter

Example

import { MongodbLockAdapter } from "@daiso-tech/core/lock/adapters";
import { MongoClient } from "mongodb";

const client = await MongoClient.connect("YOUR_MONGODB_CONNECTION_STRING");
const database = client.db("database");
const lockAdapter = new MongodbLockAdapter({
  database
});
// You need initialize the adapter once before using it.
await lockAdapter.init()

Methods

deInit

deInit(): Promise<void>
Removes the collection where the lock keys are stored and all it's related indexes. Note all lock data will be removed.

Returns Promise<void>
Implementation of IDeinitizable.deInit
- Defined in src/lock/implementations/adapters/mongodb-lock-adapter/mongodb-lock-adapter.ts:111

find

find(key: string): Promise<null | ILockData>
The find method will return a lock by the given key.
Parameters
- key: string
Returns Promise<null | ILockData>
Implementation of IDatabaseLockAdapter.find
- Defined in src/lock/implementations/adapters/mongodb-lock-adapter/mongodb-lock-adapter.ts:218

init

init(): Promise<void>
Creates all related indexes. Note the init method needs to be called before using the adapter.

Returns Promise<void>
Implementation of IInitizable.init
- Defined in src/lock/implementations/adapters/mongodb-lock-adapter/mongodb-lock-adapter.ts:93

insert

insert(key: string, owner: string, expiration: null | Date): Promise<void>
The insert method will create a lock if one does not already exist.
Parameters
- key: string
- owner: string
- expiration: null | Date
Returns Promise<void>
Implementation of IDatabaseLockAdapter.insert
- Defined in src/lock/implementations/adapters/mongodb-lock-adapter/mongodb-lock-adapter.ts:116

refresh

refresh(key: string, owner: string, expiration: Date): Promise<number>
The refresh method will upadte expiration of lock if it matches the given key and matches the given owner. Returns number of updated rows or documents.
Parameters
- key: string
- owner: string
- expiration: Date
Returns Promise<number>
Implementation of IDatabaseLockAdapter.refresh
- Defined in src/lock/implementations/adapters/mongodb-lock-adapter/mongodb-lock-adapter.ts:194

remove

remove(key: string, owner: null | string): Promise<void>
The remove method will remove a lock if it matches the given key and matches the given owner.
Parameters
- key: string
- owner: null | string
Returns Promise<void>
Implementation of IDatabaseLockAdapter.remove
- Defined in src/lock/implementations/adapters/mongodb-lock-adapter/mongodb-lock-adapter.ts:171

removeExpiredKeys

removeExpiredKeys(): Promise<void>
Returns Promise<void>
- Defined in src/lock/implementations/adapters/mongodb-lock-adapter/mongodb-lock-adapter.ts:81

update

update(key: string, owner: string, expiration: null | Date): Promise<number>
The update method will update a lock if it has expired, matches the given key and matches the given owner. Returns number of updated rows or documents.
Parameters
- key: string
- owner: string
- expiration: null | Date
Returns Promise<number>
Implementation of IDatabaseLockAdapter.update
- Defined in src/lock/implementations/adapters/mongodb-lock-adapter/mongodb-lock-adapter.ts:134

Class MongodbLockAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MongodbLockAdapter

Example

Methods

deInit

Returns Promise<void>

find

Parameters

Returns Promise<null | ILockData>

init

Returns Promise<void>

insert

Parameters

Returns Promise<void>

refresh

Parameters

Returns Promise<number>

remove

Parameters

Returns Promise<void>

removeExpiredKeys

Returns Promise<void>

update

Parameters

Returns Promise<number>

Settings

On This Page