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',@_);
194 my @values = $r->get( 'foo', 'bar', 'baz' );
200 $self->_sock_result_bulk_list('MGET',@_);
206 $r->incr('tripplets', 3);
214 $self->_sock_send( 'INCR' . ( $#_ ? 'BY' : '' ), @_ );
220 $r->decr('tripplets', 3);
226 $self->_sock_send( 'DECR' . ( $#_ ? 'BY' : '' ), @_ );
231 $r->exists( 'key' ) && print "got key!";
236 my ( $self, $key ) = @_;
237 $self->_sock_send( 'EXISTS', $key );
242 $r->del( 'key' ) || warn "key doesn't exist";
247 my ( $self, $key ) = @_;
248 $self->_sock_send( 'DEL', $key );
253 $r->type( 'key' ); # = string
258 my ( $self, $key ) = @_;
259 $self->_sock_send( 'TYPE', $key );
262 =head1 Commands operating on the key space
266 my @keys = $r->keys( '*glob_pattern*' );
271 my ( $self, $glob ) = @_;
272 my $keys = $self->_sock_result_bulk( 'KEYS', $glob );
273 return split(/\s/, $keys) if $keys;
274 return () if wantarray;
279 my $key = $r->randomkey;
285 $self->_sock_send( 'RANDOMKEY' );
290 my $ok = $r->rename( 'old-key', 'new-key', $new );
295 my ( $self, $old, $new, $nx ) = @_;
296 $self->_sock_send_ok( 'RENAME' . ( $nx ? 'NX' : '' ), $old, $new );
301 my $nr_keys = $r->dbsize;
307 $self->_sock_send('DBSIZE');
310 =head1 Commands operating on lists
312 See also L<Redis::List> for tie interface.
316 $r->rpush( $key, $value );
321 my ( $self, $key, $value ) = @_;
322 $self->_sock_send_bulk('RPUSH', $key, $value);
327 $r->lpush( $key, $value );
332 my ( $self, $key, $value ) = @_;
333 $self->_sock_send_bulk('LPUSH', $key, $value);
343 my ( $self, $key ) = @_;
344 $self->_sock_send( 'LLEN', $key );
349 my @list = $r->lrange( $key, $start, $end );
354 my ( $self, $key, $start, $end ) = @_;
355 $self->_sock_result_bulk_list('LRANGE', $key, $start, $end);
360 my $ok = $r->ltrim( $key, $start, $end );
365 my ( $self, $key, $start, $end ) = @_;
366 $self->_sock_send_ok( 'LTRIM', $key, $start, $end );
371 $r->lindex( $key, $index );
376 my ( $self, $key, $index ) = @_;
377 $self->_sock_result_bulk( 'LINDEX', $key, $index );
382 $r->lset( $key, $index, $value );
387 my ( $self, $key, $index, $value ) = @_;
388 $self->_sock_send_bulk( 'LSET', $key, $index, $value );
393 my $modified_count = $r->lrem( $key, $count, $value );
398 my ( $self, $key, $count, $value ) = @_;
399 $self->_sock_send_bulk_number( 'LREM', $key, $count, $value );
404 my $value = $r->lpop( $key );
409 my ( $self, $key ) = @_;
410 $self->_sock_result_bulk( 'LPOP', $key );
415 my $value = $r->rpop( $key );
420 my ( $self, $key ) = @_;
421 $self->_sock_result_bulk( 'RPOP', $key );
424 =head1 Commands operating on sets
428 $r->sadd( $key, $member );
433 my ( $self, $key, $member ) = @_;
434 $self->_sock_send_bulk_number( 'SADD', $key, $member );
439 $r->srem( $key, $member );
444 my ( $self, $key, $member ) = @_;
445 $self->_sock_send_bulk_number( 'SREM', $key, $member );
450 my $elements = $r->scard( $key );
455 my ( $self, $key ) = @_;
456 $self->_sock_send( 'SCARD', $key );
461 $r->sismember( $key, $member );
466 my ( $self, $key, $member ) = @_;
467 $self->_sock_send_bulk_number( 'SISMEMBER', $key, $member );
472 $r->sinter( $key1, $key2, ... );
478 $self->_sock_result_bulk_list( 'SINTER', @_ );
483 my $ok = $r->sinterstore( $dstkey, $key1, $key2, ... );
489 $self->_sock_send_ok( 'SINTERSTORE', @_ );
492 =head1 Multiple databases handling commands
496 $r->select( $dbindex ); # 0 for new clients
501 my ($self,$dbindex) = @_;
502 confess dump($dbindex) . 'not number' unless $dbindex =~ m{^\d+$};
503 $self->_sock_send_ok( 'SELECT', $dbindex );
508 $r->move( $key, $dbindex );
513 my ( $self, $key, $dbindex ) = @_;
514 $self->_sock_send( 'MOVE', $key, $dbindex );
525 $self->_sock_send_ok('FLUSHDB');
536 $self->_sock_send_ok('flushall');
543 $r->sort("key BY pattern LIMIT start end GET pattern ASC|DESC ALPHA');
548 my ( $self, $sort ) = @_;
549 $self->_sock_result_bulk_list( "SORT $sort" );
552 =head1 Persistence control commands
562 $self->_sock_send_ok( 'SAVE' );
573 $self->_sock_send_ok( 'BGSAVE' );
584 $self->_sock_send( 'LASTSAVE' );
595 $self->_sock_send( 'SHUTDOWN' );
598 =head1 Remote server control commands
602 my $info_hash = $r->info;
608 my $info = $self->_sock_result_bulk( 'INFO' );
610 foreach my $l ( split(/\r\n/, $info ) ) {
611 my ($n,$v) = split(/:/, $l, 2);
619 Dobrica Pavlinusic, C<< <dpavlin at rot13.org> >>
623 Please report any bugs or feature requests to C<bug-redis at rt.cpan.org>, or through
624 the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Redis>. I will be notified, and then you'll
625 automatically be notified of progress on your bug as I make changes.
632 You can find documentation for this module with the perldoc command.
637 You can also look for information at:
641 =item * RT: CPAN's request tracker
643 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Redis>
645 =item * AnnoCPAN: Annotated CPAN documentation
647 L<http://annocpan.org/dist/Redis>
651 L<http://cpanratings.perl.org/d/Redis>
655 L<http://search.cpan.org/dist/Redis>
660 =head1 ACKNOWLEDGEMENTS
663 =head1 COPYRIGHT & LICENSE
665 Copyright 2009 Dobrica Pavlinusic, all rights reserved.
667 This program is free software; you can redistribute it and/or modify it
668 under the same terms as Perl itself.