-
Notifications
You must be signed in to change notification settings - Fork 56
/
Pg.pm
1071 lines (652 loc) · 24.5 KB
/
Pg.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package Minion::Backend::Pg;
use Mojo::Base 'Minion::Backend';
use Carp qw(croak);
use Mojo::File qw(path);
use Mojo::IOLoop;
use Mojo::Pg 4.0;
use Sys::Hostname qw(hostname);
has 'pg';
sub broadcast {
my ($self, $command, $args, $ids) = (shift, shift, shift || [], shift || []);
return !!$self->pg->db->query(
q{UPDATE minion_workers SET inbox = inbox || $1::JSONB WHERE (id = ANY ($2) OR $2 = '{}')},
{json => [[$command, @$args]]}, $ids)->rows;
}
sub dequeue {
my ($self, $id, $wait, $options) = @_;
if ((my $job = $self->_try($id, $options))) { return $job }
return undef if Mojo::IOLoop->is_running;
my $db = $self->pg->db;
$db->listen('minion.job')->on(notification => sub { Mojo::IOLoop->stop });
my $timer = Mojo::IOLoop->timer($wait => sub { Mojo::IOLoop->stop });
Mojo::IOLoop->start;
$db->unlisten('*') and Mojo::IOLoop->remove($timer);
undef $db;
return $self->_try($id, $options);
}
sub enqueue {
my ($self, $task, $args, $options) = (shift, shift, shift || [], shift || {});
return $self->pg->db->query(
q{INSERT INTO minion_jobs (args, attempts, delayed, expires, lax, notes, parents, priority, queue, task)
VALUES ($1, $2, (NOW() + (INTERVAL '1 second' * $3)),
CASE WHEN $4::BIGINT IS NOT NULL THEN NOW() + (INTERVAL '1 second' * $4::BIGINT) END, $5, $6, $7, $8, $9, $10)
RETURNING id}, {json => $args}, $options->{attempts} // 1, $options->{delay} // 0, $options->{expire},
$options->{lax} ? 1 : 0, {json => $options->{notes} || {}}, $options->{parents} || [], $options->{priority} // 0,
$options->{queue} // 'default', $task
)->hash->{id};
}
sub fail_job { shift->_update(1, @_) }
sub finish_job { shift->_update(0, @_) }
sub history {
my $self = shift;
my $daily = $self->pg->db->query(
"SELECT EXTRACT(EPOCH FROM ts) AS epoch, COALESCE(failed_jobs, 0) AS failed_jobs,
COALESCE(finished_jobs, 0) AS finished_jobs
FROM (
SELECT EXTRACT (DAY FROM finished) AS day, EXTRACT(HOUR FROM finished) AS hour,
COUNT(*) FILTER (WHERE state = 'failed') AS failed_jobs,
COUNT(*) FILTER (WHERE state = 'finished') AS finished_jobs
FROM minion_jobs
WHERE finished > NOW() - INTERVAL '23 hours'
GROUP BY day, hour
) AS j RIGHT OUTER JOIN (
SELECT *
FROM GENERATE_SERIES(NOW() - INTERVAL '23 hour', NOW(), '1 hour') AS ts
) AS s ON EXTRACT(HOUR FROM ts) = j.hour AND EXTRACT(DAY FROM ts) = j.day
ORDER BY epoch ASC"
)->hashes->to_array;
return {daily => $daily};
}
sub list_jobs {
my ($self, $offset, $limit, $options) = @_;
my $jobs = $self->pg->db->query(
q{SELECT id, args, attempts,
ARRAY(SELECT id FROM minion_jobs WHERE parents @> ARRAY[j.id]) AS children,
EXTRACT(epoch FROM created) AS created, EXTRACT(EPOCH FROM delayed) AS delayed,
EXTRACT(EPOCH FROM expires) AS expires, EXTRACT(EPOCH FROM finished) AS finished, lax, notes, parents, priority,
queue, result, EXTRACT(EPOCH FROM retried) AS retried, retries, EXTRACT(EPOCH FROM started) AS started, state,
task, EXTRACT(EPOCH FROM now()) AS time, COUNT(*) OVER() AS total, worker
FROM minion_jobs AS j
WHERE (id < $1 OR $1 IS NULL) AND (id = ANY ($2) OR $2 IS NULL) AND (notes \? ANY ($3) OR $3 IS NULL)
AND (queue = ANY ($4) OR $4 IS null) AND (state = ANY ($5) OR $5 IS NULL) AND (task = ANY ($6) OR $6 IS NULL)
AND (state != 'inactive' OR expires IS null OR expires > NOW())
ORDER BY id DESC
LIMIT $7 OFFSET $8}, @$options{qw(before ids notes queues states tasks)}, $limit, $offset
)->expand->hashes->to_array;
return _total('jobs', $jobs);
}
sub list_locks {
my ($self, $offset, $limit, $options) = @_;
my $locks = $self->pg->db->query(
'SELECT id, name, EXTRACT(EPOCH FROM expires) AS expires, COUNT(*) OVER() AS total FROM minion_locks
WHERE expires > NOW() AND (name = ANY ($1) OR $1 IS NULL)
ORDER BY id DESC LIMIT $2 OFFSET $3', $options->{names}, $limit, $offset
)->hashes->to_array;
return _total('locks', $locks);
}
sub list_workers {
my ($self, $offset, $limit, $options) = @_;
my $workers = $self->pg->db->query(
"SELECT id, EXTRACT(EPOCH FROM notified) AS notified, ARRAY(
SELECT id FROM minion_jobs WHERE state = 'active' AND worker = minion_workers.id
) AS jobs, host, pid, status, EXTRACT(EPOCH FROM started) AS started,
COUNT(*) OVER() AS total
FROM minion_workers
WHERE (id < \$1 OR \$1 IS NULL) AND (id = ANY (\$2) OR \$2 IS NULL)
ORDER BY id DESC LIMIT \$3 OFFSET \$4", @$options{qw(before ids)}, $limit, $offset
)->expand->hashes->to_array;
return _total('workers', $workers);
}
sub lock {
my ($self, $name, $duration, $options) = (shift, shift, shift, shift // {});
return !!$self->pg->db->query('SELECT * FROM minion_lock(?, ?, ?)', $name, $duration, $options->{limit} || 1)
->array->[0];
}
sub new {
my $self = shift->SUPER::new(pg => Mojo::Pg->new(@_));
my $db = Mojo::Pg->new(@_)->db;
croak 'PostgreSQL 9.5 or later is required' if $db->dbh->{pg_server_version} < 90500;
$db->disconnect;
my $schema = path(__FILE__)->dirname->child('resources', 'migrations', 'pg.sql');
$self->pg->auto_migrate(1)->migrations->name('minion')->from_file($schema);
return $self;
}
sub note {
my ($self, $id, $merge) = @_;
return !!$self->pg->db->query('UPDATE minion_jobs SET notes = JSONB_STRIP_NULLS(notes || ?) WHERE id = ?',
{json => $merge}, $id)->rows;
}
sub receive {
my $array = shift->pg->db->query(
"UPDATE minion_workers AS new SET inbox = '[]'
FROM (SELECT id, inbox FROM minion_workers WHERE id = ? FOR UPDATE) AS old
WHERE new.id = old.id AND old.inbox != '[]'
RETURNING old.inbox", shift
)->expand->array;
return $array ? $array->[0] : [];
}
sub register_worker {
my ($self, $id, $options) = (shift, shift, shift || {});
return $self->pg->db->query(
q{INSERT INTO minion_workers (id, host, pid, status)
VALUES (COALESCE($1, NEXTVAL('minion_workers_id_seq')), $2, $3, $4)
ON CONFLICT(id) DO UPDATE SET notified = now(), status = $4
RETURNING id}, $id, $self->{host} //= hostname, $$, {json => $options->{status} // {}}
)->hash->{id};
}
sub remove_job {
my ($self, $id) = @_;
return !!$self->pg->db->query(
"DELETE FROM minion_jobs WHERE id = ? AND state IN ('inactive', 'failed', 'finished') RETURNING 1", $id)->rows;
}
sub repair {
my $self = shift;
# Workers without heartbeat
my $db = $self->pg->db;
my $minion = $self->minion;
$db->query("DELETE FROM minion_workers WHERE notified < NOW() - INTERVAL '1 second' * ?", $minion->missing_after);
# Old jobs
$db->query("DELETE FROM minion_jobs WHERE state = 'finished' AND finished <= NOW() - INTERVAL '1 second' * ?",
$minion->remove_after);
# Expired jobs
$db->query("DELETE FROM minion_jobs WHERE state = 'inactive' AND expires <= NOW()");
# Jobs with missing worker (can be retried)
$db->query(
"SELECT id, retries FROM minion_jobs AS j
WHERE state = 'active' AND queue != 'minion_foreground'
AND NOT EXISTS (SELECT 1 FROM minion_workers WHERE id = j.worker)"
)->hashes->each(sub { $self->fail_job(@$_{qw(id retries)}, 'Worker went away') });
# Jobs in queue without workers or not enough workers (cannot be retried and requires admin attention)
$db->query(
q{UPDATE minion_jobs SET state = 'failed', result = '"Job appears stuck in queue"'
WHERE state = 'inactive' AND delayed + ? * INTERVAL '1 second' < NOW()}, $minion->stuck_after
);
}
sub reset {
my ($self, $options) = (shift, shift // {});
if ($options->{all}) { $self->pg->db->query('TRUNCATE minion_jobs, minion_locks, minion_workers RESTART IDENTITY') }
elsif ($options->{locks}) { $self->pg->db->query('TRUNCATE minion_locks') }
}
sub retry_job {
my ($self, $id, $retries, $options) = (shift, shift, shift, shift || {});
return !!$self->pg->db->query(
q{UPDATE minion_jobs SET attempts = COALESCE($1, attempts), delayed = (NOW() + (INTERVAL '1 second' * $2)),
expires = CASE WHEN $3::BIGINT IS NOT NULL THEN NOW() + (INTERVAL '1 second' * $3::BIGINT) ELSE expires END,
lax = COALESCE($4, lax), parents = COALESCE($5, parents), priority = COALESCE($6, priority),
queue = COALESCE($7, queue), retried = NOW(), retries = retries + 1, state = 'inactive'
WHERE id = $8 AND retries = $9
RETURNING 1}, $options->{attempts}, $options->{delay} // 0, $options->{expire},
exists $options->{lax} ? $options->{lax} ? 1 : 0 : undef, @$options{qw(parents priority queue)}, $id, $retries
)->rows;
}
sub stats {
my $self = shift;
my $stats = $self->pg->db->query(
"SELECT
(SELECT COUNT(*) FROM minion_jobs WHERE state = 'inactive' AND (expires IS NULL OR expires > NOW())) AS inactive_jobs,
(SELECT COUNT(*) FROM minion_jobs WHERE state = 'active') AS active_jobs,
(SELECT COUNT(*) FROM minion_jobs WHERE state = 'failed') AS failed_jobs,
(SELECT COUNT(*) FROM minion_jobs WHERE state = 'finished') AS finished_jobs,
(SELECT COUNT(*) FROM minion_jobs WHERE state = 'inactive' AND delayed > NOW()) AS delayed_jobs,
(SELECT COUNT(*) FROM minion_locks WHERE expires > NOW()) AS active_locks,
(SELECT COUNT(DISTINCT worker) FROM minion_jobs mj WHERE state = 'active') AS active_workers,
(SELECT CASE WHEN is_called THEN last_value ELSE 0 END FROM minion_jobs_id_seq) AS enqueued_jobs,
(SELECT COUNT(*) FROM minion_workers) AS workers,
EXTRACT(EPOCH FROM NOW() - PG_POSTMASTER_START_TIME()) AS uptime"
)->hash;
$stats->{inactive_workers} = $stats->{workers} - $stats->{active_workers};
return $stats;
}
sub unlock {
!!shift->pg->db->query(
'DELETE FROM minion_locks WHERE id = (
SELECT id FROM minion_locks WHERE expires > NOW() AND name = ? ORDER BY expires LIMIT 1 FOR UPDATE
) RETURNING 1', shift
)->rows;
}
sub unregister_worker { shift->pg->db->query('DELETE FROM minion_workers WHERE id = ?', shift) }
sub _total {
my ($name, $results) = @_;
my $total = @$results ? $results->[0]{total} : 0;
delete $_->{total} for @$results;
return {total => $total, $name => $results};
}
sub _try {
my ($self, $id, $options) = @_;
return $self->pg->db->query(
q{UPDATE minion_jobs SET started = NOW(), state = 'active', worker = ?
WHERE id = (
SELECT id FROM minion_jobs AS j
WHERE delayed <= NOW() AND id = COALESCE(?, id) AND (parents = '{}' OR NOT EXISTS (
SELECT 1 FROM minion_jobs WHERE id = ANY (j.parents) AND (
state = 'active' OR (state = 'failed' AND NOT j.lax)
OR (state = 'inactive' AND (expires IS NULL OR expires > NOW())))
)) AND priority >= COALESCE(?, priority) AND queue = ANY (?) AND state = 'inactive' AND task = ANY (?)
AND (EXPIRES IS NULL OR expires > NOW())
ORDER BY priority DESC, id
LIMIT 1
FOR UPDATE SKIP LOCKED
)
RETURNING id, args, retries, task}, $id, $options->{id}, $options->{min_priority},
$options->{queues} || ['default'], [keys %{$self->minion->tasks}]
)->expand->hash;
}
sub _update {
my ($self, $fail, $id, $retries, $result) = @_;
return undef unless my $row = $self->pg->db->query(
"UPDATE minion_jobs SET finished = NOW(), result = ?, state = ?
WHERE id = ? AND retries = ? AND state = 'active'
RETURNING attempts", {json => $result}, $fail ? 'failed' : 'finished', $id, $retries
)->array;
return $fail ? $self->auto_retry_job($id, $retries, $row->[0]) : 1;
}
1;
=encoding utf8
=head1 NAME
Minion::Backend::Pg - PostgreSQL backend
=head1 SYNOPSIS
use Minion::Backend::Pg;
my $backend = Minion::Backend::Pg->new('postgresql://postgres@/test');
=head1 DESCRIPTION
L<Minion::Backend::Pg> is a backend for L<Minion> based on L<Mojo::Pg>. All necessary tables will be created
automatically with a set of migrations named C<minion>. Note that this backend uses many bleeding edge features, so
only the latest, stable version of PostgreSQL is fully supported.
=head1 ATTRIBUTES
L<Minion::Backend::Pg> inherits all attributes from L<Minion::Backend> and implements the following new ones.
=head2 pg
my $pg = $backend->pg;
$backend = $backend->pg(Mojo::Pg->new);
L<Mojo::Pg> object used to store all data.
=head1 METHODS
L<Minion::Backend::Pg> inherits all methods from L<Minion::Backend> and implements the following new ones.
=head2 broadcast
my $bool = $backend->broadcast('some_command');
my $bool = $backend->broadcast('some_command', [@args]);
my $bool = $backend->broadcast('some_command', [@args], [$id1, $id2, $id3]);
Broadcast remote control command to one or more workers.
=head2 dequeue
my $job_info = $backend->dequeue($worker_id, 0.5);
my $job_info = $backend->dequeue($worker_id, 0.5, {queues => ['important']});
Wait a given amount of time in seconds for a job, dequeue it and transition from C<inactive> to C<active> state, or
return C<undef> if queues were empty.
These options are currently available:
=over 2
=item id
id => '10023'
Dequeue a specific job.
=item min_priority
min_priority => 3
Do not dequeue jobs with a lower priority.
=item queues
queues => ['important']
One or more queues to dequeue jobs from, defaults to C<default>.
=back
These fields are currently available:
=over 2
=item args
args => ['foo', 'bar']
Job arguments.
=item id
id => '10023'
Job ID.
=item retries
retries => 3
Number of times job has been retried.
=item task
task => 'foo'
Task name.
=back
=head2 enqueue
my $job_id = $backend->enqueue('foo');
my $job_id = $backend->enqueue(foo => [@args]);
my $job_id = $backend->enqueue(foo => [@args] => {priority => 1});
Enqueue a new job with C<inactive> state.
These options are currently available:
=over 2
=item attempts
attempts => 25
Number of times performing this job will be attempted, with a delay based on L<Minion/"backoff"> after the first
attempt, defaults to C<1>.
=item delay
delay => 10
Delay job for this many seconds (from now), defaults to C<0>.
=item expire
expire => 300
Job is valid for this many seconds (from now) before it expires.
=item lax
lax => 1
Existing jobs this job depends on may also have transitioned to the C<failed> state to allow for it to be processed,
defaults to C<false>. Note that this option is B<EXPERIMENTAL> and might change without warning!
=item notes
notes => {foo => 'bar', baz => [1, 2, 3]}
Hash reference with arbitrary metadata for this job.
=item parents
parents => [$id1, $id2, $id3]
One or more existing jobs this job depends on, and that need to have transitioned to the state C<finished> before it
can be processed.
=item priority
priority => 5
Job priority, defaults to C<0>. Jobs with a higher priority get performed first. Priorities can be positive or negative,
but should be in the range between C<100> and C<-100>.
=item queue
queue => 'important'
Queue to put job in, defaults to C<default>.
=back
=head2 fail_job
my $bool = $backend->fail_job($job_id, $retries);
my $bool = $backend->fail_job($job_id, $retries, 'Something went wrong!');
my $bool = $backend->fail_job(
$job_id, $retries, {whatever => 'Something went wrong!'});
Transition from C<active> to C<failed> state with or without a result, and if there are attempts remaining, transition
back to C<inactive> with a delay based on L<Minion/"backoff">.
=head2 finish_job
my $bool = $backend->finish_job($job_id, $retries);
my $bool = $backend->finish_job($job_id, $retries, 'All went well!');
my $bool = $backend->finish_job(
$job_id, $retries, {whatever => 'All went well!'});
Transition from C<active> to C<finished> state with or without a result.
=head2 history
my $history = $backend->history;
Get history information for job queue.
These fields are currently available:
=over 2
=item daily
daily => [{epoch => 12345, finished_jobs => 95, failed_jobs => 2}, ...]
Hourly counts for processed jobs from the past day.
=back
=head2 list_jobs
my $results = $backend->list_jobs($offset, $limit);
my $results = $backend->list_jobs($offset, $limit, {states => ['inactive']});
Returns the information about jobs in batches.
# Get the total number of results (without limit)
my $num = $backend->list_jobs(0, 100, {queues => ['important']})->{total};
# Check job state
my $results = $backend->list_jobs(0, 1, {ids => [$job_id]});
my $state = $results->{jobs}[0]{state};
# Get job result
my $results = $backend->list_jobs(0, 1, {ids => [$job_id]});
my $result = $results->{jobs}[0]{result};
These options are currently available:
=over 2
=item before
before => 23
List only jobs before this id.
=item ids
ids => ['23', '24']
List only jobs with these ids.
=item notes
notes => ['foo', 'bar']
List only jobs with one of these notes.
=item queues
queues => ['important', 'unimportant']
List only jobs in these queues.
=item states
states => ['inactive', 'active']
List only jobs in these states.
=item tasks
tasks => ['foo', 'bar']
List only jobs for these tasks.
=back
These fields are currently available:
=over 2
=item args
args => ['foo', 'bar']
Job arguments.
=item attempts
attempts => 25
Number of times performing this job will be attempted.
=item children
children => ['10026', '10027', '10028']
Jobs depending on this job.
=item created
created => 784111777
Epoch time job was created.
=item delayed
delayed => 784111777
Epoch time job was delayed to.
=item expires
expires => 784111777
Epoch time job is valid until before it expires.
=item finished
finished => 784111777
Epoch time job was finished.
=item id
id => 10025
Job id.
=item lax
lax => 0
Existing jobs this job depends on may also have failed to allow for it to be processed.
=item notes
notes => {foo => 'bar', baz => [1, 2, 3]}
Hash reference with arbitrary metadata for this job.
=item parents
parents => ['10023', '10024', '10025']
Jobs this job depends on.
=item priority
priority => 3
Job priority.
=item queue
queue => 'important'
Queue name.
=item result
result => 'All went well!'
Job result.
=item retried
retried => 784111777
Epoch time job has been retried.
=item retries
retries => 3
Number of times job has been retried.
=item started
started => 784111777
Epoch time job was started.
=item state
state => 'inactive'
Current job state, usually C<active>, C<failed>, C<finished> or C<inactive>.
=item task
task => 'foo'
Task name.
=item time
time => 78411177
Server time.
=item worker
worker => '154'
Id of worker that is processing the job.
=back
=head2 list_locks
my $results = $backend->list_locks($offset, $limit);
my $results = $backend->list_locks($offset, $limit, {names => ['foo']});
Returns information about locks in batches.
# Get the total number of results (without limit)
my $num = $backend->list_locks(0, 100, {names => ['bar']})->{total};
# Check expiration time
my $results = $backend->list_locks(0, 1, {names => ['foo']});
my $expires = $results->{locks}[0]{expires};
These options are currently available:
=over 2
=item names
names => ['foo', 'bar']
List only locks with these names.
=back
These fields are currently available:
=over 2
=item expires
expires => 784111777
Epoch time this lock will expire.
=item id
id => 1
Lock id.
=item name
name => 'foo'
Lock name.
=back
=head2 list_workers
my $results = $backend->list_workers($offset, $limit);
my $results = $backend->list_workers($offset, $limit, {ids => [23]});
Returns information about workers in batches.
# Get the total number of results (without limit)
my $num = $backend->list_workers(0, 100)->{total};
# Check worker host
my $results = $backend->list_workers(0, 1, {ids => [$worker_id]});
my $host = $results->{workers}[0]{host};
These options are currently available:
=over 2
=item before
before => 23
List only workers before this id.
=item ids
ids => ['23', '24']
List only workers with these ids.
=back
These fields are currently available:
=over 2
=item id
id => 22
Worker id.
=item host
host => 'localhost'
Worker host.
=item jobs
jobs => ['10023', '10024', '10025', '10029']
Ids of jobs the worker is currently processing.
=item notified
notified => 784111777
Epoch time worker sent the last heartbeat.
=item pid
pid => 12345
Process id of worker.
=item started
started => 784111777
Epoch time worker was started.
=item status
status => {queues => ['default', 'important']}
Hash reference with whatever status information the worker would like to share.
=back
=head2 lock
my $bool = $backend->lock('foo', 3600);
my $bool = $backend->lock('foo', 3600, {limit => 20});
Try to acquire a named lock that will expire automatically after the given amount of time in seconds. An expiration
time of C<0> can be used to check if a named lock already exists without creating one.
These options are currently available:
=over 2
=item limit
limit => 20
Number of shared locks with the same name that can be active at the same time, defaults to C<1>.
=back
=head2 new
my $backend = Minion::Backend::Pg->new('postgresql://postgres@/test');
my $backend = Minion::Backend::Pg->new(Mojo::Pg->new);
Construct a new L<Minion::Backend::Pg> object.
=head2 note
my $bool = $backend->note($job_id, {mojo => 'rocks', minion => 'too'});
Change one or more metadata fields for a job. Setting a value to C<undef> will remove the field.
=head2 receive
my $commands = $backend->receive($worker_id);
Receive remote control commands for worker.
=head2 register_worker
my $worker_id = $backend->register_worker;
my $worker_id = $backend->register_worker($worker_id);
my $worker_id = $backend->register_worker(
$worker_id, {status => {queues => ['default', 'important']}});
Register worker or send heartbeat to show that this worker is still alive.
These options are currently available:
=over 2
=item status
status => {queues => ['default', 'important']}
Hash reference with whatever status information the worker would like to share.
=back
=head2 remove_job
my $bool = $backend->remove_job($job_id);
Remove C<failed>, C<finished> or C<inactive> job from queue.
=head2 repair
$backend->repair;
Repair worker registry and job queue if necessary.
=head2 reset
$backend->reset({all => 1});
Reset job queue.
These options are currently available:
=over 2
=item all
all => 1
Reset everything.
=item locks
locks => 1
Reset only locks.
=back
=head2 retry_job
my $bool = $backend->retry_job($job_id, $retries);
my $bool = $backend->retry_job($job_id, $retries, {delay => 10});
Transition job back to C<inactive> state, already C<inactive> jobs may also be retried to change options.
These options are currently available:
=over 2
=item attempts
attempts => 25
Number of times performing this job will be attempted.
=item delay
delay => 10
Delay job for this many seconds (from now), defaults to C<0>.
=item expire
expire => 300
Job is valid for this many seconds (from now) before it expires.
=item lax
lax => 1
Existing jobs this job depends on may also have transitioned to the C<failed> state to allow for it to be processed,
defaults to C<false>. Note that this option is B<EXPERIMENTAL> and might change without warning!
=item parents
parents => [$id1, $id2, $id3]
Jobs this job depends on.
=item priority
priority => 5
Job priority.
=item queue
queue => 'important'
Queue to put job in.
=back
=head2 stats
my $stats = $backend->stats;
Get statistics for the job queue.
These fields are currently available:
=over 2
=item active_jobs
active_jobs => 100
Number of jobs in C<active> state.
=item active_locks
active_locks => 100
Number of active named locks.
=item active_workers