-
Notifications
You must be signed in to change notification settings - Fork 16
Job Schema
Grant Carthew edited this page Sep 21, 2016
·
14 revisions
For reference purposes this document shows the schema of a job as it is saved in the RethinkDB database.
Below is a JSON representation of a job in the queue. This job contains valid data although it does not have any log entries. You will not find any information on this job related to processing. That information is up to you.
{
dateCreated: 2016-09-19T03:07:44.394Z,
dateEnable: 2016-09-19T03:12:44.451Z,
dateFinished: 2016-09-19T03:07:44.469Z,
dateStarted: 2016-09-19T03:07:44.451Z,
id: '5127d082-fe7e-4e88-b1de-7093029695c3',
log: []
priority: 'normal',
progress: 0,
queueId: 'WebDev::rjqJobQueueTestJobs:1942:ebc89e54-f7d3-40a1-952a-3bb152d154ce',
retryCount: 0,
retryDelay: 600000,
retryMax: 3,
status: 'completed',
timeout: 300000
}Following is a breakdown of all of the job properties and a brief description of what they are used for.
- dateCreated: This property is rather obvious. The date is added when the job is created and should never change.
- Introduction
- Tutorial
- Queue Constructor
- Queue Connection
- Queue Options
- Queue PubSub
- Queue Master
- Queue Events
- State Document
- Job Processing
- Job Options
- Job Status
- Job Retry
- Job Repeat
- Job Logging
- Job Editing
- Job Schema
- Job Name
- Complex Job
- Delayed Job
- Cancel Job
- Error Handling
- Queue.createJob
- Queue.addJob
- Queue.getJob
- Queue.findJob
- Queue.findJobByName
- Queue.containsJobByName
- Queue.cancelJob
- Queue.reanimateJob
- Queue.removeJob
- Queue.process
- Queue.review
- Queue.summary
- Queue.ready
- Queue.pause
- Queue.resume
- Queue.reset
- Queue.stop
- Queue.drop
- Queue.Job
- Queue.host
- Queue.port
- Queue.db
- Queue.name
- Queue.r
- Queue.id
- Queue.jobOptions [R/W]
- Queue.changeFeed
- Queue.master
- Queue.masterInterval
- Queue.removeFinishedJobs
- Queue.running
- Queue.concurrency [R/W]
- Queue.paused
- Queue.idle
- Event.ready
- Event.added
- Event.updated
- Event.active
- Event.processing
- Event.progress
- Event.log
- Event.pausing
- Event.paused
- Event.resumed
- Event.completed
- Event.cancelled
- Event.failed
- Event.terminated
- Event.reanimated
- Event.removed
- Event.idle
- Event.reset
- Event.error
- Event.reviewed
- Event.detached
- Event.stopping
- Event.stopped
- Event.dropped
- Job.setName
- Job.setPriority
- Job.setTimeout
- Job.setDateEnable
- Job.setRetryMax
- Job.setRetryDelay
- Job.setRepeat
- Job.setRepeatDelay
- Job.updateProgress
- Job.update
- Job.getCleanCopy
- Job.addLog
- Job.getLastLog