| Minion::Backend::Pg(3pm) | User Contributed Perl Documentation | Minion::Backend::Pg(3pm) |
Minion::Backend::Pg - PostgreSQL backend
use Minion::Backend::Pg;
my $backend = Minion::Backend::Pg->new('postgresql://postgres@/test');
Minion::Backend::Pg is a backend for Minion based on Mojo::Pg. All necessary tables will be created automatically with a set of migrations named "minion". Note that this backend uses many bleeding edge features, so only the latest, stable version of PostgreSQL is fully supported.
Minion::Backend::Pg inherits all attributes from Minion::Backend and implements the following new ones.
my $pg = $backend->pg; $backend = $backend->pg(Mojo::Pg->new);
Mojo::Pg object used to store all data.
Minion::Backend::Pg inherits all methods from Minion::Backend and implements the following new ones.
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.
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 "inactive" to "active" state, or return "undef" if queues were empty.
These options are currently available:
id => '10023'
Dequeue a specific job.
min_priority => 3
Do not dequeue jobs with a lower priority.
queues => ['important']
One or more queues to dequeue jobs from, defaults to "default".
These fields are currently available:
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 "inactive" state.
These options are currently available:
attempts => 25
Number of times performing this job will be attempted, with a delay based on "backoff" in Minion after the first attempt, defaults to 1.
delay => 10
Delay job for this many seconds (from now), defaults to 0.
expire => 300
Job is valid for this many seconds (from now) before it expires. Note that this option is EXPERIMENTAL and might change without warning!
lax => 1
Existing jobs this job depends on may also have transitioned to the "failed" state to allow for it to be processed, defaults to "false". Note that this option is EXPERIMENTAL and might change without warning!
notes => {foo => 'bar', baz => [1, 2, 3]}
Hash reference with arbitrary metadata for this job.
parents => [$id1, $id2, $id3]
One or more existing jobs this job depends on, and that need to have transitioned to the state "finished" before it can be processed.
priority => 5
Job priority, defaults to 0. Jobs with a higher priority get performed first. Priorities can be positive or negative, but should be in the range between 100 and "-100".
queue => 'important'
Queue to put job in, defaults to "default".
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 "active" to "failed" state with or without a result, and if there are attempts remaining, transition back to "inactive" with a delay based on "backoff" in Minion.
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 "active" to "finished" state with or without a result.
my $history = $backend->history;
Get history information for job queue.
These fields are currently available:
daily => [{epoch => 12345, finished_jobs => 95, failed_jobs => 2}, ...]
Hourly counts for processed jobs from the past day.
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:
before => 23
List only jobs before this id.
ids => ['23', '24']
List only jobs with these ids.
notes => ['foo', 'bar']
List only jobs with one of these notes.
queues => ['important', 'unimportant']
List only jobs in these queues.
states => ['inactive', 'active']
List only jobs in these states.
tasks => ['foo', 'bar']
List only jobs for these tasks.
These fields are currently available:
args => ['foo', 'bar']
Job arguments.
attempts => 25
Number of times performing this job will be attempted.
children => ['10026', '10027', '10028']
Jobs depending on this job.
created => 784111777
Epoch time job was created.
delayed => 784111777
Epoch time job was delayed to.
expires => 784111777
Epoch time job is valid until before it expires.
finished => 784111777
Epoch time job was finished.
id => 10025
Job id.
lax => 0
Existing jobs this job depends on may also have failed to allow for it to be processed.
notes => {foo => 'bar', baz => [1, 2, 3]}
Hash reference with arbitrary metadata for this job.
parents => ['10023', '10024', '10025']
Jobs this job depends on.
priority => 3
Job priority.
queue => 'important'
Queue name.
result => 'All went well!'
Job result.
retried => 784111777
Epoch time job has been retried.
retries => 3
Number of times job has been retried.
started => 784111777
Epoch time job was started.
state => 'inactive'
Current job state, usually "active", "failed", "finished" or "inactive".
task => 'foo'
Task name.
time => 78411177
Server time.
worker => '154'
Id of worker that is processing the job.
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:
names => ['foo', 'bar']
List only locks with these names.
These fields are currently available:
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:
before => 23
List only workers before this id.
ids => ['23', '24']
List only workers with these ids.
These fields are currently available:
id => 22
Worker id.
host => 'localhost'
Worker host.
jobs => ['10023', '10024', '10025', '10029']
Ids of jobs the worker is currently processing.
notified => 784111777
Epoch time worker sent the last heartbeat.
pid => 12345
Process id of worker.
started => 784111777
Epoch time worker was started.
status => {queues => ['default', 'important']}
Hash reference with whatever status information the worker would like to share.
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 0 can be used to check if a named lock already exists without creating one.
These options are currently available:
limit => 20
Number of shared locks with the same name that can be active at the same time, defaults to 1.
my $backend = Minion::Backend::Pg->new('postgresql://postgres@/test');
my $backend = Minion::Backend::Pg->new(Mojo::Pg->new);
Construct a new Minion::Backend::Pg object.
my $bool = $backend->note($job_id, {mojo => 'rocks', minion => 'too'});
Change one or more metadata fields for a job. Setting a value to "undef" will remove the field.
my $commands = $backend->receive($worker_id);
Receive remote control commands for 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:
status => {queues => ['default', 'important']}
Hash reference with whatever status information the worker would like to share.
my $bool = $backend->remove_job($job_id);
Remove "failed", "finished" or "inactive" job from queue.
$backend->repair;
Repair worker registry and job queue if necessary.
$backend->reset({all => 1});
Reset job queue.
These options are currently available:
my $bool = $backend->retry_job($job_id, $retries);
my $bool = $backend->retry_job($job_id, $retries, {delay => 10});
Transition job back to "inactive" state, already "inactive" jobs may also be retried to change options.
These options are currently available:
attempts => 25
Number of times performing this job will be attempted.
delay => 10
Delay job for this many seconds (from now), defaults to 0.
expire => 300
Job is valid for this many seconds (from now) before it expires. Note that this option is EXPERIMENTAL and might change without warning!
lax => 1
Existing jobs this job depends on may also have transitioned to the "failed" state to allow for it to be processed, defaults to "false". Note that this option is EXPERIMENTAL and might change without warning!
parents => [$id1, $id2, $id3]
Jobs this job depends on.
priority => 5
Job priority.
queue => 'important'
Queue to put job in.
my $stats = $backend->stats;
Get statistics for the job queue.
These fields are currently available:
active_jobs => 100
Number of jobs in "active" state.
active_locks => 100
Number of active named locks.
active_workers => 100
Number of workers that are currently processing a job.
delayed_jobs => 100
Number of jobs in "inactive" state that are scheduled to run at specific time in the future.
enqueued_jobs => 100000
Rough estimate of how many jobs have ever been enqueued.
failed_jobs => 100
Number of jobs in "failed" state.
finished_jobs => 100
Number of jobs in "finished" state.
inactive_jobs => 100
Number of jobs in "inactive" state.
inactive_workers => 100
Number of workers that are currently not processing a job.
uptime => 1000
Uptime in seconds.
my $bool = $backend->unlock('foo');
Release a named lock.
$backend->unregister_worker($worker_id);
Unregister worker.
Minion, <https://minion.pm>, Mojolicious::Guides, <https://mojolicious.org>.
| 2021-03-29 | perl v5.32.1 |