1Minion::Backend::Pg(3)User Contributed Perl DocumentationMinion::Backend::Pg(3)
2
6 Minion::Backend::Pg - PostgreSQL backend
7
9 use Minion::Backend::Pg;
10 my $backend = Minion::Backend::Pg->new('postgresql://postgres@/test');
12
14 Minion::Backend::Pg is a backend for Minion based on Mojo::Pg. All
15 necessary tables will be created automatically with a set of migrations
16 named "minion". Note that this backend uses many bleeding edge
17 features, so only the latest, stable version of PostgreSQL is fully
18 supported.
19
21 Minion::Backend::Pg inherits all attributes from Minion::Backend and
22 implements the following new ones.
23 pg
25 my $pg = $backend->pg;
26 $backend = $backend->pg(Mojo::Pg->new);
27 Mojo::Pg object used to store all data.
29
31 Minion::Backend::Pg inherits all methods from Minion::Backend and
32 implements the following new ones.
33 broadcast
35 my $bool = $backend->broadcast('some_command');
36 my $bool = $backend->broadcast('some_command', [@args]);
37 my $bool = $backend->broadcast('some_command', [@args], [$id1, $id2, $id3]);
38 Broadcast remote control command to one or more workers.
40 dequeue
42 my $job_info = $backend->dequeue($worker_id, 0.5);
43 my $job_info = $backend->dequeue($worker_id, 0.5, {queues => ['important']});
44 Wait a given amount of time in seconds for a job, dequeue it and
46 transition from "inactive" to "active" state, or return "undef" if
47 queues were empty.
48 These options are currently available:
50 id
52 id => '10023'
53 Dequeue a specific job.
55 queues
57 queues => ['important']
58 One or more queues to dequeue jobs from, defaults to "default".
60 These fields are currently available:
62 args
64 args => ['foo', 'bar']
65 Job arguments.
67 id
69 id => '10023'
70 Job ID.
72 retries
74 retries => 3
75 Number of times job has been retried.
77 task
79 task => 'foo'
80 Task name.
82 enqueue
84 my $job_id = $backend->enqueue('foo');
85 my $job_id = $backend->enqueue(foo => [@args]);
86 my $job_id = $backend->enqueue(foo => [@args] => {priority => 1});
87 Enqueue a new job with "inactive" state.
89 These options are currently available:
91 attempts
93 attempts => 25
94 Number of times performing this job will be attempted, with a delay
96 based on "backoff" in Minion after the first attempt, defaults to 1.
97 delay
99 delay => 10
100 Delay job for this many seconds (from now), defaults to 0.
102 notes
104 notes => {foo => 'bar', baz => [1, 2, 3]}
105 Hash reference with arbitrary metadata for this job.
107 parents
109 parents => [$id1, $id2, $id3]
110 One or more existing jobs this job depends on, and that need to have
112 transitioned to the state "finished" before it can be processed.
113 priority
115 priority => 5
116 Job priority, defaults to 0. Jobs with a higher priority get
118 performed first.
119 queue
121 queue => 'important'
122 Queue to put job in, defaults to "default".
124 fail_job
126 my $bool = $backend->fail_job($job_id, $retries);
127 my $bool = $backend->fail_job($job_id, $retries, 'Something went wrong!');
128 my $bool = $backend->fail_job(
129 $job_id, $retries, {whatever => 'Something went wrong!'});
130 Transition from "active" to "failed" state with or without a result,
132 and if there are attempts remaining, transition back to "inactive" with
133 a delay based on "backoff" in Minion.
134 finish_job
136 my $bool = $backend->finish_job($job_id, $retries);
137 my $bool = $backend->finish_job($job_id, $retries, 'All went well!');
138 my $bool = $backend->finish_job(
139 $job_id, $retries, {whatever => 'All went well!'});
140 Transition from "active" to "finished" state with or without a result.
142 history
144 my $history = $backend->history;
145 Get history information for job queue. Note that this method is
147 EXPERIMENTAL and might change without warning!
148 These fields are currently available:
150 daily
152 daily => [{epoch => 12345, finished_jobs => 95, failed_jobs => 2}, ...]
153 Hourly counts for processed jobs from the past day.
155 list_jobs
157 my $results = $backend->list_jobs($offset, $limit);
158 my $results = $backend->list_jobs($offset, $limit, {states => ['inactive']});
159 Returns the information about jobs in batches.
161 # Get the total number of results (without limit)
163 my $num = $backend->list_jobs(0, 100, {queues => ['important']})->{total};
164 # Check job state
166 my $results = $backend->list_jobs(0, 1, {ids => [$job_id]});
167 my $state = $results->{jobs}[0]{state};
168 # Get job result
170 my $results = $backend->list_jobs(0, 1, {ids => [$job_id]});
171 my $result = $results->{jobs}[0]{result};
172 These options are currently available:
174 ids
176 ids => ['23', '24']
177 List only jobs with these ids.
179 queues
181 queues => ['important', 'unimportant']
182 List only jobs in these queues.
184 states
186 states => ['inactive', 'active']
187 List only jobs in these states.
189 tasks
191 tasks => ['foo', 'bar']
192 List only jobs for these tasks.
194 These fields are currently available:
196 args
198 args => ['foo', 'bar']
199 Job arguments.
201 attempts
203 attempts => 25
204 Number of times performing this job will be attempted.
206 children
208 children => ['10026', '10027', '10028']
209 Jobs depending on this job.
211 created
213 created => 784111777
214 Epoch time job was created.
216 delayed
218 delayed => 784111777
219 Epoch time job was delayed to.
221 finished
223 finished => 784111777
224 Epoch time job was finished.
226 id
228 id => 10025
229 Job id.
231 notes
233 notes => {foo => 'bar', baz => [1, 2, 3]}
234 Hash reference with arbitrary metadata for this job.
236 parents
238 parents => ['10023', '10024', '10025']
239 Jobs this job depends on.
241 priority
243 priority => 3
244 Job priority.
246 queue
248 queue => 'important'
249 Queue name.
251 result
253 result => 'All went well!'
254 Job result.
256 retried
258 retried => 784111777
259 Epoch time job has been retried.
261 retries
263 retries => 3
264 Number of times job has been retried.
266 started
268 started => 784111777
269 Epoch time job was started.
271 state
273 state => 'inactive'
274 Current job state, usually "active", "failed", "finished" or
276 "inactive".
277 task
279 task => 'foo'
280 Task name.
282 worker
284 worker => '154'
285 Id of worker that is processing the job.
287 list_locks
289 my $results = $backend->list_locks($offset, $limit);
290 my $results = $backend->list_locks($offset, $limit, {names => ['foo']});
291 Returns information about locks in batches.
293 # Get the total number of results (without limit)
295 my $num = $backend->list_locks(0, 100, {names => ['bar']})->{total};
296 # Check expiration time
298 my $results = $backend->list_locks(0, 1, {names => ['foo']});
299 my $expires = $results->{locks}[0]{expires};
300 These options are currently available:
302 names
304 names => ['foo', 'bar']
305 List only locks with these names.
307 These fields are currently available:
309 expires
311 expires => 784111777
312 Epoch time this lock will expire.
314 name
316 name => 'foo'
317 Lock name.
319 list_workers
321 my $results = $backend->list_workers($offset, $limit);
322 my $results = $backend->list_workers($offset, $limit, {ids => [23]});
323 Returns information about workers in batches.
325 # Get the total number of results (without limit)
327 my $num = $backend->list_workers(0, 100)->{total};
328 # Check worker host
330 my $results = $backend->list_workers(0, 1, {ids => [$worker_id]});
331 my $host = $results->{workers}[0]{host};
332 These options are currently available:
334 ids
336 ids => ['23', '24']
337 List only workers with these ids.
339 These fields are currently available:
341 id
343 id => 22
344 Worker id.
346 host
348 host => 'localhost'
349 Worker host.
351 jobs
353 jobs => ['10023', '10024', '10025', '10029']
354 Ids of jobs the worker is currently processing.
356 notified
358 notified => 784111777
359 Epoch time worker sent the last heartbeat.
361 pid
363 pid => 12345
364 Process id of worker.
366 started
368 started => 784111777
369 Epoch time worker was started.
371 status
373 status => {queues => ['default', 'important']}
374 Hash reference with whatever status information the worker would like
376 to share.
377 lock
379 my $bool = $backend->lock('foo', 3600);
380 my $bool = $backend->lock('foo', 3600, {limit => 20});
381 Try to acquire a named lock that will expire automatically after the
383 given amount of time in seconds. An expiration time of 0 can be used to
384 check if a named lock already exists without creating one.
385 These options are currently available:
387 limit
389 limit => 20
390 Number of shared locks with the same name that can be active at the
392 same time, defaults to 1.
393 new
395 my $backend = Minion::Backend::Pg->new('postgresql://postgres@/test');
396 my $backend = Minion::Backend::Pg->new(Mojo::Pg->new);
397 Construct a new Minion::Backend::Pg object.
399 note
401 my $bool = $backend->note($job_id, {mojo => 'rocks', minion => 'too'});
402 Change one or more metadata fields for a job.
404 receive
406 my $commands = $backend->receive($worker_id);
407 Receive remote control commands for worker.
409 register_worker
411 my $worker_id = $backend->register_worker;
412 my $worker_id = $backend->register_worker($worker_id);
413 my $worker_id = $backend->register_worker(
414 $worker_id, {status => {queues => ['default', 'important']}});
415 Register worker or send heartbeat to show that this worker is still
417 alive.
418 These options are currently available:
420 status
422 status => {queues => ['default', 'important']}
423 Hash reference with whatever status information the worker would like
425 to share.
426 remove_job
428 my $bool = $backend->remove_job($job_id);
429 Remove "failed", "finished" or "inactive" job from queue.
431 repair
433 $backend->repair;
434 Repair worker registry and job queue if necessary.
436 reset
438 $backend->reset;
439 Reset job queue.
441 retry_job
443 my $bool = $backend->retry_job($job_id, $retries);
444 my $bool = $backend->retry_job($job_id, $retries, {delay => 10});
445 Transition job back to "inactive" state, already "inactive" jobs may
447 also be retried to change options.
448 These options are currently available:
450 attempts
452 attempts => 25
453 Number of times performing this job will be attempted.
455 delay
457 delay => 10
458 Delay job for this many seconds (from now), defaults to 0.
460 parents
462 parents => [$id1, $id2, $id3]
463 Jobs this job depends on.
465 priority
467 priority => 5
468 Job priority.
470 queue
472 queue => 'important'
473 Queue to put job in.
475 stats
477 my $stats = $backend->stats;
478 Get statistics for the job queue.
480 These fields are currently available:
482 active_jobs
484 active_jobs => 100
485 Number of jobs in "active" state.
487 active_locks
489 active_locks => 100
490 Number of active named locks.
492 active_workers
494 active_workers => 100
495 Number of workers that are currently processing a job.
497 delayed_jobs
499 delayed_jobs => 100
500 Number of jobs in "inactive" state that are scheduled to run at
502 specific time in the future. Note that this field is EXPERIMENTAL and
503 might change without warning!
504 enqueued_jobs
506 enqueued_jobs => 100000
507 Rough estimate of how many jobs have ever been enqueued. Note that
509 this field is EXPERIMENTAL and might change without warning!
510 failed_jobs
512 failed_jobs => 100
513 Number of jobs in "failed" state.
515 finished_jobs
517 finished_jobs => 100
518 Number of jobs in "finished" state.
520 inactive_jobs
522 inactive_jobs => 100
523 Number of jobs in "inactive" state.
525 inactive_workers
527 inactive_workers => 100
528 Number of workers that are currently not processing a job.
530 uptime
532 uptime => 1000
533 Uptime in seconds.
535 unlock
537 my $bool = $backend->unlock('foo');
538 Release a named lock.
540 unregister_worker
542 $backend->unregister_worker($worker_id);
543 Unregister worker.
545
547 Minion, Mojolicious::Guides, <https://mojolicious.org>.
548perl v5.28.1 2019-02-02 Minion::Backend::Pg(3)