v1.6.0

v1.6.0

Author: cheprasov

.travis.yml

@@ -15,8 +15,13 @@ matrix:
 services:
   - docker
 
+install:
+   - composer install
+
 before_install:
    - docker pull cheprasov/redis-for-tests:latest;
+   - docker pull cheprasov/redis-cluster-for-tests:latest;
+
    - |
       docker run -i -t -d \
         -p 127.0.0.1:6381:6381 \
@@ -27,9 +32,22 @@ before_install:
         -p 127.0.0.1:6386:6386 \
         -p 127.0.0.1:6387:6387 \
         -p 127.0.0.1:6388:6388 \
+        -p 127.0.0.1:6389:6389 \
+        -p 127.0.0.1:6390:6390 \
         cheprasov/redis-for-tests
+
+   - |
+      docker run -i -t -d \
+        -p 127.0.0.1:7001:7001 \
+        -p 127.0.0.1:7002:7002 \
+        -p 127.0.0.1:7003:7003 \
+        -p 127.0.0.1:7004:7004 \
+        -p 127.0.0.1:7005:7005 \
+        -p 127.0.0.1:7006:7006 \
+        cheprasov/redis-cluster-for-tests
+
    - docker ps;
-   - sleep 2;
+   - sleep 5;
 
-install:
-   - composer install
+before_script:
+   - if [[ $TRAVIS_PHP_VERSION = 'hhvm' ]] ; then rm ./tests/Unit/Client/AbstractRedisClientIsolatedTest.php; fi;

CHANGELOG.md

@@ -1,5 +1,12 @@
 ## CHANGELOG
 
+### v1.6.0 (2017-01-07)
+- Added support for Redis 4.0 (the Client was tested with Redis 4.0 RC2).
+- Added support for Redis Cluster.
+- Added method **_syncClusterSlotsFromRedisServer** for RedisClient.
+- Added command **SWAPDB**, **UNLINK**, **MEMORY** for Redis >= 4.0
+- Updated command **FLUSHALL**, **FLUSHDB** for Redis >= 4.0
+
 ### v1.5.1 (2016-08-17)
 - Fixed critical bug: https://github.com/cheprasov/php-redis-client/pull/45 Thanks to @BrianFranklin for help.
 

README.md

