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";
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 {
123 warn "## _sock_send_bulk ",dump( @_ ) if $debug;
125 $value = '' unless defined $value; # FIXME errr? nil?
126 print $sock join(' ',@_) . ' ' . length($value) . "\r\n$value\r\n"
129 sub _sock_send_bulk {
130 __sock_send_bulk_raw( @_ );
134 sub _sock_send_bulk_number {
135 __sock_send_bulk_raw( @_ );
136 my $v = _sock_result();
137 confess $v unless $v =~ m{^\-?\d+$};
141 =head1 Connection Handling
152 close( $sock ) || warn $!;
157 $r->ping || die "no server?";
162 print $sock "PING\r\n";
164 die "ping failed, got ", dump($pong) unless $pong eq "+PONG\r\n";
167 =head1 Commands operating on string values
171 $r->set( foo => 'bar', $new );
176 my ( $self, $key, $value, $new ) = @_;
177 $self->_sock_send_bulk( "SET" . ( $new ? 'NX' : '' ), $key, $value );
182 my $value = $r->get( 'foo' );
188 $self->_sock_result_bulk('GET', @_);
194 $r->incr('tripplets', 3);
202 $self->_sock_send( 'INCR' . ( $#_ ? 'BY' : '' ), @_ );
208 $r->decr('tripplets', 3);
214 $self->_sock_send( 'DECR' . ( $#_ ? 'BY' : '' ), @_ );
219 $r->exists( 'key' ) && print "got key!";
224 my ( $self, $key ) = @_;
225 $self->_sock_send( 'EXISTS', $key );
230 $r->del( 'key' ) || warn "key doesn't exist";
235 my ( $self, $key ) = @_;
236 $self->_sock_send( 'DEL', $key );
241 $r->type( 'key' ); # = string
246 my ( $self, $key ) = @_;
247 $self->_sock_send( 'TYPE', $key );
250 =head1 Commands operating on the key space
254 my @keys = $r->keys( '*glob_pattern*' );
259 my ( $self, $glob ) = @_;
260 return split(/\s/, $self->_sock_result_bulk( 'KEYS', $glob ));
265 my $key = $r->randomkey;
271 $self->_sock_send( 'RANDOMKEY' );
276 my $ok = $r->rename( 'old-key', 'new-key', $new );
281 my ( $self, $old, $new, $nx ) = @_;
282 $self->_sock_send_ok( 'RENAME' . ( $nx ? 'NX' : '' ), $old, $new );
287 my $nr_keys = $r->dbsize;
293 $self->_sock_send('DBSIZE');
296 =head1 Commands operating on lists
298 See also L<Redis::List> for tie interface.
302 $r->rpush( $key, $value );
307 my ( $self, $key, $value ) = @_;
308 $self->_sock_send_bulk('RPUSH', $key, $value);
313 $r->lpush( $key, $value );
318 my ( $self, $key, $value ) = @_;
319 $self->_sock_send_bulk('LPUSH', $key, $value);
329 my ( $self, $key ) = @_;
330 $self->_sock_send( 'LLEN', $key );
335 my @list = $r->lrange( $key, $start, $end );
340 my ( $self, $key, $start, $end ) = @_;
341 $self->_sock_result_bulk_list('LRANGE', $key, $start, $end);
346 my $ok = $r->ltrim( $key, $start, $end );
351 my ( $self, $key, $start, $end ) = @_;
352 $self->_sock_send_ok( 'LTRIM', $key, $start, $end );
357 $r->lindex( $key, $index );
362 my ( $self, $key, $index ) = @_;
363 $self->_sock_result_bulk( 'LINDEX', $key, $index );
368 $r->lset( $key, $index, $value );
373 my ( $self, $key, $index, $value ) = @_;
374 $self->_sock_send_bulk( 'LSET', $key, $index, $value );
379 my $modified_count = $r->lrem( $key, $count, $value );
384 my ( $self, $key, $count, $value ) = @_;
385 $self->_sock_send_bulk_number( 'LREM', $key, $count, $value );
390 my $value = $r->lpop( $key );
395 my ( $self, $key ) = @_;
396 $self->_sock_result_bulk( 'LPOP', $key );
401 my $value = $r->rpop( $key );
406 my ( $self, $key ) = @_;
407 $self->_sock_result_bulk( 'RPOP', $key );
410 =head1 Commands operating on sets
414 $r->sadd( $key, $member );
419 my ( $self, $key, $member ) = @_;
420 $self->_sock_send_bulk_number( 'SADD', $key, $member );
425 $r->srem( $key, $member );
430 my ( $self, $key, $member ) = @_;
431 $self->_sock_send_bulk_number( 'SREM', $key, $member );
436 my $elements = $r->scard( $key );
441 my ( $self, $key ) = @_;
442 $self->_sock_send( 'SCARD', $key );
447 $r->sismember( $key, $member );
452 my ( $self, $key, $member ) = @_;
453 $self->_sock_send_bulk_number( 'SISMEMBER', $key, $member );
458 $r->sinter( $key1, $key2, ... );
464 $self->_sock_result_bulk_list( 'SINTER', @_ );
469 my $ok = $r->sinterstore( $dstkey, $key1, $key2, ... );
475 $self->_sock_send_ok( 'SINTERSTORE', @_ );
478 =head1 Multiple databases handling commands
487 my ($self,$index) = @_;
488 $self->_sock_send_ok( 'SELECT', $index );
493 Dobrica Pavlinusic, C<< <dpavlin at rot13.org> >>
497 Please report any bugs or feature requests to C<bug-redis at rt.cpan.org>, or through
498 the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Redis>. I will be notified, and then you'll
499 automatically be notified of progress on your bug as I make changes.
506 You can find documentation for this module with the perldoc command.
511 You can also look for information at:
515 =item * RT: CPAN's request tracker
517 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Redis>
519 =item * AnnoCPAN: Annotated CPAN documentation
521 L<http://annocpan.org/dist/Redis>
525 L<http://cpanratings.perl.org/d/Redis>
529 L<http://search.cpan.org/dist/Redis>
534 =head1 ACKNOWLEDGEMENTS
537 =head1 COPYRIGHT & LICENSE
539 Copyright 2009 Dobrica Pavlinusic, all rights reserved.
541 This program is free software; you can redistribute it and/or modify it
542 under the same terms as Perl itself.