PerlRedis / Perl Redis

=pod

=encoding UTF-8

=head1 NAME

Redis - Perl binding for Redis database

=for html

=head1 VERSION

version 1.995

=head1 SYNOPSIS

## Defaults to $ENV{REDIS_SERVER} or 127.0.0.1:6379
my $redis = Redis->new;

my $redis = Redis->new(server => 'redis.example.com:8080');

## Set the connection name (requires Redis 2.6.9)
my $redis = Redis->new(
  server => 'redis.example.com:8080',
  name => 'my_connection_name',
);
my $generation = 0;
my $redis = Redis->new(
  server => 'redis.example.com:8080',
  name => sub { "cache-$$-".++$generation },
);

## Use UNIX domain socket
my $redis = Redis->new(sock => '/path/to/socket');

## Enable auto-reconnect
## Try to reconnect every 1s up to 60 seconds until success
## Die if you can't after that
my $redis = Redis->new(reconnect => 60, every => 1_000_000);

## Try each 100ms up to 2 seconds (every is in microseconds)
my $redis = Redis->new(reconnect => 2, every => 100_000);

## Enable connection timeout (in seconds)
my $redis = Redis->new(cnx_timeout => 60);

## Enable read timeout (in seconds)
my $redis = Redis->new(read_timeout => 0.5);

## Enable write timeout (in seconds)
my $redis = Redis->new(write_timeout => 1.2);

## Connect via a list of Sentinels to a given service
my $redis = Redis->new(sentinels => [ '127.0.0.1:12345' ], service => 'mymaster');

## Same, but with connection, read and write timeout on the sentinel hosts
my $redis = Redis->new( sentinels => [ '127.0.0.1:12345' ], service => 'mymaster',
                        sentinels_cnx_timeout => 0.1,
                        sentinels_read_timeout => 1,
                        sentinels_write_timeout => 1,
                      );

## Use all the regular Redis commands, they all accept a list of
## arguments
## See http://redis.io/commands for full list
$redis->get('key');
$redis->set('key' => 'value');
$redis->sort('list', 'DESC');
$redis->sort(qw{list LIMIT 0 5 ALPHA DESC});

## Add a coderef argument to run a command in the background
$redis->sort(qw{list LIMIT 0 5 ALPHA DESC}, sub {
  my ($reply, $error) = @_;
  die "Oops, got an error: $error\n" if defined $error;
  print "$_\n" for @$reply;
});
long_computation();
$redis->wait_all_responses;
## or
$redis->wait_one_response();

## Or run a large batch of commands in a pipeline
my %hash = _get_large_batch_of_commands();
$redis->hset('h', $_, $hash{$_}, sub {}) for keys %hash;
$redis->wait_all_responses;

## Publish/Subscribe
$redis->subscribe(
  'topic_1',
  'topic_2',
  sub {
    my ($message, $topic, $subscribed_topic) = @_

      ## $subscribed_topic can be different from topic if
      ## you use psubscribe() with wildcards
  }
);
$redis->psubscribe('nasdaq.*', sub {...});

## Blocks and waits for messages, calls subscribe() callbacks
##  ... forever
my $timeout = 10;
$redis->wait_for_messages($timeout) while 1;

##  ... until some condition
my $keep_going = 1; ## other code will set to false to quit
$redis->wait_for_messages($timeout) while $keep_going;

$redis->publish('topic_1', 'message');

=head1 DESCRIPTION

Pure perl bindings for Lhttp://redis.io/

This version supports protocol 2.x (multi-bulk) or later of Redis available at Lhttps://github.com/antirez/redis/.

This documentation lists commands which are exercised in test suite, but additional commands will work correctly since protocol specifies enough information to support almost all commands with same piece of code with a little help of C.

=head1 PIPELINING

Usually, running a command will wait for a response. However, if you're doing large numbers of requests, it can be more efficient to use what Redis calls I: send multiple commands to Redis without waiting for a response, then wait for the responses that come in.

To use pipelining, add a coderef argument as the last argument to a command method call:

$r->set('foo', 'bar', sub {});

Pending responses to pipelined commands are processed in a single batch, as soon as at least one of the following conditions holds:

=over

=item *

A non-pipelined (synchronous) command is called on the same connection

=item *

A pub/sub subscription command (one of C, C, C, or C) is about to be called on the same connection.

=item *

One of L</wait_all_responses> or L</wait_one_response> methods is called explicitly.

=back

The coderef you supply to a pipelined command method is invoked once the response is available. It takes two arguments, C<$reply> and C<$error>. If C<$error> is defined, it contains the text of an error reply sent by the Redis server. Otherwise, C<$reply> is the non-error reply. For almost all commands, that means it's C, or a defined but non-reference scalar, or an array ref of any of those; but see L, L, and L.

Note the contrast with synchronous commands, which throw an exception on receipt of an error reply, or return a non-error reply directly.

The fact that pipelined commands never throw an exception can be particularly useful for Redis transactions; see L.

=head1 ENCODING

There is no encoding feature anymore, it has been deprecated and finally removed. This module consider that any data sent to the Redis server is a binary data. And it doesn't do anything when getting data from the Redis server.

So, if you are working with character strings, you should pre-encode or post-decode it if needed !

=head1 CONSTRUCTOR

