Module: SidekiqScheduler::Schedule
- Included in:
- Sidekiq
- Defined in:
- lib/sidekiq-scheduler/schedule.rb
Instance Method Summary collapse
-
#get_all_schedules ⇒ Object
gets the schedule as it exists in redis.
-
#get_schedule(name = nil) ⇒ Object
Retrive the schedule configuration for the given name if the name is nil it returns a hash with all the names end their schedules.
-
#reload_schedule! ⇒ Object
(also: #schedule!)
Reloads the schedule from Redis and return it.
-
#remove_schedule(name) ⇒ Object
remove a given schedule by name.
- #schedule ⇒ Object
-
#schedule=(schedule_hash) ⇒ Object
Accepts a new schedule configuration of the form:.
-
#set_schedule(name, config) ⇒ Object
Create or update a schedule with the provided name and configuration.
Instance Method Details
#get_all_schedules ⇒ Object
gets the schedule as it exists in redis
78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 78 def get_all_schedules schedules = nil if Sidekiq.redis { |r| r.exists(:schedules) } schedules = {} Sidekiq.redis { |r| r.hgetall(:schedules) }.tap do |h| h.each do |name, config| schedules[name] = MultiJson.decode(config) end end end schedules end |
#get_schedule(name = nil) ⇒ Object
Retrive the schedule configuration for the given name if the name is nil it returns a hash with all the names end their schedules.
68 69 70 71 72 73 74 75 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 68 def get_schedule(name = nil) if name.nil? get_all_schedules else encoded_schedule = Sidekiq.redis { |r| r.hget(:schedules, name) } encoded_schedule.nil? ? nil : MultiJson.decode(encoded_schedule) end end |
#reload_schedule! ⇒ Object Also known as: schedule!
Reloads the schedule from Redis and return it.
60 61 62 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 60 def reload_schedule! @schedule = get_schedule end |
#remove_schedule(name) ⇒ Object
remove a given schedule by name
112 113 114 115 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 112 def remove_schedule(name) Sidekiq.redis { |r| r.hdel(:schedules, name) } Sidekiq.redis { |r| r.sadd(:schedules_changed, name) } end |
#schedule ⇒ Object
53 54 55 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 53 def schedule @schedule ||= {} end |
#schedule=(schedule_hash) ⇒ Object
Accepts a new schedule configuration of the form:
{
"MakeTea" => {
"every" => "1m" },
"some_name" => {
"cron" => "5/* * * *",
"class" => "DoSomeWork",
"args" => "work on this string",
"description" => "this thing works it"s butter off" },
...
}
Hash keys can be anything and are used to describe and reference the scheduled job. If the “class” argument is missing, the key is used implicitly as “class” argument - in the “MakeTea” example, “MakeTea” is used both as job name and sidekiq worker class.
:cron can be any cron scheduling string
:every can be used in lieu of :cron. see rufus-scheduler’s ‘every’ usage for valid syntax. If :cron is present it will take precedence over :every.
:class must be a sidekiq worker class. If it is missing, the job name (hash key) will be used as :class.
:args can be any yaml which will be converted to a ruby literal and passed in a params. (optional)
:description is just that, a description of the job (optional). If params is an array, each element in the array is passed as a separate param, otherwise params is passed in as the only parameter to perform.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 38 def schedule=(schedule_hash) schedule_hash = prepare_schedule(schedule_hash) to_remove = (get_all_schedules || {}).keys - schedule_hash.keys schedule_hash.each do |name, job_spec| set_schedule(name, job_spec) end to_remove.each do |name| remove_schedule(name) end @schedule = schedule_hash end |
#set_schedule(name, config) ⇒ Object
Create or update a schedule with the provided name and configuration.
Note: values for class and custom_job_class need to be strings, not constants.
Sidekiq.set_schedule('some_job', { :class => 'SomeJob',
:every => '15mins',
:queue => 'high',
:args => '/tmp/poop' })
102 103 104 105 106 107 108 109 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 102 def set_schedule(name, config) existing_config = get_schedule(name) unless existing_config && existing_config == config Sidekiq.redis { |r| r.hset(:schedules, name, MultiJson.encode(config)) } Sidekiq.redis { |r| r.sadd(:schedules_changed, name) } end config end |