Class SqliteLockAdapter

To utilize the SqliteLockAdapter, you must install the "better-sqlite3" and "@types/better-sqlite3" packages.

Note the SqliteLockAdapter is limited to single server usage and cannot be shared across multiple servers but it can be shared between different processes. To use it correctly, ensure all process instances access the same consistent, persisted database.

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

Implements

Index

Constructors

constructor

Methods

deInit find init insert refresh remove removeExpiredKeys update

Constructors

constructor

new SqliteLockAdapter(settings: SqliteLockAdapterSettings): SqliteLockAdapter

Parameters

settings: SqliteLockAdapterSettings

Returns SqliteLockAdapter

Example

import { SqliteLockAdapter } from "@daiso-tech/core/lock/adapters";
import Sqlite from "better-sqlite3";

const database = new Sqlite("local.db");
const lockAdapter = new SqliteLockAdapter({
  database,
});
// You need initialize the adapter once before using it.
await lockAdapter.init();

Methods

deInit

deInit(): Promise<void>
Removes the table where the lock keys are stored and removes the table indexes. Note all lock data will be removed.

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

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/sqlite-lock-adapter/sqlite-lock-adapter.ts:131

init

init(): Promise<void>
Creates the table where the lock keys are stored and it's 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/sqlite-lock-adapter/sqlite-lock-adapter.ts:99

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/sqlite-lock-adapter/sqlite-lock-adapter.ts:103

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/sqlite-lock-adapter/sqlite-lock-adapter.ts:123

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/sqlite-lock-adapter/sqlite-lock-adapter.ts:119

removeExpiredKeys

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

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/sqlite-lock-adapter/sqlite-lock-adapter.ts:111

Class SqliteLockAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SqliteLockAdapter

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