=head1 NAME
-Redis - The great new Redis!
+Redis - perl binding for Redis database
=cut
-our $VERSION = '0.01';
+our $VERSION = '0.08';
-=head1 SYNOPSIS
+=head1 DESCRIPTION
Pure perl bindings for L<http://code.google.com/p/redis/>
- use Redis;
-
- my $r = Redis->new();
-
+This version support git version 0.08 of Redis available at
+L<git://github.com/antirez/redis>
+This documentation
+lists commands which are exercised in test suite, but
+additinal commands will work correctly since protocol
+specifies enough information to support almost all commands
+with same peace of code with a little help of C<AUTOLOAD>.
=head1 FUNCTIONS
=head2 new
+ my $r = Redis->new;
+
=cut
+our $debug = $ENV{REDIS} || 0;
+
our $sock;
my $server = '127.0.0.1:6379';
$self;
}
-sub _sock_result {
- my $result = <$sock>;
- warn "# result: ",dump( $result );
- $result =~ s{\r\n$}{} || warn "can't find cr/lf";
- return $result;
+my $bulk_command = {
+ set => 1, setnx => 1,
+ rpush => 1, lpush => 1,
+ lset => 1, lrem => 1,
+ sadd => 1, srem => 1,
+ sismember => 1,
+ echo => 1,
+};
+
+# we don't want DESTROY to fallback into AUTOLOAD
+sub DESTROY {}
+
+our $AUTOLOAD;
+sub AUTOLOAD {
+ my $self = shift;
+
+ my $command = $AUTOLOAD;
+ $command =~ s/.*://;
+
+ warn "## $command ",dump(@_) if $debug;
+
+ my $send;
+
+ if ( defined $bulk_command->{$command} ) {
+ my $value = pop;
+ $value = '' if ! defined $value;
+ $send
+ = uc($command)
+ . ' '
+ . join(' ', @_)
+ . ' '
+ . length( $value )
+ . "\r\n$value\r\n"
+ ;
+ } else {
+ $send
+ = uc($command)
+ . ' '
+ . join(' ', @_)
+ . "\r\n"
+ ;
+ }
+
+ warn ">> $send" if $debug;
+ print $sock $send;
+
+ if ( $command eq 'quit' ) {
+ close( $sock ) || die "can't close socket: $!";
+ return 1;
+ }
+
+ my $result = <$sock> || die "can't read socket: $!";
+ warn "<< $result" if $debug;
+ my $type = substr($result,0,1);
+ $result = substr($result,1,-2);
+
+ if ( $command eq 'info' ) {
+ my $hash;
+ foreach my $l ( split(/\r\n/, __sock_read_bulk($result) ) ) {
+ my ($n,$v) = split(/:/, $l, 2);
+ $hash->{$n} = $v;
+ }
+ return $hash;
+ } elsif ( $command eq 'keys' ) {
+ my $keys = __sock_read_bulk($result);
+ return split(/\s/, $keys) if $keys;
+ return;
+ }
+
+ if ( $type eq '-' ) {
+ confess $result;
+ } elsif ( $type eq '+' ) {
+ return $result;
+ } elsif ( $type eq '$' ) {
+ return __sock_read_bulk($result);
+ } elsif ( $type eq '*' ) {
+ return __sock_read_multi_bulk($result);
+ } elsif ( $type eq ':' ) {
+ return $result; # FIXME check if int?
+ } else {
+ confess "unknown type: $type", __sock_read_line();
+ }
}
-sub _sock_read_bulk {
- my $len = <$sock>;
- warn "## bulk len: ",dump($len);
- return undef if $len eq "nil\r\n";
+sub __sock_read_bulk {
+ my $len = shift;
+ return undef if $len < 0;
+
my $v;
if ( $len > 0 ) {
read($sock, $v, $len) || die $!;
- warn "## bulk v: ",dump($v);
+ warn "<< ",dump($v),$/ if $debug;
}
my $crlf;
read($sock, $crlf, 2); # skip cr/lf
return $v;
}
-sub _sock_result_bulk {
- my $self = shift;
- warn "## _sock_result_bulk ",dump( @_ );
- print $sock join(' ',@_) . "\r\n";
- _sock_read_bulk();
-}
+sub __sock_read_multi_bulk {
+ my $size = shift;
+ return undef if $size < 0;
-sub _sock_result_bulk_list {
- my $self = shift;
- warn "## _sock_result_bulk_list ",dump( @_ );
-
- my $size = $self->_sock_send( @_ );
- confess $size unless $size > 0;
$size--;
my @list = ( 0 .. $size );
foreach ( 0 .. $size ) {
- $list[ $_ ] = _sock_read_bulk();
+ $list[ $_ ] = __sock_read_bulk( substr(<$sock>,1,-2) );
}
- warn "## list = ", dump( @list );
+ warn "## list = ", dump( @list ) if $debug;
return @list;
}
-sub __sock_ok {
- my $ok = <$sock>;
- return undef if $ok eq "nil\r\n";
- confess dump($ok) unless $ok eq "+OK\r\n";
-}
-
-sub _sock_send {
- my $self = shift;
- warn "## _sock_send ",dump( @_ );
- print $sock join(' ',@_) . "\r\n";
- _sock_result();
-}
-
-sub _sock_send_ok {
- my $self = shift;
- warn "## _sock_send_ok ",dump( @_ );
- print $sock join(' ',@_) . "\r\n";
- __sock_ok();
-}
-
-sub __sock_send_bulk_raw {
- my $self = shift;
- warn "## _sock_send_bulk ",dump( @_ );
- my $value = pop;
- $value = '' unless defined $value; # FIXME errr? nil?
- print $sock join(' ',@_) . ' ' . length($value) . "\r\n$value\r\n"
-}
-
-sub _sock_send_bulk {
- __sock_send_bulk_raw( @_ );
- __sock_ok();
-}
+1;
-sub _sock_send_bulk_number {
- __sock_send_bulk_raw( @_ );
- my $v = _sock_result();
- confess $v unless $v =~ m{^\-?\d+$};
- return $v;
-}
+__END__
=head1 Connection Handling
$r->quit;
-=cut
-
-sub quit {
- my $self = shift;
-
- close( $sock ) || warn $!;
-}
-
=head2 ping
$r->ping || die "no server?";
-=cut
-
-sub ping {
- print $sock "PING\r\n";
- my $pong = <$sock>;
- die "ping failed, got ", dump($pong) unless $pong eq "+PONG\r\n";
-}
-
=head1 Commands operating on string values
=head2 set
- $r->set( foo => 'bar', $new );
-
-=cut
+ $r->set( foo => 'bar' );
-sub set {
- my ( $self, $key, $value, $new ) = @_;
- $self->_sock_send_bulk( "SET" . ( $new ? 'NX' : '' ), $key, $value );
-}
+ $r->setnx( foo => 42 );
=head2 get
my $value = $r->get( 'foo' );
-=cut
+=head2 mget
-sub get {
- my $self = shift;
- $self->_sock_result_bulk('GET', @_);
-}
+ my @values = $r->mget( 'foo', 'bar', 'baz' );
=head2 incr
$r->incr('counter');
- $r->incr('tripplets', 3);
-
-=cut
-
-
-sub incr {
- my $self = shift;
- $self->_sock_send( 'INCR' . ( $#_ ? 'BY' : '' ), @_ );
-}
+ $r->incrby('tripplets', 3);
=head2 decr
$r->decr('counter');
- $r->decr('tripplets', 3);
-
-=cut
-sub decr {
- my $self = shift;
- $self->_sock_send( 'DECR' . ( $#_ ? 'BY' : '' ), @_ );
-}
+ $r->decrby('tripplets', 3);
=head2 exists
$r->exists( 'key' ) && print "got key!";
-=cut
-
-sub exists {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'EXISTS', $key );
-}
-
=head2 del
$r->del( 'key' ) || warn "key doesn't exist";
-=cut
-
-sub del {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'DEL', $key );
-}
-
=head2 type
$r->type( 'key' ); # = string
-=cut
-
-sub type {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'TYPE', $key );
-}
-
=head1 Commands operating on the key space
=head2 keys
my @keys = $r->keys( '*glob_pattern*' );
-=cut
-
-sub keys {
- my ( $self, $glob ) = @_;
- return split(/\s/, $self->_sock_result_bulk( 'KEYS', $glob ));
-}
-
=head2 randomkey
my $key = $r->randomkey;
-=cut
-
-sub randomkey {
- my ( $self ) = @_;
- $self->_sock_send( 'RANDOMKEY' );
-}
-
=head2 rename
my $ok = $r->rename( 'old-key', 'new-key', $new );
-=cut
-
-sub rename {
- my ( $self, $old, $new, $nx ) = @_;
- $self->_sock_send_ok( 'RENAME' . ( $nx ? 'NX' : '' ), $old, $new );
-}
-
=head2 dbsize
my $nr_keys = $r->dbsize;
-=cut
-
-sub dbsize {
- my ( $self ) = @_;
- $self->_sock_send('DBSIZE');
-}
-
=head1 Commands operating on lists
+See also L<Redis::List> for tie interface.
+
=head2 rpush
$r->rpush( $key, $value );
-=cut
-
-sub rpush {
- my ( $self, $key, $value ) = @_;
- $self->_sock_send_bulk('RPUSH', $key, $value);
-}
-
=head2 lpush
$r->lpush( $key, $value );
-=cut
-
-sub lpush {
- my ( $self, $key, $value ) = @_;
- $self->_sock_send_bulk('LPUSH', $key, $value);
-}
-
=head2 llen
$r->llen( $key );
-=cut
-
-sub llen {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'LLEN', $key );
-}
-
=head2 lrange
my @list = $r->lrange( $key, $start, $end );
-=cut
-
-sub lrange {
- my ( $self, $key, $start, $end ) = @_;
- $self->_sock_result_bulk_list('LRANGE', $key, $start, $end);
-}
-
=head2 ltrim
my $ok = $r->ltrim( $key, $start, $end );
-=cut
-
-sub ltrim {
- my ( $self, $key, $start, $end ) = @_;
- $self->_sock_send_ok( 'LTRIM', $key, $start, $end );
-}
-
=head2 lindex
$r->lindex( $key, $index );
-=cut
-
-sub lindex {
- my ( $self, $key, $index ) = @_;
- $self->_sock_result_bulk( 'LINDEX', $key, $index );
-}
-
=head2 lset
$r->lset( $key, $index, $value );
-=cut
-
-sub lset {
- my ( $self, $key, $index, $value ) = @_;
- $self->_sock_send_bulk( 'LSET', $key, $index, $value );
-}
-
=head2 lrem
my $modified_count = $r->lrem( $key, $count, $value );
-=cut
-
-sub lrem {
- my ( $self, $key, $count, $value ) = @_;
- $self->_sock_send_bulk_number( 'LREM', $key, $count, $value );
-}
-
=head2 lpop
my $value = $r->lpop( $key );
-=cut
-
-sub lpop {
- my ( $self, $key ) = @_;
- $self->_sock_result_bulk( 'LPOP', $key );
-}
-
=head2 rpop
my $value = $r->rpop( $key );
-=cut
-
-sub rpop {
- my ( $self, $key ) = @_;
- $self->_sock_result_bulk( 'RPOP', $key );
-}
-
=head1 Commands operating on sets
=head2 sadd
$r->sadd( $key, $member );
-=cut
-
-sub sadd {
- my ( $self, $key, $member ) = @_;
- $self->_sock_send_bulk_number( 'SADD', $key, $member );
-}
-
=head2 srem
$r->srem( $key, $member );
-=cut
-
-sub srem {
- my ( $self, $key, $member ) = @_;
- $self->_sock_send_bulk_number( 'SREM', $key, $member );
-}
-
=head2 scard
my $elements = $r->scard( $key );
-=cut
-
-sub scard {
- my ( $self, $key ) = @_;
- $self->_sock_send( 'SCARD', $key );
-}
-
=head2 sismember
$r->sismember( $key, $member );
-=cut
-
-sub sismember {
- my ( $self, $key, $member ) = @_;
- $self->_sock_send_bulk_number( 'SISMEMBER', $key, $member );
-}
-
=head2 sinter
$r->sinter( $key1, $key2, ... );
-=cut
-
-sub sinter {
- my $self = shift;
- $self->_sock_result_bulk_list( 'SINTER', @_ );
-}
-
=head2 sinterstore
my $ok = $r->sinterstore( $dstkey, $key1, $key2, ... );
-=cut
+=head1 Multiple databases handling commands
-sub sinterstore {
- my $self = shift;
- $self->_sock_send_ok( 'SINTERSTORE', @_ );
-}
+=head2 select
+
+ $r->select( $dbindex ); # 0 for new clients
+
+=head2 move
+
+ $r->move( $key, $dbindex );
+
+=head2 flushdb
+
+ $r->flushdb;
+
+=head2 flushall
+
+ $r->flushall;
+
+=head1 Sorting
+
+=head2 sort
+
+ $r->sort("key BY pattern LIMIT start end GET pattern ASC|DESC ALPHA');
+
+=head1 Persistence control commands
+
+=head2 save
+
+ $r->save;
+
+=head2 bgsave
+
+ $r->bgsave;
+
+=head2 lastsave
+
+ $r->lastsave;
+
+=head2 shutdown
+
+ $r->shutdown;
+
+=head1 Remote server control commands
+
+=head2 info
+
+ my $info_hash = $r->info;
=head1 AUTHOR
You can find documentation for this module with the perldoc command.
perldoc Redis
+ perldoc Redis::List
+ perldoc Redis::Hash
You can also look for information at:
projects / perl-Redis.git / blobdiff