Skip to content

Queue.id

Grant Carthew edited this page Aug 19, 2016 · 11 revisions

Property Details

Usage: Read Only

Get: String

  • Returns a complex id string used to identify the Queue object processs.

Example:

const Queue = require('rethinkdb-job-queue')
const q = new Queue()
let id = q.id
// As an example the id will be similar to this
// id === 'WebDev:rjqJobQueueTests:rjqJobQueueTestJobs:11797:2ff3db65-ffef-4a9b-a932-b6ac8bcc48a0'

Description

The Queue object id property is a very important value internally within rethinkdb-job-queue. From a consumers point of view, you probably will not need the Queue.id unless something is going wrong with your job processing.

The id value is created from the following colon separated information.

  • Server Name
  • Database Name
  • Table or Queue Name
  • Node.js Process Id
  • Generated UUID

During job processing the Queue.id is recorded against the Job.queueId property and each Job log entry.

If a Queue object has the changeFeed queue option enabled it will receive all changes to the queue database table. To determine if these changes are made by the local Queue object or not, the change Job.queueId is compared to the local Queue.id. If they are the same, then the change was a local change and there is no need to raise events. If the two ids are not the same then the change has been made by a different Queue object. In this case the related Queue Events will be raised.

Main

How It Works

Contributing

API

Queue Methods

Queue Properties

Queue Events

Job Methods

Job Properties

Documentation

Clone this wiki locally