<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">NAME

    Minion::Backend::SQLite - SQLite backend for Minion job queue

SYNOPSIS

      use Minion::Backend::SQLite;
      my $backend = Minion::Backend::SQLite-&gt;new('sqlite:test.db');
    
      # Minion
      use Minion;
      my $minion = Minion-&gt;new(SQLite =&gt; 'sqlite:test.db');
    
      # Mojolicious (via Mojolicious::Plugin::Minion)
      $self-&gt;plugin(Minion =&gt; { SQLite =&gt; 'sqlite:test.db' });
    
      # Mojolicious::Lite (via Mojolicious::Plugin::Minion)
      plugin Minion =&gt; { SQLite =&gt; 'sqlite:test.db' };
    
      # Share the database connection cache
      helper sqlite =&gt; sub { state $sqlite = Mojo::SQLite-&gt;new('sqlite:test.db') };
      plugin Minion =&gt; { SQLite =&gt; app-&gt;sqlite };

DESCRIPTION

    Minion::Backend::SQLite is a backend for Minion based on Mojo::SQLite.
    All necessary tables will be created automatically with a set of
    migrations named minion. If no connection string or :temp: is provided,
    the database will be created in a temporary directory.

ATTRIBUTES

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

 dequeue_interval

      my $seconds = $backend-&gt;dequeue_interval;
      $backend    = $backend-&gt;dequeue_interval($seconds);

    Interval in seconds between "dequeue" attempts. Defaults to 0.5.

 sqlite

      my $sqlite = $backend-&gt;sqlite;
      $backend   = $backend-&gt;sqlite(Mojo::SQLite-&gt;new);

    Mojo::SQLite object used to store all data.

