Documentation / @zerotal/queue / index / SqliteDriver
Class: SqliteDriver
Defined in: queue/src/drivers/SqliteDriver.ts:41
Implements
Constructors
Constructor
new SqliteDriver(
sql,options?):SqliteDriver
Defined in: queue/src/drivers/SqliteDriver.ts:47
Parameters
sql
options?
visibilityTimeout?
number
Returns
SqliteDriver
Methods
push()
push(
record):Promise<void>
Defined in: queue/src/drivers/SqliteDriver.ts:143
Parameters
record
Omit<JobRecord, "id" | "createdAt">
Returns
Promise<void>
Implementation of
pop()
pop(
queue?):Promise<JobRecord|null>
Defined in: queue/src/drivers/SqliteDriver.ts:157
Parameters
queue?
string = "default"
Returns
Promise<JobRecord | null>
Implementation of
fail()
fail(
record,error):Promise<void>
Defined in: queue/src/drivers/SqliteDriver.ts:190
Parameters
record
error
string
Returns
Promise<void>
Implementation of
retry()
retry(
record):Promise<void>
Defined in: queue/src/drivers/SqliteDriver.ts:202
Parameters
record
Returns
Promise<void>
Implementation of
delete()
delete(
record):Promise<void>
Defined in: queue/src/drivers/SqliteDriver.ts:214
Parameters
record
Returns
Promise<void>
Implementation of
size()
size(
queue?):Promise<number>
Defined in: queue/src/drivers/SqliteDriver.ts:219
Parameters
queue?
string = "default"
Returns
Promise<number>
Implementation of
flush()
flush():
Promise<void>
Defined in: queue/src/drivers/SqliteDriver.ts:228
Returns
Promise<void>
Implementation of
listPending()
listPending(
queue?,limit?,offset?):Promise<JobRecord[]>
Defined in: queue/src/drivers/SqliteDriver.ts:235
List pending jobs (paged), optionally filtered to a single queue.
Parameters
queue?
string
limit?
number = 50
offset?
number = 0
Returns
Promise<JobRecord[]>
Implementation of
queues()
queues():
Promise<object[]>
Defined in: queue/src/drivers/SqliteDriver.ts:247
Distinct queue names with their pending depth.
Returns
Promise<object[]>
Implementation of
listFailed()
listFailed(
queue?):Promise<FailedRecord[]>
Defined in: queue/src/drivers/SqliteDriver.ts:254
Return all failed jobs, optionally filtered to a single queue.
Parameters
queue?
string
Returns
Promise<FailedRecord[]>
Implementation of
deleteFailedRecord()
deleteFailedRecord(
id):Promise<void>
Defined in: queue/src/drivers/SqliteDriver.ts:275
Remove a single failed job by its ID.
Parameters
id
number
Returns
Promise<void>
Implementation of
QueueDriver.deleteFailedRecord
clearFailed()
clearFailed(
queue?):Promise<void>
Defined in: queue/src/drivers/SqliteDriver.ts:280
Delete all failed jobs, optionally filtered to a single queue.
Parameters
queue?
string
Returns
Promise<void>
Implementation of
createBatch()
createBatch(
id,name,totalJobs,optionsJson):Promise<void>
Defined in: queue/src/drivers/SqliteDriver.ts:291
Create a new batch row and return immediately.
Parameters
id
string
name
string
totalJobs
number
optionsJson
string
Returns
Promise<void>
Implementation of
recordBatchJobComplete()
recordBatchJobComplete(
batchId):Promise<BatchStatus>
Defined in: queue/src/drivers/SqliteDriver.ts:307
Decrement pending_jobs for a completed job; mark finished if last.
Parameters
batchId
string
Returns
Promise<BatchStatus>
Implementation of
QueueDriver.recordBatchJobComplete
recordBatchJobFailed()
recordBatchJobFailed(
batchId,jobId):Promise<BatchStatus>
Defined in: queue/src/drivers/SqliteDriver.ts:328
Decrement pending_jobs + increment failed_jobs; mark finished if last.
Parameters
batchId
string
jobId
number
Returns
Promise<BatchStatus>
Implementation of
QueueDriver.recordBatchJobFailed
getBatch()
getBatch(
batchId):Promise<BatchRecord|null>
Defined in: queue/src/drivers/SqliteDriver.ts:359
Look up a batch row by ID.
Parameters
batchId
string
Returns
Promise<BatchRecord | null>