Provides behavior for enqueuing and retrying jobs.
Namespace
Methods
Instance Public methods
enqueue(options={})
Link
Enqueues the job to be performed by the queue adapter.
Options
-
:wait
- Enqueues the job with the specified delay -
: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
my_job_instance.enqueue
my_job_instance.enqueue wait: 5.minutes
my_job_instance.enqueue queue: :important
my_job_instance.enqueue wait_until: Date.tomorrow.midnight
my_job_instance.enqueue priority: 10
# File activejob/lib/active_job/enqueuing.rb, line 67 def enqueue(options={}) self.scheduled_at = options[:wait].seconds.from_now.to_f if options[:wait] self.scheduled_at = options[:wait_until].to_f if options[:wait_until] self.queue_name = self.class.queue_name_from_part(options[:queue]) if options[:queue] self.priority = options[:priority].to_i if options[:priority] run_callbacks :enqueue do if self.scheduled_at self.class.queue_adapter.enqueue_at self, self.scheduled_at else self.class.queue_adapter.enqueue self end end self end
retry_job(options={})
Link
Reschedules the job to be re-executed. This is useful in combination with
the rescue_from
option. 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 -
: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