class Sidekiq::JobSet

Base class for all sorted sets which contain jobs, e.g. scheduled, retry and dead. Sidekiq Pro and Enterprise add additional sorted sets which do not contain job data, e.g. Batches.

Public Instance Methods

each() { |sorted_entry| ... } click to toggle source
# File lib/sidekiq/api.rb, line 694
def each
  initial_size = @_size
  offset_size = 0
  page = -1
  page_size = 50

  loop do
    range_start = page * page_size + offset_size
    range_end = range_start + page_size - 1
    elements = Sidekiq.redis { |conn|
      conn.zrange name, range_start, range_end, withscores: true
    }
    break if elements.empty?
    page -= 1
    elements.reverse_each do |element, score|
      yield SortedEntry.new(self, score, element)
    end
    offset_size = initial_size - @_size
  end
end
fetch(score, jid = nil) click to toggle source

Fetch jobs that match a given time or Range. Job ID is an optional second argument.

@param score [Time,Range] a specific timestamp or range @param jid [String, optional] find a specific JID within the score @return [Array<SortedEntry>] any results found, can be empty

# File lib/sidekiq/api.rb, line 722
def fetch(score, jid = nil)
  begin_score, end_score =
    if score.is_a?(Range)
      [score.first, score.last]
    else
      [score, score]
    end

  elements = Sidekiq.redis { |conn|
    conn.zrangebyscore(name, begin_score, end_score, withscores: true)
  }

  elements.each_with_object([]) do |element, result|
    data, job_score = element
    entry = SortedEntry.new(self, job_score, data)
    result << entry if jid.nil? || entry.jid == jid
  end
end
find_job(jid) click to toggle source

Find the job with the given JID within this sorted set. *This is a slow O(n) operation*. Do not use for app logic.

@param jid [String] the job identifier @return [SortedEntry] the record or nil

# File lib/sidekiq/api.rb, line 747
def find_job(jid)
  Sidekiq.redis do |conn|
    conn.zscan_each(name, match: "*#{jid}*", count: 100) do |entry, score|
      job = JSON.parse(entry)
      matched = job["jid"] == jid
      return SortedEntry.new(self, score, entry) if matched
    end
  end
  nil
end
schedule(timestamp, job) click to toggle source

Add a job with the associated timestamp to this set. @param timestamp [Time] the score for the job @param job [Hash] the job data

# File lib/sidekiq/api.rb, line 688
def schedule(timestamp, job)
  Sidekiq.redis do |conn|
    conn.zadd(name, timestamp.to_f.to_s, Sidekiq.dump_json(job))
  end
end