=head2 new

my $r = Redis->new; # $ENV{REDIS_SERVER} or 127.0.0.1:6379

my $r = Redis->new( server => '192.168.0.1:6379', debug => 0 );
my $r = Redis->new( server => '192.168.0.1:6379', encoding => undef );
my $r = Redis->new( sock => '/path/to/sock' );
my $r = Redis->new( reconnect => 60, every => 5000 );
my $r = Redis->new( password => 'boo' );
my $r = Redis->new( on_connect => sub { my ($redis) = @_; ... } );
my $r = Redis->new( name => 'my_connection_name' );
my $r = Redis->new( name => sub { "cache-for-$$" });

my $redis = Redis->new(sentinels => [ '127.0.0.1:12345', '127.0.0.1:23456' ],
                       service => 'mymaster');

## Connect via a list of Sentinels to a given service
my $redis = Redis->new(sentinels => [ '127.0.0.1:12345' ], service => 'mymaster');

## Same, but with connection, read and write timeout on the sentinel hosts
my $redis = Redis->new( sentinels => [ '127.0.0.1:12345' ], service => 'mymaster',
                        sentinels_cnx_timeout => 0.1,
                        sentinels_read_timeout => 1,
                        sentinels_write_timeout => 1,
                      );

=head3 C<< server >>

The C<< server >> parameter specifies the Redis server we should connect to, via TCP. Use the 'IP:PORT' format. If no C<< server >> option is present, we will attempt to use the C<< REDIS_SERVER >> environment variable. If neither of those options are present, it defaults to '127.0.0.1:6379'.

Alternatively you can use the C<< sock >> parameter to specify the path of the UNIX domain socket where the Redis server is listening.

Alternatively you can use the C<< sentinels >> parameter and the C<< service >> parameter to specify a list of sentinels to contact and try to get the address of the given service name. C<< sentinels >> must be an ArrayRef and C<< service

an Str.

The C<< REDIS_SERVER >> can be used for UNIX domain sockets too. The following formats are supported:

=over

=item *

/path/to/sock

=item *

unix:/path/to/sock

=item *

127.0.0.1:11011

=item *

tcp:127.0.0.1:11011

=back

=head3 C<< reconnect >>, C<< every >>

The C<< reconnect >> option enables auto-reconnection mode. If we cannot connect to the Redis server, or if a network write fails, we enter retry mode. We will try a new connection every C<< every >> microseconds (1 ms by default), up-to C<< reconnect >> seconds.

Be aware that read errors will always thrown an exception, and will not trigger a retry until the new command is sent.

If we cannot re-establish a connection after C<< reconnect >> seconds, an exception will be thrown.

=head3 C<< conservative_reconnect >>

C<< conservative_reconnect >> option makes sure that reconnection is only attempted when no pending command is ongoing. For instance, if you're doing C<<$redis->incr('key')>>, and if the server properly understood and processed the command, but the network connection is dropped just before the server replies : the command has been processed but the client doesn't know it. In this situation, if reconnect is enabled, the Redis client will reconnect and send the C command again. If it succeeds, at the end the key as been incremented two times. To avoid this issue, you can set the C<conservative_reconnect> option to a true value. In this case, the client will reconnect only if no request is pending. Otherwise it will die with the message: C.

=head3 C<< cnx_timeout >>

The C<< cnx_timeout >> option enables connection timeout. The Redis client will wait at most that number of seconds (can be fractional) before giving up connecting to a server.

=head3 C<< sentinels_cnx_timeout >>

The C<< sentinels_cnx_timeout >> option enables sentinel connection timeout. When using the sentinels feature, Redis client will wait at most that number of seconds (can be fractional) before giving up connecting to a sentinel. B: 0.1

=head3 C<< read_timeout >>

The C<< read_timeout >> option enables read timeout. The Redis client will wait at most that number of seconds (can be fractional) before giving up when reading from the server.

=head3 C<< sentinels_read_timeout >>

The C<< sentinels_read_timeout >> option enables sentinel read timeout. When using the sentinels feature, the Redis client will wait at most that number of seconds (can be fractional) before giving up when reading from a sentinel server. B: 1

=head3 C<< write_timeout >>

The C<< write_timeout >> option enables write timeout. The Redis client will wait at most that number of seconds (can be fractional) before giving up when reading from the server.

=head3 C<< sentinels_write_timeout >>

The C<< sentinels_write_timeout >> option enables sentinel write timeout. When using the sentinels feature, the Redis client will wait at most that number of seconds (can be fractional) before giving up when reading from a sentinel server. B: 1

=head3 C<< password >>

If your Redis server requires authentication, you can use the C<< password >> attribute. After each established connection (at the start or when reconnecting), the Redis C<< AUTH >> command will be send to the server. If the password is wrong, an exception will be thrown and reconnect will be disabled.

=head3 C<< on_connect >>

You can also provide a code reference that will be immediately after each successful connection. The C<< on_connect >> attribute is used to provide the code reference, and it will be called with the first parameter being the Redis object.

=head3 C<< no_auto_connect_on_new >>

You can also provide C<< no_auto_connect_on_new >> in which case C<< new >> won't call C<< $obj->connect >> for you implicitly, you'll have to do that yourself. This is useful for figuring out how long connection setup takes so you can configure the C<< cnx_timeout >> appropriately.

