Module: SidekiqScheduler::Schedule
- 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
81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 81 def get_all_schedules schedules = {} if SidekiqScheduler::RedisManager.schedule_exist? SidekiqScheduler::RedisManager.get_all_schedules.tap do |h| h.each do |name, config| schedules[name] = JSON.parse(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.
71 72 73 74 75 76 77 78 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 71 def get_schedule(name = nil) if name.nil? get_all_schedules else encoded_schedule = SidekiqScheduler::RedisManager.get_job_schedule(name) encoded_schedule.nil? ? nil : JSON.parse(encoded_schedule) end end |
#reload_schedule! ⇒ Object Also known as: schedule!
Reloads the schedule from Redis and return it.
63 64 65 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 63 def reload_schedule! @schedule = get_schedule end |
#remove_schedule(name) ⇒ Object
remove a given schedule by name
114 115 116 117 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 114 def remove_schedule(name) SidekiqScheduler::RedisManager.remove_job_schedule(name) SidekiqScheduler::RedisManager.add_schedule_change(name) end |
#schedule ⇒ Object
56 57 58 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 56 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.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 41 def schedule=(schedule_hash) schedule_hash = prepare_schedule(schedule_hash) to_remove = get_all_schedules.keys - schedule_hash.keys.map(&:to_s) 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' })
104 105 106 107 108 109 110 111 |
# File 'lib/sidekiq-scheduler/schedule.rb', line 104 def set_schedule(name, config) existing_config = get_schedule(name) unless existing_config && existing_config == config SidekiqScheduler::RedisManager.set_job_schedule(name, config) SidekiqScheduler::RedisManager.add_schedule_change(name) end config end |