7 use Data::Dump qw/dump/;
12 Redis - perl binding for Redis database
16 our $VERSION = '0.01';
21 Pure perl bindings for L<http://code.google.com/p/redis/>
23 This version support git version of Redis available at
24 L<git://github.com/antirez/redis>
36 our $debug = $ENV{REDIS} || 0;
39 my $server = '127.0.0.1:6379';
46 warn "# opening socket to $server";
48 $sock ||= IO::Socket::INET->new(
58 warn "## result: ",dump( $result ) if $debug;
59 $result =~ s{\r\n$}{} || warn "can't find cr/lf";
63 sub __sock_read_bulk {
65 warn "## bulk len: ",dump($len) if $debug;
66 return undef if $len eq "nil\r\n";
69 read($sock, $v, $len) || die $!;
70 warn "## bulk v: ",dump($v) if $debug;
73 read($sock, $crlf, 2); # skip cr/lf
77 sub _sock_result_bulk {
79 warn "## _sock_result_bulk ",dump( @_ ) if $debug;
80 print $sock join(' ',@_) . "\r\n";
84 sub _sock_result_bulk_list {
86 warn "## _sock_result_bulk_list ",dump( @_ ) if $debug;
88 my $size = $self->_sock_send( @_ );
89 confess $size unless $size > 0;
92 my @list = ( 0 .. $size );
93 foreach ( 0 .. $size ) {
94 $list[ $_ ] = __sock_read_bulk();
97 warn "## list = ", dump( @list ) if $debug;
103 return undef if $ok eq "nil\r\n";
104 confess dump($ok) unless $ok eq "+OK\r\n";
109 warn "## _sock_send ",dump( @_ ) if $debug;
110 print $sock join(' ',@_) . "\r\n";
116 warn "## _sock_send_ok ",dump( @_ ) if $debug;
117 print $sock join(' ',@_) . "\r\n";
121 sub __sock_send_bulk_raw {
122 warn "## _sock_send_bulk ",dump( @_ ) if $debug;
124 $value = '' unless defined $value; # FIXME errr? nil?
125 print $sock join(' ',@_) . ' ' . length($value) . "\r\n$value\r\n"
128 sub _sock_send_bulk {
130 __sock_send_bulk_raw( @_ );
134 sub _sock_send_bulk_number {
136 __sock_send_bulk_raw( @_ );
137 my $v = __sock_result();
138 confess $v unless $v =~ m{^\-?\d+$};
142 =head1 Connection Handling
153 close( $sock ) || warn $!;
158 $r->ping || die "no server?";
163 print $sock "PING\r\n";
165 die "ping failed, got ", dump($pong) unless $pong eq "+PONG\r\n";
168 =head1 Commands operating on string values
172 $r->set( foo => 'bar', $new );
177 my ( $self, $key, $value, $new ) = @_;
178 $self->_sock_send_bulk( "SET" . ( $new ? 'NX' : '' ), $key, $value );
183 my $value = $r->get( 'foo' );
189 $self->_sock_result_bulk('GET', @_);
195 $r->incr('tripplets', 3);
203 $self->_sock_send( 'INCR' . ( $#_ ? 'BY' : '' ), @_ );
209 $r->decr('tripplets', 3);
215 $self->_sock_send( 'DECR' . ( $#_ ? 'BY' : '' ), @_ );
220 $r->exists( 'key' ) && print "got key!";
225 my ( $self, $key ) = @_;
226 $self->_sock_send( 'EXISTS', $key );
231 $r->del( 'key' ) || warn "key doesn't exist";
236 my ( $self, $key ) = @_;
237 $self->_sock_send( 'DEL', $key );
242 $r->type( 'key' ); # = string
247 my ( $self, $key ) = @_;
248 $self->_sock_send( 'TYPE', $key );
251 =head1 Commands operating on the key space
255 my @keys = $r->keys( '*glob_pattern*' );
260 my ( $self, $glob ) = @_;
261 my $keys = $self->_sock_result_bulk( 'KEYS', $glob );
262 return split(/\s/, $keys) if $keys;
263 return () if wantarray;
268 my $key = $r->randomkey;
274 $self->_sock_send( 'RANDOMKEY' );
279 my $ok = $r->rename( 'old-key', 'new-key', $new );
284 my ( $self, $old, $new, $nx ) = @_;
285 $self->_sock_send_ok( 'RENAME' . ( $nx ? 'NX' : '' ), $old, $new );
290 my $nr_keys = $r->dbsize;
296 $self->_sock_send('DBSIZE');
299 =head1 Commands operating on lists
301 See also L<Redis::List> for tie interface.
305 $r->rpush( $key, $value );
310 my ( $self, $key, $value ) = @_;
311 $self->_sock_send_bulk('RPUSH', $key, $value);
316 $r->lpush( $key, $value );
321 my ( $self, $key, $value ) = @_;
322 $self->_sock_send_bulk('LPUSH', $key, $value);
332 my ( $self, $key ) = @_;
333 $self->_sock_send( 'LLEN', $key );
338 my @list = $r->lrange( $key, $start, $end );
343 my ( $self, $key, $start, $end ) = @_;
344 $self->_sock_result_bulk_list('LRANGE', $key, $start, $end);
349 my $ok = $r->ltrim( $key, $start, $end );
354 my ( $self, $key, $start, $end ) = @_;
355 $self->_sock_send_ok( 'LTRIM', $key, $start, $end );
360 $r->lindex( $key, $index );
365 my ( $self, $key, $index ) = @_;
366 $self->_sock_result_bulk( 'LINDEX', $key, $index );
371 $r->lset( $key, $index, $value );
376 my ( $self, $key, $index, $value ) = @_;
377 $self->_sock_send_bulk( 'LSET', $key, $index, $value );
382 my $modified_count = $r->lrem( $key, $count, $value );
387 my ( $self, $key, $count, $value ) = @_;
388 $self->_sock_send_bulk_number( 'LREM', $key, $count, $value );
393 my $value = $r->lpop( $key );
398 my ( $self, $key ) = @_;
399 $self->_sock_result_bulk( 'LPOP', $key );
404 my $value = $r->rpop( $key );
409 my ( $self, $key ) = @_;
410 $self->_sock_result_bulk( 'RPOP', $key );
413 =head1 Commands operating on sets
417 $r->sadd( $key, $member );
422 my ( $self, $key, $member ) = @_;
423 $self->_sock_send_bulk_number( 'SADD', $key, $member );
428 $r->srem( $key, $member );
433 my ( $self, $key, $member ) = @_;
434 $self->_sock_send_bulk_number( 'SREM', $key, $member );
439 my $elements = $r->scard( $key );
444 my ( $self, $key ) = @_;
445 $self->_sock_send( 'SCARD', $key );
450 $r->sismember( $key, $member );
455 my ( $self, $key, $member ) = @_;
456 $self->_sock_send_bulk_number( 'SISMEMBER', $key, $member );
461 $r->sinter( $key1, $key2, ... );
467 $self->_sock_result_bulk_list( 'SINTER', @_ );
472 my $ok = $r->sinterstore( $dstkey, $key1, $key2, ... );
478 $self->_sock_send_ok( 'SINTERSTORE', @_ );
481 =head1 Multiple databases handling commands
485 $r->select( $dbindex ); # 0 for new clients
490 my ($self,$dbindex) = @_;
491 confess dump($dbindex) . 'not number' unless $dbindex =~ m{^\d+$};
492 $self->_sock_send_ok( 'SELECT', $dbindex );
497 $r->move( $key, $dbindex );
502 my ( $self, $key, $dbindex ) = @_;
503 $self->_sock_send( 'MOVE', $key, $dbindex );
514 $self->_sock_send_ok('FLUSHDB');
525 $self->_sock_send_ok('flushall');
530 Dobrica Pavlinusic, C<< <dpavlin at rot13.org> >>
534 Please report any bugs or feature requests to C<bug-redis at rt.cpan.org>, or through
535 the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Redis>. I will be notified, and then you'll
536 automatically be notified of progress on your bug as I make changes.
543 You can find documentation for this module with the perldoc command.
548 You can also look for information at:
552 =item * RT: CPAN's request tracker
554 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Redis>
556 =item * AnnoCPAN: Annotated CPAN documentation
558 L<http://annocpan.org/dist/Redis>
562 L<http://cpanratings.perl.org/d/Redis>
566 L<http://search.cpan.org/dist/Redis>
571 =head1 ACKNOWLEDGEMENTS
574 =head1 COPYRIGHT & LICENSE
576 Copyright 2009 Dobrica Pavlinusic, all rights reserved.
578 This program is free software; you can redistribute it and/or modify it
579 under the same terms as Perl itself.