phpredis -- Redis Arrays用法

Redis Arrays

来自地址：https://github.com/phpredis/phpredis/blob/master/arrays.markdown#readme

扩展原文件arrays.markdown也说明了redis arrays用法。英文不好，见谅。

一个Redis的数组是个孤立的命名空间，在其中键以某种方式相关。键被分布在多个Redis的实例上，使用一致的散列（hash)。一个哈希函数用于散布keys在array里，以保持均匀分布。这个特性的加入是一个慷慨的赞助商帮助的结果A+E Networks.。

一个array是由以下内容组成：

• Redis的主机列表。
• 一个“键”提取函数，用于散列一个key的部分,以便发布关联的keys在同一节点(可选)。这是由“function”的选项设置。
  • 　　eg: 如下key: key_abc, key_ccd,key_ecffff, 可以只散列头三个key,这样他们会散列到一个节点。
• 以前在环中的节点列表，节点被添加或删除后才呈现。当读命令被发送到array（例如，GET，LRANGE ...），键首先在主环queryied，如果它在主环没有被发现则在二级环。或者，发生这种情况时该键可以自动迁移。写命令会一直去主环。This is set by the "previous" option.
• 一个可选索引在每一个设置的redis节点，用于当节点被添加或删除时迁移key.在“index”选项设置。
• 一个选项来自动rehash的数组当节点添加或删除，由“autorehash”选项设置。

创建一个数组

有建立Redis阵列的多种方式; 它们可以被预先定义在redis.ini使用新RedisArray（string $name）;或使用动态创建新RedisArray（array $hosts, array $options）;

声明新阵列节点的列表 - Declaring a new array with a list of nodes

$ra = new RedisArray(array("host1", "host2:63792", "host2:6380"));

声明新阵列节点列表和一个函数来提取key 的一部分

function extract_key_part($k) {
    return substr($k, 0, 3);    // hash only on first 3 characters.
}
$ra = new RedisArray(array("host1", "host2:63792", "host2:6380"), array("function" => "extract_key_part"));

定义“以前的”阵列时，节点被添加或删除。-Defining a "previous" array when nodes are added or removed.

当一个新的节点添加到一个数组，phpredis需要知道它。节点的旧列表变成“previous”数组，节点的新列表作为主环。当一个节点已添加后，一些读命令将指向错误的节点，此时将需要在先前的环查找key。

// adding host3 to a ring containing host1 and host2. Read commands will look in the previous ring if the data is not found in the main ring.
$ra = new RedisArray(array("host1", "host2", "host3"), array("previous" => array("host1", "host2")));

指定“retry_interval的”参数

retry_interval的用于指定当客户失去与服务器连接时重新连接的延迟的时间.

//超时的重试等待时间，毫秒
$ra = new RedisArray(array("host1", "host2:63792", "host2:6380"), array("retry_timeout" => 100)));

指定“lazy_connect”参数

此选项很有用。当一个集群里有很多shards，但不是他们没必要同时使用。

//是否在需要操作某个Redis instance上的数据时，才建立连接
$ra = new RedisArray(array("host1", "host2:63792", "host2:6380"), array("lazy_connect" => true));

在Redis.ini定义数组

由于php.ini中的参数必须预先定义，Redis的数组都必须共享相同的.ini设置。

// list available Redis Arrays
ini_set('redis.array.names', 'users,friends');

// set host names for each array.
ini_set('redis.arrays.hosts', 'users[]=localhost:6379&users[]=localhost:6380&users[]=localhost:6381&users[]=localhost:6382&friends[]=localhost');

// set functions
ini_set('redis.arrays.functions', 'users=user_hash');

// use index only for users
ini_set('redis.arrays.index', 'users=1,friends=0');

用法

Redis arrays 可以像Redis对象那样使用：

$ra = new RedisArray("users");
$ra->set("user1:name", "Joe");
$ra->set("user2:name", "Mike");

键散列 - Key hashing

默认情况下，为了与其他库兼容，phpredis将尝试找到key name中的大括号括起来的子串，并用它来分发数据。

例如，键“{user:1}:name”和“{user:1}:email”将被存储在同一台服务器上，因为只有“user:1”将被散列。您可以在Redis的阵列“function”选项提供自定义的函数名; 这个函数都会被调用的关键需要被散列的时间。它应该采取一个字符串，并返回一个字符串。

自定义键分布函数 - Custom key distribution function

为了手工的控制键的分布，就可以提供一个自定义function或闭包，返回服务器号 - 即 创建 RedisArray对象时 服务器数组的索引。

例如，实例化一个RedisArray对象new RedisArray(array("us-host", "uk-host", "de-host")，array("distributor" => "dist"));写一个调用的函数“DIST”将返回2为所有的键应该结束于“de-host”服务器上。

例

$ra = new RedisArray(array("host1", "host2", "host3", "host4", "host5", "host6", "host7", "host8"), array("distributor" => array(2, 2)));

此声明，我们开始与2碎片，并转移到4，然后8碎片。初始碎片的数目为2和resharding水平（或迭代次数）为2。

迁移键 - Migrating keys

当一个节点从环添加或删除，RedisArray实例必须被实例与节点的“previous”列表中。一个单独的调用 `$ra->_rehash()`使所有的key根据新列表的节点重新分配。传递一个回调函数到_rehash()使得可以跟踪操作的进度：该函数参数是要检查的 节点名称 和 键数量 ，

e.g. `_rehash(function ($host, $count){ ... });`

可以自动完成这一过程，通过设置'autorehash'=> TRUE在构造函数中的选项。这将导致键的迁移当需要将它们从先前阵列读取时。

为了迁移按键，它们都必须进行检查和重新处理。如果设置了“index”选项，一个key每个节点列出目前所有键。否则，KEYS命令被用于列出它们。

如果提供服务器的“先前”列表中，将使用它作为备份环时密钥不能在当前的环中找到。写操作会一 ​​直去新环，而读取将进入新的环第一，和第二环作为备份。

添加和/或删除多个实例被支持。

例

$ra = new RedisArray("users"); // load up a new config from redis.ini, using the “.previous” listing.
$ra->_rehash();

运行该代码：

• 创建一个节点的更新列表中选择一个新的环。
• 通过服务器服务器，查找在节点的前一个列表中的所有键。
• 老调重弹每个按键，并可能将其移动到另一台服务器。
• 更新与节点的新列表数组对象。

Multi/exec

多/ EXEC仍然可用，但必须在一个节点上运行：

$host = $ra->_target("{users}:user1:name"); // find host first
$ra->multi($host)   // then run transaction on that host.
   ->del("{users}:user1:name")
   ->srem("{users}:index", "user1")
   ->exec();

限制 - Limitations

使用跨越多个键的Redis的命令时，key arrays没有提供任何保证。除了使用MGET，MSET，和DEL的情况。一个单一的实例将被使用，并读出或写入存在的所有键。在RedisArray对象中运行键（）将在每个节点上执行命令和返回键的关联数组，通过主机名进行索引。

阵列信息

RedisArray对象提供了几种方法，以帮助了解群集的状态。这些方法以下划线开头。

• $ra->_hosts() → 返回所选阵列的主机的
• $ra->_function() → 返回用于在一致的散列提取关键部位的功能的名称。
• $ra->_target($key) → 返回到用于规定密钥的主机。
• $ra->_instance($host)→ 返回连接到特定的节点Redis的实例; 与使用_target得到一个Redis的对象。

运行单元测试

$ cd tests
$ ./mkring.sh start
$ php array-tests.php