1Minion::Backend(3) User Contributed Perl Documentation Minion::Backend(3)
2
6 Minion::Backend - Backend base class
7
9 package Minion::Backend::MyBackend;
10 use Mojo::Base 'Minion::Backend';
11 sub broadcast {...}
13 sub dequeue {...}
14 sub enqueue {...}
15 sub fail_job {...}
16 sub finish_job {...}
17 sub history {...}
18 sub list_jobs {...}
19 sub list_locks {...}
20 sub list_workers {...}
21 sub lock {...}
22 sub note {...}
23 sub receive {...}
24 sub register_worker {...}
25 sub remove_job {...}
26 sub repair {...}
27 sub reset {...}
28 sub retry_job {...}
29 sub stats {...}
30 sub unlock {...}
31 sub unregister_worker {...}
32
34 Minion::Backend is an abstract base class for Minion backends, like
35 Minion::Backend::Pg.
36
38 Minion::Backend implements the following attributes.
39 minion
41 my $minion = $backend->minion;
42 $backend = $backend->minion(Minion->new);
43 Minion object this backend belongs to. Note that this attribute is
45 weakened.
46
48 Minion::Backend inherits all methods from Mojo::Base and implements the
49 following new ones.
50 broadcast
52 my $bool = $backend->broadcast('some_command');
53 my $bool = $backend->broadcast('some_command', [@args]);
54 my $bool = $backend->broadcast('some_command', [@args], [$id1, $id2, $id3]);
55 Broadcast remote control command to one or more workers. Meant to be
57 overloaded in a subclass.
58 dequeue
60 my $job_info = $backend->dequeue($worker_id, 0.5);
61 my $job_info = $backend->dequeue($worker_id, 0.5, {queues => ['important']});
62 Wait a given amount of time in seconds for a job, dequeue it and
64 transition from "inactive" to "active" state, or return "undef" if
65 queues were empty. Meant to be overloaded in a subclass.
66 These options are currently available:
68 id
70 id => '10023'
71 Dequeue a specific job.
73 queues
75 queues => ['important']
76 One or more queues to dequeue jobs from, defaults to "default".
78 These fields are currently available:
80 args
82 args => ['foo', 'bar']
83 Job arguments.
85 id
87 id => '10023'
88 Job ID.
90 retries
92 retries => 3
93 Number of times job has been retried.
95 task
97 task => 'foo'
98 Task name.
100 enqueue
102 my $job_id = $backend->enqueue('foo');
103 my $job_id = $backend->enqueue(foo => [@args]);
104 my $job_id = $backend->enqueue(foo => [@args] => {priority => 1});
105 Enqueue a new job with "inactive" state. Meant to be overloaded in a
107 subclass.
108 These options are currently available:
110 attempts
112 attempts => 25
113 Number of times performing this job will be attempted, with a delay
115 based on "backoff" in Minion after the first attempt, defaults to 1.
116 delay
118 delay => 10
119 Delay job for this many seconds (from now), defaults to 0.
121 notes
123 notes => {foo => 'bar', baz => [1, 2, 3]}
124 Hash reference with arbitrary metadata for this job.
126 parents
128 parents => [$id1, $id2, $id3]
129 One or more existing jobs this job depends on, and that need to have
131 transitioned to the state "finished" before it can be processed.
132 priority
134 priority => 5
135 Job priority, defaults to 0. Jobs with a higher priority get
137 performed first.
138 queue
140 queue => 'important'
141 Queue to put job in, defaults to "default".
143 fail_job
145 my $bool = $backend->fail_job($job_id, $retries);
146 my $bool = $backend->fail_job($job_id, $retries, 'Something went wrong!');
147 my $bool = $backend->fail_job(
148 $job_id, $retries, {whatever => 'Something went wrong!'});
149 Transition from "active" to "failed" state with or without a result,
151 and if there are attempts remaining, transition back to "inactive" with
152 a delay based on "backoff" in Minion. Meant to be overloaded in a
153 subclass.
154 finish_job
156 my $bool = $backend->finish_job($job_id, $retries);
157 my $bool = $backend->finish_job($job_id, $retries, 'All went well!');
158 my $bool = $backend->finish_job(
159 $job_id, $retries, {whatever => 'All went well!'});
160 Transition from "active" to "finished" state with or without a result.
162 Meant to be overloaded in a subclass.
163 history
165 my $history = $backend->history;
166 Get history information for job queue. Meant to be overloaded in a
168 subclass. Note that this method is EXPERIMENTAL and might change
169 without warning!
170 These fields are currently available:
172 daily
174 daily => [{epoch => 12345, finished_jobs => 95, failed_jobs => 2}, ...]
175 Hourly counts for processed jobs from the past day.
177 list_jobs
179 my $results = $backend->list_jobs($offset, $limit);
180 my $results = $backend->list_jobs($offset, $limit, {states => ['inactive']});
181 Returns the information about jobs in batches. Meant to be overloaded
183 in a subclass.
184 # Get the total number of results (without limit)
186 my $num = $backend->list_jobs(0, 100, {queues => ['important']})->{total};
187 # Check job state
189 my $results = $backend->list_jobs(0, 1, {ids => [$job_id]});
190 my $state = $results->{jobs}[0]{state};
191 # Get job result
193 my $results = $backend->list_jobs(0, 1, {ids => [$job_id]});
194 my $result = $results->{jobs}[0]{result};
195 These options are currently available:
197 ids
199 ids => ['23', '24']
200 List only jobs with these ids.
202 queues
204 queues => ['important', 'unimportant']
205 List only jobs in these queues.
207 states
209 states => ['inactive', 'active']
210 List only jobs in these states.
212 tasks
214 tasks => ['foo', 'bar']
215 List only jobs for these tasks.
217 These fields are currently available:
219 args
221 args => ['foo', 'bar']
222 Job arguments.
224 attempts
226 attempts => 25
227 Number of times performing this job will be attempted.
229 children
231 children => ['10026', '10027', '10028']
232 Jobs depending on this job.
234 created
236 created => 784111777
237 Epoch time job was created.
239 delayed
241 delayed => 784111777
242 Epoch time job was delayed to.
244 finished
246 finished => 784111777
247 Epoch time job was finished.
249 id
251 id => 10025
252 Job id.
254 notes
256 notes => {foo => 'bar', baz => [1, 2, 3]}
257 Hash reference with arbitrary metadata for this job.
259 parents
261 parents => ['10023', '10024', '10025']
262 Jobs this job depends on.
264 priority
266 priority => 3
267 Job priority.
269 queue
271 queue => 'important'
272 Queue name.
274 result
276 result => 'All went well!'
277 Job result.
279 retried
281 retried => 784111777
282 Epoch time job has been retried.
284 retries
286 retries => 3
287 Number of times job has been retried.
289 started
291 started => 784111777
292 Epoch time job was started.
294 state
296 state => 'inactive'
297 Current job state, usually "active", "failed", "finished" or
299 "inactive".
300 task
302 task => 'foo'
303 Task name.
305 worker
307 worker => '154'
308 Id of worker that is processing the job.
310 list_locks
312 my $results = $backend->list_locks($offset, $limit);
313 my $results = $backend->list_locks($offset, $limit, {names => ['foo']});
314 Returns information about locks in batches. Meant to be overloaded in a
316 subclass.
317 # Get the total number of results (without limit)
319 my $num = $backend->list_locks(0, 100, {names => ['bar']})->{total};
320 # Check expiration time
322 my $results = $backend->list_locks(0, 1, {names => ['foo']});
323 my $expires = $results->{locks}[0]{expires};
324 These options are currently available:
326 names
328 names => ['foo', 'bar']
329 List only locks with these names.
331 These fields are currently available:
333 expires
335 expires => 784111777
336 Epoch time this lock will expire.
338 name
340 name => 'foo'
341 Lock name.
343 list_workers
345 my $results = $backend->list_workers($offset, $limit);
346 my $results = $backend->list_workers($offset, $limit, {ids => [23]});
347 Returns information about workers in batches. Meant to be overloaded in
349 a subclass.
350 # Get the total number of results (without limit)
352 my $num = $backend->list_workers(0, 100)->{total};
353 # Check worker host
355 my $results = $backend->list_workers(0, 1, {ids => [$worker_id]});
356 my $host = $results->{workers}[0]{host};
357 These options are currently available:
359 ids
361 ids => ['23', '24']
362 List only workers with these ids.
364 These fields are currently available:
366 id
368 id => 22
369 Worker id.
371 host
373 host => 'localhost'
374 Worker host.
376 jobs
378 jobs => ['10023', '10024', '10025', '10029']
379 Ids of jobs the worker is currently processing.
381 notified
383 notified => 784111777
384 Epoch time worker sent the last heartbeat.
386 pid
388 pid => 12345
389 Process id of worker.
391 started
393 started => 784111777
394 Epoch time worker was started.
396 status
398 status => {queues => ['default', 'important']}
399 Hash reference with whatever status information the worker would like
401 to share.
402 lock
404 my $bool = $backend->lock('foo', 3600);
405 my $bool = $backend->lock('foo', 3600, {limit => 20});
406 Try to acquire a named lock that will expire automatically after the
408 given amount of time in seconds. An expiration time of 0 can be used to
409 check if a named lock already exists without creating one. Meant to be
410 overloaded in a subclass.
411 These options are currently available:
413 limit
415 limit => 20
416 Number of shared locks with the same name that can be active at the
418 same time, defaults to 1.
419 note
421 my $bool = $backend->note($job_id, {mojo => 'rocks', minion => 'too'});
422 Change one or more metadata fields for a job. Meant to be overloaded in
424 a subclass.
425 receive
427 my $commands = $backend->receive($worker_id);
428 Receive remote control commands for worker. Meant to be overloaded in a
430 subclass.
431 register_worker
433 my $worker_id = $backend->register_worker;
434 my $worker_id = $backend->register_worker($worker_id);
435 my $worker_id = $backend->register_worker(
436 $worker_id, {status => {queues => ['default', 'important']}});
437 Register worker or send heartbeat to show that this worker is still
439 alive. Meant to be overloaded in a subclass.
440 These options are currently available:
442 status
444 status => {queues => ['default', 'important']}
445 Hash reference with whatever status information the worker would like
447 to share.
448 remove_job
450 my $bool = $backend->remove_job($job_id);
451 Remove "failed", "finished" or "inactive" job from queue. Meant to be
453 overloaded in a subclass.
454 repair
456 $backend->repair;
457 Repair worker registry and job queue if necessary. Meant to be
459 overloaded in a subclass.
460 reset
462 $backend->reset;
463 Reset job queue. Meant to be overloaded in a subclass.
465 retry_job
467 my $bool = $backend->retry_job($job_id, $retries);
468 my $bool = $backend->retry_job($job_id, $retries, {delay => 10});
469 Transition job back to "inactive" state, already "inactive" jobs may
471 also be retried to change options. Meant to be overloaded in a
472 subclass.
473 These options are currently available:
475 attempts
477 attempts => 25
478 Number of times performing this job will be attempted.
480 delay
482 delay => 10
483 Delay job for this many seconds (from now), defaults to 0.
485 parents
487 parents => [$id1, $id2, $id3]
488 Jobs this job depends on.
490 priority
492 priority => 5
493 Job priority.
495 queue
497 queue => 'important'
498 Queue to put job in.
500 stats
502 my $stats = $backend->stats;
503 Get statistics for the job queue. Meant to be overloaded in a subclass.
505 These fields are currently available:
507 active_jobs
509 active_jobs => 100
510 Number of jobs in "active" state.
512 active_locks
514 active_locks => 100
515 Number of active named locks.
517 active_workers
519 active_workers => 100
520 Number of workers that are currently processing a job.
522 delayed_jobs
524 delayed_jobs => 100
525 Number of jobs in "inactive" state that are scheduled to run at
527 specific time in the future or have unresolved dependencies. Note
528 that this field is EXPERIMENTAL and might change without warning!
529 failed_jobs
531 failed_jobs => 100
532 Number of jobs in "failed" state.
534 finished_jobs
536 finished_jobs => 100
537 Number of jobs in "finished" state.
539 inactive_jobs
541 inactive_jobs => 100
542 Number of jobs in "inactive" state.
544 inactive_workers
546 inactive_workers => 100
547 Number of workers that are currently not processing a job.
549 uptime
551 uptime => 1000
552 Uptime in seconds.
554 unlock
556 my $bool = $backend->unlock('foo');
557 Release a named lock. Meant to be overloaded in a subclass.
559 unregister_worker
561 $backend->unregister_worker($worker_id);
562 Unregister worker. Meant to be overloaded in a subclass.
564
566 Minion, Mojolicious::Guides, <https://mojolicious.org>.
567perl v5.28.1 2019-02-02 Minion::Backend(3)