Class KyselyLockAdapter

To utilize the KyselyLockAdapter, you must install the "kysely" package and configure a Kysely class instance.

Note in order to use KyselyLockAdapter correctly, ensure you use a single, consistent database across all server instances. The adapter have been tested with sqlite, postgres and mysql databases.

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

Implements

Index

Constructors

constructor

Methods

deInit find init insert refresh remove removeAllExpired update

Constructors

constructor

new KyselyLockAdapter(settings: KyselyLockAdapterSettings): KyselyLockAdapter

Parameters

settings: KyselyLockAdapterSettings

Returns KyselyLockAdapter

Example

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

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

Methods

deInit

deInit(): Promise<void>
Returns Promise<void>
Implementation of IDeinitizable.deInit
- Defined in src/lock/implementations/adapters/kysely-lock-adapter/kysely-lock-adapter.ts:107

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/kysely-lock-adapter/kysely-lock-adapter.ts:227

init

init(): Promise<void>
Returns Promise<void>
Implementation of IInitizable.init
- Defined in src/lock/implementations/adapters/kysely-lock-adapter/kysely-lock-adapter.ts:130

insert

insert(key: string, owner: string, expiration: null | Date): Promise<void>
The insert method will create a lock if it does not exist and if the lock already exists an error must be thrown.
Parameters
- key: string
- owner: string
- expiration: null | Date
Returns Promise<void>
Implementation of IDatabaseLockAdapter.insert
- Defined in src/lock/implementations/adapters/kysely-lock-adapter/kysely-lock-adapter.ts:168

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.
Parameters
- key: string
- owner: string
- expiration: Date
Returns Promise<number>
Returns number of updated rows or documents.
Implementation of IDatabaseLockAdapter.refresh
- Defined in src/lock/implementations/adapters/kysely-lock-adapter/kysely-lock-adapter.ts:213

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/kysely-lock-adapter/kysely-lock-adapter.ts:203

removeAllExpired

removeAllExpired(): Promise<void>
Returns Promise<void>
Implementation of IPrunable.removeAllExpired
- Defined in src/lock/implementations/adapters/kysely-lock-adapter/kysely-lock-adapter.ts:161

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.
Parameters
- key: string
- owner: string
- expiration: null | Date
Returns Promise<number>
Returns number of updated rows or documents.
Implementation of IDatabaseLockAdapter.update
- Defined in src/lock/implementations/adapters/kysely-lock-adapter/kysely-lock-adapter.ts:183

Class KyselyLockAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns KyselyLockAdapter

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>

removeAllExpired

Returns Promise<void>

update

Parameters

Returns Promise<number>

Settings

On This Page