instance method `retry_job`

Ruby on Rails 8.1.2

Since v5.2.8.1

Available in: v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

retry_job(options = {})

Reschedules the job to be re-executed. This is useful in combination with rescue_from. When you rescue an exception from your job you can ask Active Job to retry performing your job.

Options

:wait - Enqueues the job with the specified delay in seconds
:wait_until - Enqueues the job at the time specified
:queue - Enqueues the job on the specified queue
:priority - Enqueues the job with the specified priority

Examples

class SiteScraperJob < ActiveJob::Base
  rescue_from(ErrorLoadingSite) do
    retry_job queue: :low_priority
  end

  def perform(*args)
    # raise ErrorLoadingSite if cannot scrape
  end
end

Parameters

options opt = {}

Source

# File activejob/lib/active_job/exceptions.rb, line 158
    def retry_job(options = {})
      instrument :enqueue_retry, options.slice(:error, :wait) do
        scheduled_at, queue_name, priority = self.scheduled_at, self.queue_name, self.priority
        enqueue options
      ensure
        self.scheduled_at, self.queue_name, self.priority = scheduled_at, queue_name, priority
      end
    end

Defined in activejob/lib/active_job/exceptions.rb line 158 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveJob::Exceptions

Signature

Options

Examples

Parameters