=head3 C<< no_sentinels_list_update >>

You can also provide C<< no_sentinels_list_update >>. By default (that is, without this option), when successfully contacting a sentinel server, the Redis client will ask it for the list of sentinels known for the given service, and merge it with its list of sentinels (in the C<< sentinels >> attribute). You can disable this behavior by setting C<< no_sentinels_list_update >> to a true value.

=head3 C<< name >>

You can also set a name for each connection. This can be very useful for debugging purposes, using the C<< CLIENT LIST >> command. To set a connection name, use the C<< name >> parameter. You can use both a scalar value or a CodeRef. If the latter, it will be called after each connection, with the Redis object, and it should return the connection name to use. If it returns a undefined value, Redis will not set the connection name.

Please note that there are restrictions on the name you can set, the most important of which is, no spaces. See the L<CLIENT SETNAME documentation|http://redis.io/commands/client-setname> for all the juicy details. This feature is safe to use with all versions of Redis servers. If C<< CLIENT SETNAME >> support is not available (Redis servers 2.6.9 and above only), the name parameter is ignored.

=head3 C<< debug >>

The C<< debug >> parameter enables debug information to STDERR, including all interactions with the server. You can also enable debug with the C<REDIS_DEBUG> environment variable.

=head1 CONNECTION HANDLING

=head2 connect

$r->connect;

Connects to the Redis server. This is done by default when the obect is constructed using C<new()>, unless C<no_auto_connect_on_new> has been set. See this option in the C<new()> constructor.

=head2 quit

$r->quit;

Closes the connection to the server. The C method does not support pipelined operation.

=head2 ping

$r->ping || die "no server?";

The C method does not support pipelined operation.

=head1 PIPELINE MANAGEMENT

=head2 wait_all_responses

Waits until all pending pipelined responses have been received, and invokes the pipeline callback for each one. See L.

=head2 wait_one_response

Waits until the first pending pipelined response has been received, and invokes its callback. See L.

=head1 PUBLISH/SUBSCRIBE COMMANDS

When one of L or L is used, the Redis object will enter I mode. When in I mode only commands in this section, plus L, will be accepted.

If you plan on using PubSub and other Redis functions, you should use two Redis objects, one dedicated to PubSub and the other for regular commands.

All Pub/Sub commands receive a callback as the last parameter. This callback receives three arguments:

=over

=item *

The published message.

=item *

The topic over which the message was sent.

=item *

The subscribed topic that matched the topic for the message. With L these last two are the same, always. But with L, this parameter tells you the pattern that matched.

=back

See the L<Pub-Sub notes|http://redis.io/topics/pubsub> for more information about the messages you will receive on your callbacks after each L, L, L and L.

=head2 publish

$r->publish($topic, $message);

Publishes the C<< $message >> to the C<< $topic >>.

=head2 subscribe

$r->subscribe( @topics_to_subscribe_to, my $savecallback = sub { my ($message, $topic, $subscribed_topic) = @_; ... }, );

Subscribe one or more topics. Messages published into one of them will be received by Redis, and the specified callback will be executed.

=head2 unsubscribe

$r->unsubscribe(@topic_list, $savecallback);

Stops receiving messages via C<$savecallback> for all the topics in C<@topic_list>. BWARNING: it is important that you give the same calleback that you used for subscribtion. The value of the CodeRef must be the same, as this is how internally the code identifies it.

=head2 psubscribe

my @topic_matches = ('prefix1.', 'prefix2.'); $r->psubscribe(@topic_matches, my $savecallback = sub { my ($m, $t, $s) = @_; ... });

Subscribes a pattern of topics. All messages to topics that match the pattern will be delivered to the callback.

=head2 punsubscribe

my @topic_matches = ('prefix1.', 'prefix2.'); $r->punsubscribe(@topic_matches, $savecallback);

Stops receiving messages via C<$savecallback> for all the topics pattern matches in C<@topic_list>. BWARNING: it is important that you give the same calleback that you used for subscribtion. The value of the CodeRef must be the same, as this is how internally the code identifies it.

=head2 is_subscriber

if ($r->is_subscriber) { say "We are in Pub/Sub mode!" }

Returns true if we are in I<Pub/Sub> mode.

=head2 wait_for_messages

my $keep_going = 1; ## Set to false somewhere to leave the loop my $timeout = 5; $r->wait_for_messages($timeout) while $keep_going;

Blocks, waits for incoming messages and delivers them to the appropriate callbacks.

Requires a single parameter, the number of seconds to wait for messages. Use 0 to wait for ever. If a positive non-zero value is used, it will return after that amount of seconds without a single notification.

Please note that the timeout is not a commitment to return control to the caller at most each C seconds, but more a idle timeout, were control will return to the caller if Redis is idle (as in no messages were received during the timeout period) for more than C seconds.

The L</wait_for_messages> call returns the number of messages processed during the run.

=head1 IMPORTANT NOTES ON METHODS

=head2 methods that return multiple values

When a method returns more than one value, it checks the context and returns either a list of values or an ArrayRef.

=head2 transaction-handling methods

BWarning: the behaviour of the TRANSACTIONS commands when combined with pipelining is still under discussion, and you should B use them at the same time just now.

