The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Dezi-Bot-0.002
River stage zero No dependents
2 ++
/ Dezi::Bot::Queue::DBI

NAME

Dezi::Bot::Queue::DBI - web crawler queue with DBI storage

SYNOPSIS

 use Dezi::Bot::Queue::DBI;

 my $queue = Dezi::Bot::Queue->new(
    type     => 'DBI',
    dsn      => "DBI:mysql:database=$database;host=$hostname;port=$port",
    username => 'myuser',
    password => 'mysecret',
 );
 my $uri = 'http://dezi.org/bot.html';
 $queue->put($uri);
 $queue->size();    # returns number of items in queue
 $queue->peek;      # returns $uri (next value for get())
 $queue->get;       # returns $uri and removes it from queue

DESCRIPTION

The Dezi::Bot::Queue::DBI class is a subclass of Dezi::Bot::Queue that uses DBI for storage.

METHODS

init_store()

Sets up the internal database handle (accessible via conn() attribute).

conn

Returns the internal DBIx::Connector object.

put( item, args )

Add item to the queue.

get([ limit, update_cols ])

Returns the next item from the queue, marking it as unavailable. Default is to return 1 item, but set limit to return multiple.

update_cols is an optional hashref of column/value pairs to update when each item is locked.

remove( item )

Remove item from the queue completely.

clean

Remove all locked items from the queue.

peek([ limit ])

Returns the next item value, but leaves it on the stack as available.

size

Returns the number of items currently in the queue.

schema

Callable as a function or class method. Returns string suitable for initializing a dezi_queue SQL table.

Example:

 perl -e 'use Dezi::Bot::Queue::DBI; print Dezi::Bot::Queue::DBI::schema' |\
  sqlite3 dezi.index/bot.db

AUTHOR

Peter Karman, <karman at cpan.org>

BUGS

Please report any bugs or feature requests to bug-dezi-bot at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dezi-Bot. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Dezi::Bot

You can also look for information at:

COPYRIGHT & LICENSE

Copyright 2013 Peter Karman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.