@@ -1,31 +1,33 @@
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 [![Latest Stable Version](https://poser.pugx.org/cheprasov/php-redis-client/v/stable)](https://packagist.org/packages/cheprasov/php-redis-client)
 [![Total Downloads](https://poser.pugx.org/cheprasov/php-redis-client/downloads)](https://packagist.org/packages/cheprasov/php-redis-client)
-# RedisClient v1.5.1 for PHP >= 5.5
+# RedisClient v1.6.0 for PHP >= 5.5
 
 ## About
-RedisClient is a fast, fully-functional and user-friendly client for Redis, optimized for performance. RedisClient supports the latest versions of Redis starting from __2.6__ to __3.2__
+RedisClient is a fast, fully-functional and user-friendly client for Redis, optimized for performance. RedisClient supports the latest versions of Redis starting from __2.6__ to __4.0__
 
 ## Main features
-- Support Redis versions from __2.6__ to __3.2.x__.
+- Support Redis versions from __2.6.x__ to __4.0.x__.
 - Support __TCP/IP__ and __UNIX__ sockets.
 - Support __PubSub__ and __Monitor__ functionallity.
 - Support __Pipeline__ and __Transactions__.
+- Support __Redis Cluster__.
 - Support __RAW__ commands as strings `"SET foo bar"` or as arrays `['SET', 'foo', 'bar']`.
 - Connections to Redis are established lazily by the client upon the first command.
 - Easy to use with IDE, client has PHPDocs for all supported versions.
-- By default, the client works with the latest stable version of Redis (3.2.x).
+- By default, the client works with the latest stable version of Redis (3.2).
 - About **6.5-8.5% faster** than predis (based on this test: https://github.com/cheprasov/php-redis-client-vs-predis-test)
-- Client was tested on the next versions of Redis: 2.6.17, 2.8.24, 3.0.7, 3.2.4 (and older).
+- Client was tested on the next versions of Redis: 2.6.17, 2.8.24, 3.0.7, 3.2.6, 4.0 RC2 (and other).
+- Also, Client was tested on PHP 5.5, 5.6, 7.0, 7.1, HHVM.
 
 ## Usage
 
 ### Config
 
-```
-$Redis = ClientFactory::create([
-    // Optional. Default = 'tcp://127.0.0.1:6379'. You can use 'unix:///tmp/redis.sock'
-    'server' => 'tcp://127.0.0.1:6379',
+```php
+$config = [
+    // Optional. Default = '127.0.0.1:6379'. You can use 'unix:///tmp/redis.sock'
+    'server' => '127.0.0.1:6379',
 
     // Optional. Default = 1
     'timeout' => 2,
@@ -36,62 +38,97 @@ $Redis = ClientFactory::create([
     // Optional. Use it only if Redis server requires password (AUTH)
     'password' => 'some-password',
 
-    // Use it, if you want to select not default db (db != 0) on connect
+    // Optional. Use it, if you want to select not default db (db != 0) on connect
     'database' => 1,
-]);
+
+    // Optional. Array with configs for RedisCluster support
+    'cluster' => [
+        'enabled' => false,
+
+        // Optional. Default = []. Map of cluster slots and servers
+        // array(max_slot => server [, ...])
+        // Examples for Cluster with 3 Nodes:
+        'clusters' => [
+            5460  => '127.0.0.1:7001', // slots from 0 to 5460
+            10922 => '127.0.0.1:7002', // slots from 5461 to 10922
+            16383 => '127.0.0.1:7003', // slots from 10923 to 16383
+        ],
+
+        // Optional. Default = false.
+        // Use the param to update cluster slot map below on init RedisClient.
+        // RedisClient will execute command CLUSTER SLOTS to get map.
+        'init_on_start' => false,
+
+        // Optional. Default = false.
+        // If Redis returns error -MOVED then RedisClient will execute
+        // command CLUSTER SLOTS to update cluster slot map
+        'init_on_error_moved' => true,
+
+        // Optional. Defatult = 0.25 sec. It is timeout before next attempt on TRYAGAIN error.
+        'timeout_on_error_tryagain' => 0.25, // sec
+    ]
+];
 ```
 
 ### Create a new instance of RedisClient
 ```php
 <?php
+namespace Examples;
+
 require (dirname(__DIR__).'/vendor/autoload.php');
 // or require (dirname(__DIR__).'/src/autoloader.php');
 
 use RedisClient\RedisClient;
 use RedisClient\Client\Version\RedisClient2x6;
+use RedisClient\ClientFactory;
 
 // Example 1. Create new Instance for Redis version 2.8.x with config via factory
-
 $Redis = ClientFactory::create([
-    'server' => 'tcp://127.0.0.1:6379', // or 'unix:///tmp/redis.sock'
+    'server' => '127.0.0.1:6379', // or 'unix:///tmp/redis.sock'
     'timeout' => 2,
     'version' => '2.8.24'
 ]);
 
-echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL;
-// RedisClient: 2.8
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL; // RedisClient: 2.8
 
 
-// Example 2. Create new Instance for Redis version 2.6.x with config
+// Example 2. Create new Instance without config. Client will use default config.
+$Redis = new RedisClient();
+// By default, the client works with the latest stable version of Redis.
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL; // RedisClient: 3.2
+echo 'Redis: '. $Redis->info('Server')['redis_version'] . PHP_EOL; // Redis: 3.0.3
 
-$Redis = new RedisClient2x6([
-    'server' => 'tcp://127.0.0.1:6379', // or 'unix:///tmp/redis.sock'
+
+// Example 3. Create new Instance with config
+// By default, the client works with the latest stable version of Redis.
+$Redis = new RedisClient([
+    'server' => '127.0.0.1:6387', // or 'unix:///tmp/redis.sock'
     'timeout' => 2
 ]);
 
-echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL;
-// RedisClient: 2.6
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL; // RedisClient: 3.2
+echo 'Redis: '. $Redis->info('Server')['redis_version'] . PHP_EOL; // Redis: 3.2.0
 
 
-// Example 3. Create new instance of client without factory
-
-$Redis = new RedisClient([
+// Example 4. Create new Instance for Redis version 2.6.x with config
+$Redis = new RedisClient2x6([
     'server' => 'tcp://127.0.0.1:6379', // or 'unix:///tmp/redis.sock'
     'timeout' => 2
 ]);
 
-echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL;
-echo 'Redis: '. $Redis->info('Server')['redis_version'] . PHP_EOL;
-
-// By default, the client works with the latest stable version of Redis.
-// RedisClient: 3.2
-// Redis: 3.2.4
-
+echo 'RedisClient: '. $Redis->getSupportedVersion() . PHP_EOL; // RedisClient: 2.6
 
 ```
 ### Example
 Please, see examples here: https://github.com/cheprasov/php-redis-client/tree/master/examples
 
+- [Create new instance](https://github.com/cheprasov/php-redis-client/tree/master/examples/create_new_instance.php)
+- [Using MONITOR](https://github.com/cheprasov/php-redis-client/tree/master/examples/monitor.php)
+- [Publish and Subscribe](https://github.com/cheprasov/php-redis-client/tree/master/examples/pubsub.php)
+- [Transactions](https://github.com/cheprasov/php-redis-client/tree/master/examples/transactions.php)
+- [Pipeline](https://github.com/cheprasov/php-redis-client/tree/master/examples/pipeline.php)
+- [Cluster support](https://github.com/cheprasov/php-redis-client/tree/master/examples/clusters.php)
+- [RAW Commands](https://github.com/cheprasov/php-redis-client/tree/master/examples/raw_commands.php)
 
 ## Installation
 
@@ -107,13 +144,12 @@ and add dependency to your project:
 
 ## Running tests
 
-1. Use Docker container with Redis for tests https://hub.docker.com/r/cheprasov/redis-for-tests/
-2. To run tests type in console (do not forget run Docker):
-    
+1. Run Docker container with Redis for tests https://hub.docker.com/r/cheprasov/redis-for-tests/
+2. Run Docker container with Redis Cluster for tests https://hub.docker.com/r/cheprasov/redis-cluster-for-tests/
+3. To run tests type in console:
 
     ./vendor/bin/phpunit
 
-
 ## Something doesn't work
 
 Feel free to fork project, fix bugs and finally request for pull

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "cheprasov/php-redis-client",
-  "version": "1.5.1",
-  "description": "Php client for Redis. It is a fast, fully-functional and user-friendly client for Redis, optimized for performance. RedisClient supports the latest versions of Redis starting from 2.6 to 3.2",
+  "version": "1.6.0",
+  "description": "Php client for Redis. It is a fast, fully-functional and user-friendly client for Redis, optimized for performance. RedisClient supports the latest versions of Redis starting from 2.6 to 4.0",
   "homepage": "http://github.com/cheprasov/php-redis-client",
   "minimum-stability": "stable",
   "license": "MIT",

examples/clusters.php

@@ -0,0 +1,136 @@
+<?php
+/**
+ * This file is part of RedisClient.
+ * git: https://github.com/cheprasov/php-redis-client
+ *
+ * (C) Alexander Cheprasov <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * Cluster
+ */
+
+namespace Examples;
+
+require (dirname(__DIR__).'/vendor/autoload.php');
+// or require (dirname(__DIR__).'/src/autoloader.php');
+
+use RedisClient\ClientFactory;
+use RedisClient\Cluster\ClusterMap;
+
+// Example 1. Create RedisClient with Cluster support;
+$RedisClient = ClientFactory::create([
+    'server' => '127.0.0.1:7001', // Default server for connection
+    'cluster' => [
+        'enabled' => true
+    ]
+]);
+print_r($RedisClient->clusterInfo());
+/*
+cluster_state:ok
+cluster_slots_assigned:16384
+cluster_slots_ok:16384
+cluster_slots_pfail:0
+cluster_slots_fail:0
+cluster_known_nodes:6
+cluster_size:3
+cluster_current_epoch:6
+cluster_my_epoch:1
+cluster_stats_messages_sent:472694
+cluster_stats_messages_received:472694
+ */
+
+
+// Example 2. Create RedisClient with Cluster Slot Map;
+$RedisClient = ClientFactory::create([
+    'server' => '127.0.0.1:7001', // Default server for connection
+    'cluster' => [
+        'enabled' => true,
+        'clusters' => [
+            5460  => '127.0.0.1:7001', // slots from 0 to 5460
+            10922 => '127.0.0.1:7002', // slots from 5461 to 10922
+            16383 => '127.0.0.1:7003', // slots from 10923 to 16383
+        ],
+    ]
+]);
+
+
+// Example 3. Get Cluster Slot Map from Redis Server on init RedisClient
+$RedisClient = ClientFactory::create([
+    'server' => '127.0.0.1:7001', // Default server for connection
+    'cluster' => [
+        'enabled' => true,
+        // Use the param to update cluster slot map below on init RedisClient.
+        // RedisClient will execute command CLUSTER SLOTS to get map.
+        'init_on_start' => true,
+    ]
+]);
+
+
+// Example 4. Get Cluster Slot Map from Redis Server by command
+$RedisClient = ClientFactory::create([
+    'server' => '127.0.0.1:7001', // Default server for connection
+    'cluster' => [
+        'enabled' => true,
+    ]
+]);
+// Use this command to sync Cluster Slot Map from Redis Server
+$RedisClient->_syncClusterSlotsFromRedisServer();
+
+
+// Example 5. Pseudo Redis Cluster.
+// If you use several Redis Servers without Cluster,
+// you can use RedisClient's cluster config just for sharding keys by the Cluster rulers.
+$RedisClient = ClientFactory::create([
+    'server' => '127.0.0.1:6381', // Default server for connection
+    'cluster' => [
+        'enabled' => true,
+        'clusters' => [
+            5460  => '127.0.0.1:6381', // slots from 0 to 5460
+            10922 => '127.0.0.1:6383', // slots from 5461 to 10922
+            16383 => '127.0.0.1:6385', // slots from 10923 to 16383
+        ],
+    ]
+]);
+$RedisClient->set('foo', 'foo-42');
+echo ClusterMap::getSlotByKey('foo') . PHP_EOL; // 12182
+
+$RedisClient->set('bar', 'bar-42');
+echo ClusterMap::getSlotByKey('bar') . PHP_EOL; // 5061
+
+echo $RedisClient->get('foo') . PHP_EOL; // foo-42
+echo $RedisClient->get('bar') . PHP_EOL; // bar-42
+
+// But, be careful with multi operation for pseudo Clusters,
+print_r($RedisClient->mget(['foo', 'bar'])); // ['foo-42', null]
+print_r($RedisClient->mget(['bar', 'foo'])); // ['bar-42', null]
+
+
+// Example 6. Each connection to Redis Server uses the same config.
+// For example, use can use password for all servers
+$RedisClient = ClientFactory::create([
+    'server' => '127.0.0.1:6382', // Default server for connection
+    'timeout' => 2,
+    'password' => 'test-password-123',
+    'cluster' => [
+        'enabled' => true,
+        'clusters' => [
+            5460  => '127.0.0.1:6382', // slots from 0 to 5460
+            10922 => '127.0.0.1:6384', // slots from 5461 to 10922
+            16383 => '127.0.0.1:6386', // slots from 10923 to 16383
+        ],
+    ]
+]);
+$RedisClient->set('foo', 'foo-43');
+echo ClusterMap::getSlotByKey('foo') . PHP_EOL; // 12182
+
+$RedisClient->set('bar', 'bar-43');
+echo ClusterMap::getSlotByKey('bar') . PHP_EOL; // 5061
+
+echo $RedisClient->get('foo') . PHP_EOL; // foo-42
+echo $RedisClient->get('bar') . PHP_EOL; // bar-42
+
+