You can L<follow the discussion to see the open issues with this|https://github.com/PerlRedis/perl-redis/issues/17>.

=head2 exec

my @individual_replies = $r->exec;

C has special behaviour when run in a pipeline: the C<$reply> argument to the pipeline callback is an array ref whose elements are themselves C<[$reply, $error]> pairs. This means that you can accurately detect errors yielded by any command in the transaction, and without any exceptions being thrown.

=head2 keys

my @keys = $r->keys( 'glob_pattern' ); my $keys = $r->keys( 'glob_pattern' ); # count of matching keys

Note that synchronous C calls in a scalar context return the number of matching keys (not an array ref of matching keys as you might expect). This does not apply in pipelined mode: assuming the server returns a list of keys, as expected, it is always passed to the pipeline callback as an array ref.

=head2 hashes

Hashes in Redis cannot be nested as in perl, if you want to store a nested hash, you need to serialize the hash first. If you want to have a named hash, you can use Redis-hashes. You will find an example in the tests of this module t/01-basic.t

=head2 eval

Note that this commands sends the Lua script every time you call it. See L and L</script_load> for an alternative.

=head2 info

my $info_hash = $r->info;

The C method is unique in that it decodes the server's response into a hashref, if possible. This decoding happens in both synchronous and pipelined modes.

=head1 KEYS

=head2 del

$r->del(key [key ...])

