Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/avkhozov/minion-backend-mongodb

MongoDB backend for Minion
https://github.com/avkhozov/minion-backend-mongodb

Last synced: about 1 month ago
JSON representation

MongoDB backend for Minion

Awesome Lists containing this project

README 

        
=pod



=head1 NAME



Minion::Backend::MongoDB - MongoDB backend for Minion



=for html 


    

        github workflow tests

    

    Top language: 

    github last commit




=head1 VERSION



version 1.14



=head1 SYNOPSIS



  use Minion::Backend::MongoDB;



  my $backend = Minion::Backend::MongoDB->new('mongodb://127.0.0.1:27017');



=head1 DESCRIPTION



This is a L backend for L derived from

L and supports for all its features.

L 9.0 compatibility and synced with L v.10.22

features.



=encoding UTF-8



=head1 ATTRIBUTES



L inherits all attributes from L and

implements the following new ones.



=head2 mongodb



  my $mongodb = $backend->mongodb;

  $backend  = $backend->mongodb(MongoDB->new);



L object used to store collections.



=head2 jobs



  my $jobs = $backend->jobs;

  $backend = $backend->jobs(MongoDB::Collection->new);



L object for C collection, defaults to one based on L"prefix">.



=head2 notifications



  my $notifications = $backend->notifications;

  $backend          = $backend->notifications(MongoDB::Collection->new);



L object for C collection, defaults to one based on L"prefix">.



=head2 prefix



  my $prefix = $backend->prefix;

  $backend   = $backend->prefix('foo');



Prefix for collections, defaults to C.



=head2 workers



  my $workers = $backend->workers;

  $backend    = $backend->workers(MongoDB::Collection->new);



L object for C collection, defaults to one based on L"prefix">.



=head1 METHODS



L inherits all methods from L 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 $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 to C state, or

return C 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.



=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 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 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. Note that this option is B and might

change without warning!



=item lax



  lax => 1



Existing jobs this job depends on may also have transitioned to the C state to allow for it to be processed,

defaults to C. Note that this option is B 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 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.



=item sequence



  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 B and might change without warning!



=back



=head2 fail_job



  my $bool = $backend->fail_job($job_id);

  my $bool = $backend->fail_job($job_id, 'Something went wrong!');



Transition from C to C state.



=head2 finish_job



  my $bool = $backend->finish_job($job_id);



Transition from C to C state.



=head2 job_info



  my $info = $backend->job_info($job_id);



Get information about a job or return C if job does not exist.



=head2 list_jobs



  my $batch = $backend->list_jobs($skip, $limit);

  my $batch = $backend->list_jobs($skip, $limit, {state => 'inactive'});



Returns the same information as L"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};



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. Note that this option is EXPERIMENTAL

and might change without warning!



=item queues



  queues => ['important', 'unimportant']



List only jobs in these queues.



=item sequences



  sequences => ['host:localhost', 'host:mojolicious.org']



List only jobs from these sequences. Note that this option is B and might change without warning!



=item state



  state => 'inactive'



List only jobs in this state.



=item task



  task => 'test'



List only jobs for this task.



=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 finished



  finished => 784111777



Epoch time job was finished.



=item id



  id => 10025



Job id.



=item next



  next => 10024



Next job in sequence.



=item notes



  notes => {foo => 'bar', baz => [1, 2, 3]}



Hash reference with arbitrary metadata for this job.



=item previous



  previous => 10022



Previous job in sequence.



=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 sequence



  sequence => 'host:mojolicious.org'



Sequence name.



=item started



  started => 784111777



Epoch time job was started.



=item state



  state => 'inactive'



Current job state, usually C, C, C or C.



=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 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::MongoDB->new('mongodb://127.0.0.1:27017');



Construct a new L object. Required a

L. Optional

every other attributes will be pass to L costructor.



=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 will

remove the field.



=head2 purge



  $backend->purge();

  $backend->purge({states => ['inactive'], older => 3600});



Purge all jobs created older than...



These options are currently available:



=over 2



=item older



  older => 3600



Value in seconds to purge jobs older than this value.



Default: $minion->remove_after



=item older_field



  older_field => 'created'



What date field to use to check if job is older than.



Default: 'finished'



=item queues



  queues => ['important', 'unimportant']



Purge only jobs in these queues.



=item states



  states => ['inactive', 'failed']



Purge only jobs in these states.



=item tasks



  tasks => ['task1', 'task2']



Purge only jobs for these tasks.



=item queues



  queues => ['q1', 'q2']



Purge only jobs for these queues.



=back



=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);



Register worker or send heartbeat to show that this worker is still alive.



=head2 remove_job



  my $bool = $backend->remove_job($job_id);



Remove C, C or C 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);

  my $bool = $backend->retry_job($job_id, {delay => 10});



Transition from C or C state back to C.



These options are currently available:



=over 2



=item delay



  delay => 10



Delay job for this many seconds (from now).



=back



=head2 stats



  my $stats = $backend->stats;



Get statistics for jobs and workers.



=head2 unregister_worker



  $backend->unregister_worker($worker_id);



Unregister worker.



=head2 worker_info



  my $info = $backend->worker_info($worker_id);



Get information about a worker or return C if worker does not exist.



=head2 _oid



  my $mongo_oid = $backend->_oid($hex_24length);



EXPERIMENTAL: Convert an 24-byte hexadecimal value into a C object.

Usually, it should be used only if you need to query the MongoDB directly



=head1 NOTES ABOUT USER



User must have this roles



  "roles" : [

                {

                        "role" : "dbAdmin",

                        "db" : "minion"

                },

                {

                        "role" : "clusterMonitor",

                        "db" : "admin"

                },

                {

                        "role" : "readWrite",

                        "db" : "minion"

                }

        ]



=head1 BUGS/CONTRIBUTING



Please report any bugs through the web interface at L

If you want to contribute changes or otherwise involve yourself in development, feel free to fork the Git repository from

L.



=head1 SUPPORT



You can find this documentation with the perldoc command too.



    perldoc Minion::Backend::MongoDB



=head1 SEE ALSO



L, L, L, L,

L, L.



=head1 AUTHOR



Emiliano Bruni , Andrey Khozov 



=head1 COPYRIGHT AND LICENSE



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



=cut