.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Mojolicious::Plugin::Minion 3pm" .TH Mojolicious::Plugin::Minion 3pm 2024-03-24 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Mojolicious::Plugin::Minion \- Minion job queue plugin .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& # Mojolicious (choose a backend) \& $self\->plugin(Minion => {Pg => \*(Aqpostgresql://postgres@/test\*(Aq}); \& \& # Mojolicious::Lite (choose a backend) \& plugin Minion => {Pg => \*(Aqpostgresql://postgres@/test\*(Aq}; \& \& # Share the database connection cache (PostgreSQL backend) \& helper pg => sub { state $pg = Mojo::Pg\->new(\*(Aqpostgresql://postgres@/test\*(Aq) }; \& plugin Minion => {Pg => app\->pg}; \& \& # Add tasks to your application \& app\->minion\->add_task(slow_log => sub ($job, $msg) { \& sleep 5; \& $job\->app\->log\->debug(qq{Received message "$msg"}); \& }); \& \& # Start jobs from anywhere in your application \& $c\->minion\->enqueue(slow_log => [\*(Aqtest 123\*(Aq]); \& \& # Perform jobs in your tests \& $t\->get_ok(\*(Aq/start_slow_log_job\*(Aq)\->status_is(200); \& $t\->get_ok(\*(Aq/start_another_job\*(Aq)\->status_is(200); \& $t\->app\->minion\->perform_jobs; .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" Mojolicious::Plugin::Minion is a Mojolicious plugin for the Minion job queue. .SH HELPERS .IX Header "HELPERS" Mojolicious::Plugin::Minion implements the following helpers. .SS minion .IX Subsection "minion" .Vb 2 \& my $minion = $app\->minion; \& my $minion = $c\->minion; .Ve .PP Get Minion object for application. .PP .Vb 2 \& # Add job to the queue \& $c\->minion\->enqueue(foo => [\*(Aqbar\*(Aq, \*(Aqbaz\*(Aq]); \& \& # Perform jobs for testing \& $app\->minion\->perform_jobs; .Ve .SH METHODS .IX Header "METHODS" Mojolicious::Plugin::Minion inherits all methods from Mojolicious::Plugin and implements the following new ones. .SS register .IX Subsection "register" .Vb 1 \& $plugin\->register(Mojolicious\->new, {Pg => \*(Aqpostgresql://postgres@/test\*(Aq}); .Ve .PP Register plugin in Mojolicious application. .SH "SEE ALSO" .IX Header "SEE ALSO" Minion, Minion::Guide, , Mojolicious::Guides, .