Delete a key (see Lhttp://redis.io/commands/del)

=head2 dump

$r->dump(key)

Return a serialized version of the value stored at the specified key. (see Lhttp://redis.io/commands/dump)

=head2 exists

$r->exists(key)

Determine if a key exists (see Lhttp://redis.io/commands/exists)

=head2 expire

$r->expire(key, seconds)

Set a key's time to live in seconds (see Lhttp://redis.io/commands/expire)

=head2 expireat

$r->expireat(key, timestamp)

Set the expiration for a key as a UNIX timestamp (see Lhttp://redis.io/commands/expireat)

=head2 keys

$r->keys(pattern)

Find all keys matching the given pattern (see Lhttp://redis.io/commands/keys)

=head2 migrate

$r->migrate(host, port, key, destination-db, timeout, [COPY], [REPLACE])

Atomically transfer a key from a Redis instance to another one. (see Lhttp://redis.io/commands/migrate)

=head2 move

$r->move(key, db)

Move a key to another database (see Lhttp://redis.io/commands/move)

=head2 object

$r->object(subcommand, [arguments [arguments ...]])

Inspect the internals of Redis objects (see Lhttp://redis.io/commands/object)

=head2 persist

$r->persist(key)

Remove the expiration from a key (see Lhttp://redis.io/commands/persist)

=head2 pexpire

$r->pexpire(key, milliseconds)

Set a key's time to live in milliseconds (see Lhttp://redis.io/commands/pexpire)

=head2 pexpireat

$r->pexpireat(key, milliseconds-timestamp)

Set the expiration for a key as a UNIX timestamp specified in milliseconds (see Lhttp://redis.io/commands/pexpireat)

=head2 pttl

$r->pttl(key)

Get the time to live for a key in milliseconds (see Lhttp://redis.io/commands/pttl)

=head2 randomkey

$r->randomkey()

Return a random key from the keyspace (see Lhttp://redis.io/commands/randomkey)

=head2 rename

$r->rename(key, newkey)

Rename a key (see Lhttp://redis.io/commands/rename)

=head2 renamenx

$r->renamenx(key, newkey)

Rename a key, only if the new key does not exist (see Lhttp://redis.io/commands/renamenx)

=head2 restore

$r->restore(key, ttl, serialized-value)

Create a key using the provided serialized value, previously obtained using DUMP. (see Lhttp://redis.io/commands/restore)

=head2 scan

$r->scan(cursor, [MATCH pattern], [COUNT count])

Incrementally iterate the keys space (see Lhttp://redis.io/commands/scan)

=head2 sort

$r->sort(key, [BY pattern], [LIMIT offset count], [GET pattern [GET pattern ...]], [ASC|DESC], [ALPHA], [STORE destination])

Sort the elements in a list, set or sorted set (see Lhttp://redis.io/commands/sort)

=head2 ttl

$r->ttl(key)

Get the time to live for a key (see Lhttp://redis.io/commands/ttl)

=head2 type

$r->type(key)

Determine the type stored at key (see Lhttp://redis.io/commands/type)

=head1 STRINGS

=head2 append

$r->append(key, value)

Append a value to a key (see Lhttp://redis.io/commands/append)

=head2 bitcount

$r->bitcount(key, [start end])

Count set bits in a string (see Lhttp://redis.io/commands/bitcount)

=head2 bitop

$r->bitop(operation, destkey, key [key ...])

Perform bitwise operations between strings (see Lhttp://redis.io/commands/bitop)

=head2 bitpos

$r->bitpos(key, bit, [start], [end])

Find first bit set or clear in a string (see Lhttp://redis.io/commands/bitpos)

=head2 blpop

$r->blpop(key [key ...], timeout)

Remove and get the first element in a list, or block until one is available (see Lhttp://redis.io/commands/blpop)

=head2 brpop

$r->brpop(key [key ...], timeout)

Remove and get the last element in a list, or block until one is available (see Lhttp://redis.io/commands/brpop)

=head2 brpoplpush

$r->brpoplpush(source, destination, timeout)

Pop a value from a list, push it to another list and return it; or block until one is available (see Lhttp://redis.io/commands/brpoplpush)

=head2 decr

$r->decr(key)

Decrement the integer value of a key by one (see Lhttp://redis.io/commands/decr)

=head2 decrby

$r->decrby(key, decrement)

Decrement the integer value of a key by the given number (see Lhttp://redis.io/commands/decrby)

=head2 get

$r->get(key)

Get the value of a key (see Lhttp://redis.io/commands/get)

=head2 getbit

$r->getbit(key, offset)

Returns the bit value at offset in the string value stored at key (see Lhttp://redis.io/commands/getbit)

=head2 getrange

$r->getrange(key, start, end)

Get a substring of the string stored at a key (see Lhttp://redis.io/commands/getrange)

=head2 getset

$r->getset(key, value)

Set the string value of a key and return its old value (see Lhttp://redis.io/commands/getset)

=head2 incr

$r->incr(key)

Increment the integer value of a key by one (see Lhttp://redis.io/commands/incr)

=head2 incrby

$r->incrby(key, increment)

Increment the integer value of a key by the given amount (see Lhttp://redis.io/commands/incrby)

=head2 incrbyfloat

$r->incrbyfloat(key, increment)

Increment the float value of a key by the given amount (see Lhttp://redis.io/commands/incrbyfloat)

=head2 mget

$r->mget(key [key ...])

Get the values of all the given keys (see Lhttp://redis.io/commands/mget)

=head2 mset

$r->mset(key value [key value ...])

Set multiple keys to multiple values (see Lhttp://redis.io/commands/mset)

=head2 msetnx

$r->msetnx(key value [key value ...])

Set multiple keys to multiple values, only if none of the keys exist (see Lhttp://redis.io/commands/msetnx)

=head2 psetex

$r->psetex(key, milliseconds, value)

Set the value and expiration in milliseconds of a key (see Lhttp://redis.io/commands/psetex)

=head2 set

$r->set(key, value, ['EX', seconds], ['PX', milliseconds], ['NX'|'XX'])

Set the string value of a key (see Lhttp://redis.io/commands/set). Example:

$r->set('key', 'test', 'EX', 60, 'NX')

=head2 setbit

$r->setbit(key, offset, value)

Sets or clears the bit at offset in the string value stored at key (see Lhttp://redis.io/commands/setbit)

=head2 setex

$r->setex(key, seconds, value)

Set the value and expiration of a key (see Lhttp://redis.io/commands/setex)

=head2 setnx

$r->setnx(key, value)

Set the value of a key, only if the key does not exist (see Lhttp://redis.io/commands/setnx)

=head2 setrange

$r->setrange(key, offset, value)

Overwrite part of a string at key starting at the specified offset (see Lhttp://redis.io/commands/setrange)

=head2 strlen

$r->strlen(key)

Get the length of the value stored in a key (see Lhttp://redis.io/commands/strlen)

=head1 HASHES

=head2 hdel

$r->hdel(key, field [field ...])

Delete one or more hash fields (see Lhttp://redis.io/commands/hdel)

=head2 hexists

$r->hexists(key, field)

Determine if a hash field exists (see Lhttp://redis.io/commands/hexists)

=head2 hget

$r->hget(key, field)

Get the value of a hash field (see Lhttp://redis.io/commands/hget)

=head2 hgetall

$r->hgetall(key)

Get all the fields and values in a hash (see Lhttp://redis.io/commands/hgetall)

=head2 hincrby

$r->hincrby(key, field, increment)

Increment the integer value of a hash field by the given number (see Lhttp://redis.io/commands/hincrby)

=head2 hincrbyfloat

$r->hincrbyfloat(key, field, increment)

Increment the float value of a hash field by the given amount (see Lhttp://redis.io/commands/hincrbyfloat)

=head2 hkeys

$r->hkeys(key)

Get all the fields in a hash (see Lhttp://redis.io/commands/hkeys)

=head2 hlen

$r->hlen(key)

Get the number of fields in a hash (see Lhttp://redis.io/commands/hlen)

=head2 hmget

$r->hmget(key, field [field ...])

Get the values of all the given hash fields (see Lhttp://redis.io/commands/hmget)

=head2 hmset

$r->hmset(key, field value [field value ...])

Set multiple hash fields to multiple values (see Lhttp://redis.io/commands/hmset)

=head2 hscan

$r->hscan(key, cursor, [MATCH pattern], [COUNT count])

Incrementally iterate hash fields and associated values (see Lhttp://redis.io/commands/hscan)

=head2 hset

$r->hset(key, field, value)

Set the string value of a hash field (see Lhttp://redis.io/commands/hset)

=head2 hsetnx

$r->hsetnx(key, field, value)

Set the value of a hash field, only if the field does not exist (see Lhttp://redis.io/commands/hsetnx)

=head2 hvals

$r->hvals(key)

Get all the values in a hash (see Lhttp://redis.io/commands/hvals)

=head1 SETS

=head2 sadd

$r->sadd(key, member [member ...])

Add one or more members to a set (see Lhttp://redis.io/commands/sadd)

=head2 scard

$r->scard(key)

Get the number of members in a set (see Lhttp://redis.io/commands/scard)

=head2 sdiff

$r->sdiff(key [key ...])

Subtract multiple sets (see Lhttp://redis.io/commands/sdiff)

=head2 sdiffstore

$r->sdiffstore(destination, key [key ...])

Subtract multiple sets and store the resulting set in a key (see Lhttp://redis.io/commands/sdiffstore)

=head2 sinter

$r->sinter(key [key ...])

Intersect multiple sets (see Lhttp://redis.io/commands/sinter)

=head2 sinterstore

$r->sinterstore(destination, key [key ...])

Intersect multiple sets and store the resulting set in a key (see Lhttp://redis.io/commands/sinterstore)

=head2 sismember

$r->sismember(key, member)

Determine if a given value is a member of a set (see Lhttp://redis.io/commands/sismember)

=head2 smembers

$r->smembers(key)

Get all the members in a set (see Lhttp://redis.io/commands/smembers)

=head2 smove

$r->smove(source, destination, member)

Move a member from one set to another (see Lhttp://redis.io/commands/smove)

=head2 spop

$r->spop(key)

Remove and return a random member from a set (see Lhttp://redis.io/commands/spop)

=head2 srandmember

$r->srandmember(key, [count])

Get one or multiple random members from a set (see Lhttp://redis.io/commands/srandmember)

=head2 srem

$r->srem(key, member [member ...])

Remove one or more members from a set (see Lhttp://redis.io/commands/srem)

=head2 sscan

$r->sscan(key, cursor, [MATCH pattern], [COUNT count])

Incrementally iterate Set elements (see Lhttp://redis.io/commands/sscan)

=head2 sunion

$r->sunion(key [key ...])

Add multiple sets (see Lhttp://redis.io/commands/sunion)

=head2 sunionstore

$r->sunionstore(destination, key [key ...])

Add multiple sets and store the resulting set in a key (see Lhttp://redis.io/commands/sunionstore)

=head1 SORTED SETS

=head2 zadd

$r->zadd(key, score member [score member ...])

Add one or more members to a sorted set, or update its score if it already exists (see Lhttp://redis.io/commands/zadd)

=head2 zcard

$r->zcard(key)

Get the number of members in a sorted set (see Lhttp://redis.io/commands/zcard)

=head2 zcount

$r->zcount(key, min, max)

Count the members in a sorted set with scores within the given values (see Lhttp://redis.io/commands/zcount)

=head2 zincrby

$r->zincrby(key, increment, member)

Increment the score of a member in a sorted set (see Lhttp://redis.io/commands/zincrby)

=head2 zinterstore

$r->zinterstore(destination, numkeys, key [key ...], [WEIGHTS weight [weight ...]], [AGGREGATE SUM|MIN|MAX])

Intersect multiple sorted sets and store the resulting sorted set in a new key (see Lhttp://redis.io/commands/zinterstore)

=head2 zlexcount

$r->zlexcount(key, min, max)

Count the number of members in a sorted set between a given lexicographical range (see Lhttp://redis.io/commands/zlexcount)

=head2 zrange

$r->zrange(key, start, stop, [WITHSCORES])

Return a range of members in a sorted set, by index (see Lhttp://redis.io/commands/zrange)

=head2 zrangebylex

$r->zrangebylex(key, min, max, [LIMIT offset count])

Return a range of members in a sorted set, by lexicographical range (see Lhttp://redis.io/commands/zrangebylex)

=head2 zrangebyscore

$r->zrangebyscore(key, min, max, [WITHSCORES], [LIMIT offset count])

Return a range of members in a sorted set, by score (see Lhttp://redis.io/commands/zrangebyscore)

=head2 zrank

$r->zrank(key, member)

Determine the index of a member in a sorted set (see Lhttp://redis.io/commands/zrank)

=head2 zrem

$r->zrem(key, member [member ...])

Remove one or more members from a sorted set (see Lhttp://redis.io/commands/zrem)

=head2 zremrangebylex

$r->zremrangebylex(key, min, max)

Remove all members in a sorted set between the given lexicographical range (see Lhttp://redis.io/commands/zremrangebylex)

=head2 zremrangebyrank

$r->zremrangebyrank(key, start, stop)

Remove all members in a sorted set within the given indexes (see Lhttp://redis.io/commands/zremrangebyrank)

=head2 zremrangebyscore

$r->zremrangebyscore(key, min, max)

Remove all members in a sorted set within the given scores (see Lhttp://redis.io/commands/zremrangebyscore)

=head2 zrevrange

$r->zrevrange(key, start, stop, [WITHSCORES])

Return a range of members in a sorted set, by index, with scores ordered from high to low (see Lhttp://redis.io/commands/zrevrange)

=head2 zrevrangebylex

$r->zrevrangebylex(key, max, min, [LIMIT offset count])

Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings. (see Lhttp://redis.io/commands/zrevrangebylex)

=head2 zrevrangebyscore

$r->zrevrangebyscore(key, max, min, [WITHSCORES], [LIMIT offset count])

Return a range of members in a sorted set, by score, with scores ordered from high to low (see Lhttp://redis.io/commands/zrevrangebyscore)

=head2 zrevrank

$r->zrevrank(key, member)

Determine the index of a member in a sorted set, with scores ordered from high to low (see Lhttp://redis.io/commands/zrevrank)

=head2 zscan

$r->zscan(key, cursor, [MATCH pattern], [COUNT count])

Incrementally iterate sorted sets elements and associated scores (see Lhttp://redis.io/commands/zscan)

=head2 zscore

$r->zscore(key, member)

Get the score associated with the given member in a sorted set (see Lhttp://redis.io/commands/zscore)

=head2 zunionstore

$r->zunionstore(destination, numkeys, key [key ...], [WEIGHTS weight [weight ...]], [AGGREGATE SUM|MIN|MAX])

Add multiple sorted sets and store the resulting sorted set in a new key (see Lhttp://redis.io/commands/zunionstore)

=head1 HYPERLOGLOG

=head2 pfadd

$r->pfadd(key, element [element ...])

Adds the specified elements to the specified HyperLogLog. (see Lhttp://redis.io/commands/pfadd)

=head2 pfcount

$r->pfcount(key [key ...])

Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s). (see Lhttp://redis.io/commands/pfcount)

=head2 pfmerge

$r->pfmerge(destkey, sourcekey [sourcekey ...])

Merge N different HyperLogLogs into a single one. (see Lhttp://redis.io/commands/pfmerge)

=head1 PUB/SUB

=head2 pubsub

$r->pubsub(subcommand, [argument [argument ...]])

Inspect the state of the Pub/Sub subsystem (see Lhttp://redis.io/commands/pubsub)

=head1 TRANSACTIONS

=head2 discard

$r->discard()

Discard all commands issued after MULTI (see Lhttp://redis.io/commands/discard)

=head2 exec

$r->exec()

Execute all commands issued after MULTI (see Lhttp://redis.io/commands/exec)

=head2 multi

$r->multi()

Mark the start of a transaction block (see Lhttp://redis.io/commands/multi)

=head2 unwatch

$r->unwatch()

Forget about all watched keys (see Lhttp://redis.io/commands/unwatch)

=head2 watch

$r->watch(key [key ...])

Watch the given keys to determine execution of the MULTI/EXEC block (see Lhttp://redis.io/commands/watch)

=head1 SCRIPTING

=head2 eval

$r->eval(script, numkeys, key [key ...], arg [arg ...])

Execute a Lua script server side (see Lhttp://redis.io/commands/eval)

=head2 evalsha

$r->evalsha(sha1, numkeys, key [key ...], arg [arg ...])

Execute a Lua script server side (see Lhttp://redis.io/commands/evalsha)

=head2 script_exists

$r->script_exists(script [script ...])

Check existence of scripts in the script cache. (see Lhttp://redis.io/commands/script-exists)

=head2 script_flush

$r->script_flush()

Remove all the scripts from the script cache. (see Lhttp://redis.io/commands/script-flush)

=head2 script_kill

$r->script_kill()

Kill the script currently in execution. (see Lhttp://redis.io/commands/script-kill)

=head2 script_load

$r->script_load(script)

Load the specified Lua script into the script cache. (see Lhttp://redis.io/commands/script-load)

=head1 CONNECTION

=head2 auth

$r->auth(password)

Authenticate to the server (see Lhttp://redis.io/commands/auth)

=head2 echo

$r->echo(message)

Echo the given string (see Lhttp://redis.io/commands/echo)

=head2 ping

$r->ping()

Ping the server (see Lhttp://redis.io/commands/ping)

=head2 quit

$r->quit()

Close the connection (see Lhttp://redis.io/commands/quit)

=head2 select

$r->select(index)

Change the selected database for the current connection (see Lhttp://redis.io/commands/select)

=head1 SERVER

=head2 bgrewriteaof

$r->bgrewriteaof()

Asynchronously rewrite the append-only file (see Lhttp://redis.io/commands/bgrewriteaof)

=head2 bgsave

$r->bgsave()

Asynchronously save the dataset to disk (see Lhttp://redis.io/commands/bgsave)

=head2 client_getname

$r->client_getname()

Get the current connection name (see Lhttp://redis.io/commands/client-getname)

=head2 client_kill

$r->client_kill([ip:port], [ID client-id], [TYPE normal|slave|pubsub], [ADDR ip:port], [SKIPME yes/no])

Kill the connection of a client (see Lhttp://redis.io/commands/client-kill)

=head2 client_list

$r->client_list()

Get the list of client connections (see Lhttp://redis.io/commands/client-list)

=head2 client_pause

$r->client_pause(timeout)

Stop processing commands from clients for some time (see Lhttp://redis.io/commands/client-pause)

=head2 client_setname

$r->client_setname(connection-name)

Set the current connection name (see Lhttp://redis.io/commands/client-setname)

=head2 cluster_slots

$r->cluster_slots()

Get array of Cluster slot to node mappings (see Lhttp://redis.io/commands/cluster-slots)

=head2 command

$r->command()

Get array of Redis command details (see Lhttp://redis.io/commands/command)

=head2 command_count

$r->command_count()

Get total number of Redis commands (see Lhttp://redis.io/commands/command-count)

=head2 command_getkeys

$r->command_getkeys()

Extract keys given a full Redis command (see Lhttp://redis.io/commands/command-getkeys)

=head2 command_info

$r->command_info(command-name [command-name ...])

Get array of specific Redis command details (see Lhttp://redis.io/commands/command-info)

=head2 config_get

$r->config_get(parameter)

Get the value of a configuration parameter (see Lhttp://redis.io/commands/config-get)

=head2 config_resetstat

$r->config_resetstat()

Reset the stats returned by INFO (see Lhttp://redis.io/commands/config-resetstat)

=head2 config_rewrite

$r->config_rewrite()

Rewrite the configuration file with the in memory configuration (see Lhttp://redis.io/commands/config-rewrite)

=head2 config_set

$r->config_set(parameter, value)

Set a configuration parameter to the given value (see Lhttp://redis.io/commands/config-set)

=head2 dbsize

$r->dbsize()

Return the number of keys in the selected database (see Lhttp://redis.io/commands/dbsize)

=head2 debug_object

$r->debug_object(key)

Get debugging information about a key (see Lhttp://redis.io/commands/debug-object)

=head2 debug_segfault

$r->debug_segfault()

Make the server crash (see Lhttp://redis.io/commands/debug-segfault)

=head2 flushall

$r->flushall()

Remove all keys from all databases (see Lhttp://redis.io/commands/flushall)

=head2 flushdb

$r->flushdb()

Remove all keys from the current database (see Lhttp://redis.io/commands/flushdb)

=head2 info

$r->info([section])

Get information and statistics about the server (see Lhttp://redis.io/commands/info)

=head2 lastsave

$r->lastsave()

Get the UNIX time stamp of the last successful save to disk (see Lhttp://redis.io/commands/lastsave)

=head2 lindex

$r->lindex(key, index)

Get an element from a list by its index (see Lhttp://redis.io/commands/lindex)

=head2 linsert

$r->linsert(key, BEFORE|AFTER, pivot, value)

Insert an element before or after another element in a list (see Lhttp://redis.io/commands/linsert)

=head2 llen

$r->llen(key)

Get the length of a list (see Lhttp://redis.io/commands/llen)

=head2 lpop

$r->lpop(key)

Remove and get the first element in a list (see Lhttp://redis.io/commands/lpop)

=head2 lpush

$r->lpush(key, value [value ...])

Prepend one or multiple values to a list (see Lhttp://redis.io/commands/lpush)

=head2 lpushx

$r->lpushx(key, value)

Prepend a value to a list, only if the list exists (see Lhttp://redis.io/commands/lpushx)

=head2 lrange

$r->lrange(key, start, stop)

Get a range of elements from a list (see Lhttp://redis.io/commands/lrange)

=head2 lrem

$r->lrem(key, count, value)

Remove elements from a list (see Lhttp://redis.io/commands/lrem)

=head2 lset

$r->lset(key, index, value)

Set the value of an element in a list by its index (see Lhttp://redis.io/commands/lset)

=head2 ltrim

$r->ltrim(key, start, stop)

Trim a list to the specified range (see Lhttp://redis.io/commands/ltrim)

=head2 monitor

$r->monitor()

Listen for all requests received by the server in real time (see Lhttp://redis.io/commands/monitor)

=head2 role

$r->role()

Return the role of the instance in the context of replication (see Lhttp://redis.io/commands/role)

=head2 rpop

$r->rpop(key)

Remove and get the last element in a list (see Lhttp://redis.io/commands/rpop)

=head2 rpoplpush

$r->rpoplpush(source, destination)

Remove the last element in a list, append it to another list and return it (see Lhttp://redis.io/commands/rpoplpush)

=head2 rpush

$r->rpush(key, value [value ...])

Append one or multiple values to a list (see Lhttp://redis.io/commands/rpush)

=head2 rpushx

$r->rpushx(key, value)

Append a value to a list, only if the list exists (see Lhttp://redis.io/commands/rpushx)

=head2 save

$r->save()

Synchronously save the dataset to disk (see Lhttp://redis.io/commands/save)

=head2 shutdown

$r->shutdown([NOSAVE], [SAVE])

Synchronously save the dataset to disk and then shut down the server (see Lhttp://redis.io/commands/shutdown)

=head2 slaveof

$r->slaveof(host, port)

Make the server a slave of another instance, or promote it as master (see Lhttp://redis.io/commands/slaveof)

=head2 slowlog

$r->slowlog(subcommand, [argument])

Manages the Redis slow queries log (see Lhttp://redis.io/commands/slowlog)

=head2 sync

$r->sync()

Internal command used for replication (see Lhttp://redis.io/commands/sync)

=head2 time

$r->time()

Return the current server time (see Lhttp://redis.io/commands/time)

=head1 ACKNOWLEDGEMENTS

The following persons contributed to this project (random order):

=over

=item *

Aaron Crane (pipelining and AUTOLOAD caching support)

=item *

Dirk Vleugels

=item *

Flavio Poletti

=item *

Jeremy Zawodny

=item *

sunnavy at bestpractical.com

=item *

Thiago Berlitz Rondon

=item *

Ulrich Habel

=item *

Ivan Kruglov

=item *

Steffen Mueller [email protected]

=back

=head1 AUTHORS

=over 4

=item *

Pedro Melo [email protected]

=item *

Damien Krotkine [email protected]

=back

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2015 by Pedro Melo, Damien Krotkine.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

=cut