Minion::Backend::MongoDB - MongoDB backend for Minion
version 1.14
use Minion::Backend::MongoDB; my $backend = Minion::Backend::MongoDB->new('mongodb://127.0.0.1:27017');
This is a MongoDB backend for Minion derived from Minion::Backend::Pg and supports for all its features. Mojolicious 9.0 compatibility and synced with Minion::Backend::Pg v.10.22 features.
Minion::Backend::MongoDB inherits all attributes from Minion::Backend and implements the following new ones.
my $mongodb = $backend->mongodb; $backend = $backend->mongodb(MongoDB->new);
MongoDB::Database object used to store collections.
my $jobs = $backend->jobs; $backend = $backend->jobs(MongoDB::Collection->new);
MongoDB::Collection object for jobs collection, defaults to one based on "prefix".
jobs
my $notifications = $backend->notifications; $backend = $backend->notifications(MongoDB::Collection->new);
MongoDB::Collection object for notifications collection, defaults to one based on "prefix".
notifications
my $prefix = $backend->prefix; $backend = $backend->prefix('foo');
Prefix for collections, defaults to minion.
minion
my $workers = $backend->workers; $backend = $backend->workers(MongoDB::Collection->new);
MongoDB::Collection object for workers collection, defaults to one based on "prefix".
workers
Minion::Backend::MongoDB 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 $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.
inactive
active
undef
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.
default
These fields are currently available:
args => ['foo', 'bar']
Job arguments.
Job ID.
retries => 3
Number of times job has been retried.
task => 'foo'
Task name.
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.
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.
1
delay => 10
Delay job for this many seconds (from now), defaults to 0.
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!
failed
false
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.
finished
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.
100
-100
queue => 'important'
Queue to put job in, defaults to default.
sequence => 'host:mojolicious.org'
Sequence this job belongs to. The previous job from the sequence will be automatically added as a parent to continue the sequence. Note that this option is EXPERIMENTAL and might change without warning!
my $bool = $backend->fail_job($job_id); my $bool = $backend->fail_job($job_id, 'Something went wrong!');
Transition from active to failed state.
my $bool = $backend->finish_job($job_id);
Transition from active to finished state.
my $info = $backend->job_info($job_id);
Get information about a job or return undef if job does not exist.
my $batch = $backend->list_jobs($skip, $limit); my $batch = $backend->list_jobs($skip, $limit, {state => 'inactive'});
Returns the same information as "job_info" but 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};
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. Note that this option is EXPERIMENTAL and might change without warning!
queues => ['important', 'unimportant']
List only jobs in these queues.
sequences => ['host:localhost', 'host:mojolicious.org']
List only jobs from these sequences. Note that this option is EXPERIMENTAL and might change without warning!
state => 'inactive'
List only jobs in this state.
task => 'test'
List only jobs for this task.
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.
finished => 784111777
Epoch time job was finished.
id => 10025
Job id.
next => 10024
Next job in sequence.
previous => 10022
Previous job in sequence.
parents => ['10023', '10024', '10025']
Jobs this job depends on.
priority => 3
Job priority.
Queue name.
result => 'All went well!'
Job result.
retried => 784111777
Epoch time job has been retried.
Sequence name.
started => 784111777
Epoch time job was started.
Current job state, usually active, failed, finished or inactive.
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};
names => ['foo', 'bar']
List only locks with these names.
expires => 784111777
Epoch time this lock will expire.
name => 'foo'
Lock name.
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};
List only workers before this id.
List only workers with these ids.
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.
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.
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::MongoDB->new('mongodb://127.0.0.1:27017');
Construct a new Minion::Backend::MongoDB object. Required a connection string URI. Optional every other attributes will be pass to MongoDB::MongoClient costructor.
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.
$backend->purge(); $backend->purge({states => ['inactive'], older => 3600});
Purge all jobs created older than...
older => 3600
Value in seconds to purge jobs older than this value.
Default: $minion->remove_after
older_field => 'created'
What date field to use to check if job is older than.
Default: 'finished'
Purge only jobs in these queues.
states => ['inactive', 'failed']
Purge only jobs in these states.
tasks => ['task1', 'task2']
Purge only jobs for these tasks.
queues => ['q1', 'q2']
Purge only jobs for these queues.
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);
Register worker or send heartbeat to show that this worker is still alive.
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.
all => 1
Reset everything.
locks => 1
Reset only locks.
my $bool = $backend->retry_job($job_id); my $bool = $backend->retry_job($job_id, {delay => 10});
Transition from failed or finished state back to inactive.
Delay job for this many seconds (from now).
my $stats = $backend->stats;
Get statistics for jobs and workers.
$backend->unregister_worker($worker_id);
Unregister worker.
my $info = $backend->worker_info($worker_id);
Get information about a worker or return undef if worker does not exist.
my $mongo_oid = $backend->_oid($hex_24length);
EXPERIMENTAL: Convert an 24-byte hexadecimal value into a BSON::OID object. Usually, it should be used only if you need to query the MongoDB directly
BSON::OID
User must have this roles
"roles" : [ { "role" : "dbAdmin", "db" : "minion" }, { "role" : "clusterMonitor", "db" : "admin" }, { "role" : "readWrite", "db" : "minion" } ]
Please report any bugs through the web interface at https://github.com/avkhozov/Minion-Backend-MongoDB/issues If you want to contribute changes or otherwise involve yourself in development, feel free to fork the Git repository from https://github.com/avkhozov/Minion-Backend-MongoDB/.
You can find this documentation with the perldoc command too.
perldoc Minion::Backend::MongoDB
Minion, MongoDB, Minion::Guide, https://minion.pm, Mojolicious::Guides, https://mojolicious.org.
Emiliano Bruni <info@ebruni.it>, Andrey Khozov <avkhozov@gmail.com>
This software is Copyright (c) 2019-2021 by Emiliano Bruni, Andrey Khozov.
This is free software, licensed under:
The GNU General Public License, Version 3, June 2007
To install Minion::Backend::MongoDB, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Minion::Backend::MongoDB
CPAN shell
perl -MCPAN -e shell install Minion::Backend::MongoDB
For more information on module installation, please visit the detailed CPAN module installation guide.