Minion::Backend::MongoDB - MongoDB backend for Minion
version 1.03
use Minion::Backend::MongoDB; my $backend = Minion::Backend::MongoDB->new('mongodb://127.0.0.1:27017');
Minion::Backend::MongoDB is a MongoDB backend for Minion derived from Minion::Backend::Pg and supports its methods and tests up to 9.13 (2019-08-29).
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);
Wait for job, dequeue it and transition from inactive to active state or return undef if queue was empty.
inactive
active
undef
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:
delay => 10
Delay job for this many seconds from now.
priority => 5
Job priority, defaults to 0.
0
my $bool = $backend->fail_job($job_id); my $bool = $backend->fail_job($job_id, 'Something went wrong!');
Transition from active to failed state.
failed
my $bool = $backend->finish_job($job_id);
Transition from active to finished state.
finished
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.
These options are currently available:
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.
state => 'inactive'
List only jobs in this state.
task => 'test'
List only jobs for this task.
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.
finished => 784111777
Epoch time job was finished.
id => 10025
Job id.
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.
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};
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 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.
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.
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;
Reset job queue.
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" } ]
Minion, MongoDB, http://mojolicio.us.
Emiliano Bruni <info@ebruni.it>, Andrey Khozov <avkhozov@gmail.com>
This software is Copyright (c) 2019 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.