METHODS

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

 new

      my $backend = Minion::Backend::SQLite-&gt;new;
      my $backend = Minion::Backend::SQLite-&gt;new(':temp:');
      my $backend = Minion::Backend::SQLite-&gt;new('sqlite:test.db');
      my $backend = Minion::Backend::SQLite-&gt;new-&gt;tap(sub { $_-&gt;sqlite-&gt;from_filename('C:\\foo\\bar.db') });
      my $backend = Minion::Backend::SQLite-&gt;new(Mojo::SQLite-&gt;new);

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

 broadcast

      my $bool = $backend-&gt;broadcast('some_command');
      my $bool = $backend-&gt;broadcast('some_command', [@args]);
      my $bool = $backend-&gt;broadcast('some_command', [@args], [$id1, $id2, $id3]);

    Broadcast remote control command to one or more workers.

 dequeue

      my $job_info = $backend-&gt;dequeue($worker_id, 0.5);
      my $job_info = $backend-&gt;dequeue($worker_id, 0.5, {queues =&gt; ['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. Jobs will be checked for in intervals defined by
    "dequeue_interval" until the timeout is reached.

    These options are currently available:

    id

        id =&gt; '10023'

      Dequeue a specific job.

    queues

        queues =&gt; ['important']

      One or more queues to dequeue jobs from, defaults to default.

    These fields are currently available:

    args

        args =&gt; ['foo', 'bar']

      Job arguments.

    id

        id =&gt; '10023'

      Job ID.

    retries

        retries =&gt; 3

      Number of times job has been retried.

    task

        task =&gt; 'foo'

      Task name.

 enqueue

      my $job_id = $backend-&gt;enqueue('foo');
      my $job_id = $backend-&gt;enqueue(foo =&gt; [@args]);
      my $job_id = $backend-&gt;enqueue(foo =&gt; [@args] =&gt; {priority =&gt; 1});

    Enqueue a new job with inactive state.

    These options are currently available:

    attempts

        attempts =&gt; 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.

    delay

        delay =&gt; 10

      Delay job for this many seconds (from now).

    notes

        notes =&gt; {foo =&gt; 'bar', baz =&gt; [1, 2, 3]}

      Hash reference with arbitrary metadata for this job.

    parents

        parents =&gt; [$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.

    priority

        priority =&gt; 5

      Job priority, defaults to 0. Jobs with a higher priority get
      performed first.

    queue

        queue =&gt; 'important'

      Queue to put job in, defaults to default.

 fail_job

      my $bool = $backend-&gt;fail_job($job_id, $retries);
      my $bool = $backend-&gt;fail_job($job_id, $retries, 'Something went wrong!');
      my $bool = $backend-&gt;fail_job(
        $job_id, $retries, {msg =&gt; 'Something went wrong!'});

    Transition from active to failed state, and if there are attempts
    remaining, transition back to inactive with an exponentially increasing
    delay based on "backoff" in Minion.

 finish_job

      my $bool = $backend-&gt;finish_job($job_id, $retries);
      my $bool = $backend-&gt;finish_job($job_id, $retries, 'All went well!');
      my $bool = $backend-&gt;finish_job($job_id, $retries, {msg =&gt; 'All went well!'});

    Transition from active to finished state.

 list_jobs

      my $results = $backend-&gt;list_jobs($offset, $limit);
      my $results = $backend-&gt;list_jobs($offset, $limit, {state =&gt; 'inactive'});

    Returns the information about jobs in batches.

      # Check job state
      my $results = $backend-&gt;list_jobs(0, 1, {ids =&gt; [$job_id]});
      my $state = $results-&gt;{jobs}[0]{state};
    
      # Get job result
      my $results = $backend-&gt;list_jobs(0, 1, {ids =&gt; [$job_id]});
      my $result = $results-&gt;{jobs}[0]{result};

    These options are currently available:

    ids

        ids =&gt; ['23', '24']

      List only jobs with these ids.

    queue

        queue =&gt; 'important'

      List only jobs in this queue.

    state

        state =&gt; 'inactive'

      List only jobs in this state.

    task

        task =&gt; 'test'

      List only jobs for this task.

    These fields are currently available:

    args

        args =&gt; ['foo', 'bar']

      Job arguments.

    attempts

        attempts =&gt; 25

      Number of times performing this job will be attempted.

    children

        children =&gt; ['10026', '10027', '10028']

      Jobs depending on this job.

    created

        created =&gt; 784111777

      Epoch time job was created.

    delayed

        delayed =&gt; 784111777

      Epoch time job was delayed to.

    finished

        finished =&gt; 784111777

      Epoch time job was finished.

    notes

        notes =&gt; {foo =&gt; 'bar', baz =&gt; [1, 2, 3]}

      Hash reference with arbitrary metadata for this job.

    parents

        parents =&gt; ['10023', '10024', '10025']

      Jobs this job depends on.

    priority

        priority =&gt; 3

      Job priority.

    queue

        queue =&gt; 'important'

      Queue name.

    result

        result =&gt; 'All went well!'

      Job result.

    retried

        retried =&gt; 784111777

      Epoch time job has been retried.

    retries

        retries =&gt; 3

      Number of times job has been retried.

    started

        started =&gt; 784111777

      Epoch time job was started.

    state

        state =&gt; 'inactive'

      Current job state, usually active, failed, finished or inactive.

    task

        task =&gt; 'foo'

      Task name.

    worker

        worker =&gt; '154'

      Id of worker that is processing the job.

 list_locks

      my $results = $backend-&gt;list_locks($offset, $limit);
      my $results = $backend-&gt;list_locks($offset, $limit, {name =&gt; 'foo'});

    Returns information about locks in batches.

      # Check expiration time
      my $results = $backend-&gt;list_locks(0, 1, {name =&gt; 'foo'});
      my $expires = $results-&gt;{locks}[0]{expires};

    These options are currently available:

    name

        name =&gt; 'foo'

      List only locks with this name.

    These fields are currently available:

    expires

        expires =&gt; 784111777

      Epoch time this lock will expire.

    name

        name =&gt; 'foo'

      Lock name.

 list_workers

      my $results = $backend-&gt;list_workers($offset, $limit);
      my $results = $backend-&gt;list_workers($offset, $limit, {ids =&gt; [23]});

    Returns information about workers in batches.

      # Check worker host
      my $results = $backend-&gt;list_workers(0, 1, {ids =&gt; [$worker_id]});
      my $host    = $results-&gt;{workers}[0]{host};

    These options are currently available:

    ids

        ids =&gt; ['23', '24']

      List only workers with these ids.

    These fields are currently available:

    host

        host =&gt; 'localhost'

      Worker host.

    jobs

        jobs =&gt; ['10023', '10024', '10025', '10029']

      Ids of jobs the worker is currently processing.

    notified

        notified =&gt; 784111777

      Epoch time worker sent the last heartbeat.

    pid

        pid =&gt; 12345

      Process id of worker.

    started

        started =&gt; 784111777

      Epoch time worker was started.

    status

        status =&gt; {queues =&gt; ['default', 'important']}

      Hash reference with whatever status information the worker would like
      to share.

 lock

      my $bool = $backend-&gt;lock('foo', 3600);
      my $bool = $backend-&gt;lock('foo', 3600, {limit =&gt; 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.

    These options are currently available:

    limit

        limit =&gt; 20

      Number of shared locks with the same name that can be active at the
      same time, defaults to 1.

 note

      my $bool = $backend-&gt;note($job_id, foo =&gt; 'bar');

    Change a metadata field for a job. It is currently an error to attempt
    to set a metadata field with a name containing the characters ., [, or
    ].

 receive

      my $commands = $backend-&gt;receive($worker_id);

    Receive remote control commands for worker.

 register_worker

      my $worker_id = $backend-&gt;register_worker;
      my $worker_id = $backend-&gt;register_worker($worker_id);
      my $worker_id = $backend-&gt;register_worker(
        $worker_id, {status =&gt; {queues =&gt; ['default', 'important']}});

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

    These options are currently available:

    status

        status =&gt; {queues =&gt; ['default', 'important']}

      Hash reference with whatever status information the worker would like
      to share.

 remove_job

      my $bool = $backend-&gt;remove_job($job_id);

    Remove failed, finished or inactive job from queue.

 repair

      $backend-&gt;repair;

    Repair worker registry and job queue if necessary.

 reset

      $backend-&gt;reset;

    Reset job queue.

 retry_job

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

    Transition job back to inactive state, already inactive jobs may also
    be retried to change options.

    These options are currently available:

    attempts

        attempts =&gt; 25

      Number of times performing this job will be attempted.

    delay

        delay =&gt; 10

      Delay job for this many seconds (from now).

    priority

        priority =&gt; 5

      Job priority.

    queue

        queue =&gt; 'important'

      Queue to put job in.

 stats

      my $stats = $backend-&gt;stats;

    Get statistics for the job queue.

    These fields are currently available:

    active_jobs

        active_jobs =&gt; 100

      Number of jobs in active state.

    active_locks

        active_locks =&gt; 100

      Number of active named locks.

    active_workers

        active_workers =&gt; 100

      Number of workers that are currently processing a job.

    delayed_jobs

        delayed_jobs =&gt; 100

      Number of jobs in inactive state that are scheduled to run at
      specific time in the future. Note that this field is EXPERIMENTAL and
      might change without warning!

    enqueued_jobs

        enqueued_jobs =&gt; 100000

      Rough estimate of how many jobs have ever been enqueued. Note that
      this field is EXPERIMENTAL and might change without warning!

    failed_jobs

        failed_jobs =&gt; 100

      Number of jobs in failed state.

    finished_jobs

        finished_jobs =&gt; 100

      Number of jobs in finished state.

    inactive_jobs

        inactive_jobs =&gt; 100

      Number of jobs in inactive state.

    inactive_workers

        inactive_workers =&gt; 100

      Number of workers that are currently not processing a job.

    uptime

        uptime =&gt; undef

      Uptime in seconds. Always undefined for SQLite.

 unlock

      my $bool = $backend-&gt;unlock('foo');

    Release a named lock.

 unregister_worker

      $backend-&gt;unregister_worker($worker_id);

    Unregister worker.

BUGS

    Report any issues on the public bugtracker.

AUTHOR

    Dan Book &lt;dbook@cpan.org&gt;

COPYRIGHT AND LICENSE

    This software is Copyright (c) 2015 by Dan Book.

    This is free software, licensed under:

      The Artistic License 2.0 (GPL Compatible)

SEE ALSO

    Minion, Mojo::SQLite

</pre></body></html>