/ 
Minion-0.38
River stage two • 22 direct dependents • 31 total dependents
⭐ Starred 229 GitHub stars
/ Minion::Backend::File

NAME

Minion::Backend::File - File backend

SYNOPSIS

use Minion::Backend::File;

my $backend = Minion::Backend::File->new('/Users/sri/minion.data');

DESCRIPTION

Minion::Backend::File is a highly portable file-based backend for Minion.

ATTRIBUTES

Minion::Backend::File inherits all attributes from Minion::Backend and implements the following new ones.

deserialize

my $cb   = $backend->deserialize;
$backend = $backend->deserialize(sub {...});

A callback used to deserialize data, defaults to using Storable with gzip compression.

$backend->deserialize(sub {
  my $bytes = shift;
  return {};
});

file

my $file = $backend->file;
$backend = $backend->file('/Users/sri/minion.data');

File all data is stored in.

serialize

my $cb   = $backend->serialize;
$backend = $backend->serialize(sub {...});

A callback used to serialize data, defaults to using Storable with gzip compression.

$backend->serialize(sub {
  my $hash = shift;
  return '';
});

METHODS

Minion::Backend::File inherits all methods from Minion::Backend and implements the following new ones.

dequeue

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.

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 inactive state.

These options are currently available:

delay
delay => 10

Delay job for this many seconds from now.

priority
priority => 5

Job priority, defaults to 0.

fail_job

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

Transition from active to failed state.

finish_job

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

Transition from active to finished state.

job_info

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

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

list_jobs

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:

state
state => 'inactive'

List only jobs in this state.

task
task => 'test'

List only jobs for this task.

list_workers

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

Returns the same information as "worker_info" but in batches.

new

my $backend = Minion::Backend::File->new('/Users/sri/minion.data');

Construct a new Minion::Backend::File object.

register_worker

my $worker_id = $backend->register_worker;

Register worker.

remove_job

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

Remove failed, finished or inactive job from queue.

repair

$backend->repair;

Repair worker registry and job queue if necessary.

reset

$backend->reset;

Reset job queue.

retry_job

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

Transition from failed or finished state back to inactive.

stats

my $stats = $backend->stats;

Get statistics for jobs and workers.

unregister_worker

$backend->unregister_worker($worker_id);

Unregister worker.

worker_info

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

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

SEE ALSO

Minion, Mojolicious::Guides, http://mojolicio.us.