Загрузка phpredis json - Загрузка исходного кода phpredis json

phpredis json

Другие категории

1.0.0

Скачать

Phpredis-JSON

RedisJson с расширением PHP Redis phpredis.

Введение

Phpredis-JSON предоставляет полный набор команд для модуля RedisJson. Он построен на основе phpredis и используется в качестве клиента Redis, поэтому вы также можете воспользоваться некоторыми функциями, включенными в phpredis в качестве клиента Redis.

Почему?

Хотя вы можете выдавать команды RedisJSON с помощью некоторых клиентов PHP Redis, которые предоставляют вам возможность отправлять необработанные команды Redis, Phpredis-JSON:

избавляет вас от необходимости кодировать структуры данных PHP в JSON перед отправкой их в Redis и декодировать ответы JSON обратно из Redis.
он проверяет кодирование/декодирование JSON и выдает правильное исключение в случае сбоя
предоставляет набор команд в качестве методов клиента RedisJSON.

Требования

Версия сервера Redis 4.0+ (модуль RedisJson доступен только в Redis 4.0+)
Модуль RedisJson установлен на сервере Redis, как указано в разделе «Сборка и загрузка модуля RedisJSON».
PHP 7.2+ с установленным расширением PHP Redis 5.

Использование

 <?php

use Averias  RedisJson  Enum  JsonCommands ;
use Averias  RedisJson  Exception  ResponseException ;
use Averias  RedisJson  Factory  RedisJsonClientFactory ;

// *** get a RedisJsonClient ***
$ redisJsonClientFactory = new RedisJsonClientFactory ();
/**
 * creates a RedisJsonClient with default connection params:
 * [
 *     'host' => '127.0.0.1',
 *     'port' => 6379,
 *     'timeout' => 0.0, // seconds
 *     'retryInterval' => 15 // milliseconds
 *     'readTimeout' => 2, // seconds
 *     'persistenceId' => null // string for persistent connections, null for no persistent ones
 *     'database' => 0 // Redis database index [0..15]
 * ]
 */
$ defaultClient = $ redisJsonClientFactory -> createClient ();

// creates a configured RedisJsonClient
$ client = $ redisJsonClientFactory -> createClient ([
    ' host ' => ' 127.0.0.1 ' ,
    ' port ' => 6390 ,
    ' timeout ' => 2 ,
    ' database ' => 15
]);

// *** Redis JSON commands ***
$ result = $ client -> jsonSet ( ' people ' , [ " name " => " gafael " , " age " => 12 ]);
echo ( $ result === true ? ' true ' : ' false ' ) . PHP_EOL ; // true

$ result = $ client -> jsonGet ( ' people ' ); // $result = ["name":"gafael","age":12]
echo json_encode ( $ result ) . PHP_EOL ; // {"name":"gafael","age":12}

$ result =  $ client -> jsonGet ( ' people ' , ' .name ' );
echo $ result . PHP_EOL ; // "gafael"

$ result =  $ client -> jsonGet ( ' people ' , ' .age ' );
echo $ result . PHP_EOL ; // 12

// "nonexistent" key does not exist, so a ResponseException is thrown
try {
    $ result = $ client -> jsonGet ( ' nonexistent ' );
    echo $ result . PHP_EOL ;
} catch ( ResponseException $ e ) {
    echo " key nonexistent does not exist " . PHP_EOL ;
}

// *** you can also send RedisJSON command as raw commands using "RedisJsonClient::executeRawCommand"  ***
// you will send
$ result =  $ client -> executeRawCommand (JsonCommands:: SET , ' people ' , ' .colors ' , ' ["blue", "green"] ' );
echo $ result . PHP_EOL ; // 'OK'

// and receive JSON values
$ result =  $ client -> executeRawCommand (JsonCommands:: GET , ' people ' , ' . ' );
echo $ result . PHP_EOL ; // {"name":"gafael","age":12,"colors":["blue","green"]}


// *** you can also issue redis commands and use RedisJsonClient as "phpredis" client:
echo $ client -> hset ( ' hash-key ' , ' age ' , 34 ) . PHP_EOL ; // 0
echo $ client -> hget ( ' hash-key ' , ' age ' ) . PHP_EOL ; // 34

// $ret = [true,"val1",true,"val2"]
$ ret = $ client -> multi ()
    -> set ( ' key1 ' , ' val1 ' )
    -> get ( ' key1 ' )
    -> set ( ' key2 ' , ' val2 ' )
    -> get ( ' key2 ' )
    -> exec ();

echo json_encode ( $ ret ) . PHP_EOL ;

Команды

Команды RedisJSON: просмотрите список команд phpredis-json.
Команды Phpredis: вы можете отправлять команды Redis, как указано в документации phpredis.
Необработанные команды: вы можете отправлять в Redis все, что захотите, используя RedisJsonClient::executeRawCommand :

 // raw Redis JSON command
$ client -> executeRawCommand (JsonCommands:: GET , ' people ' , ' . ' );

// raw Redis command
$ client -> executeRawCommand ( ' hget, ' hash-key', ' foo ' );

Тесты

На локальном сервере Redis 4.0+ с установленным модулем RedisJSON и расширением Redis 5.

Из консоли выполните следующую команду из корневого каталога этого проекта:

./vendor/bin/phpunit

Если вы не настроили свой локальный сервер Redis в 127.0.0.1:6379, вы можете установить REDIS_TEST_SERVER, REDIS_TEST_PORT и REDIS_TEST_DATABASE в файле ./phpunit.xml с вашим локальным хостом Redis, портом и базой данных перед выполнением указанной выше команды.

Докер

Установив Docker, выполните следующую команду в корневом каталоге этого проекта:

bash run-tests-docker.sh

запустив приведенный выше сценарий bash, будут созданы две службы докеров: одна с PHP 7.2 с включенными расширениями xdebug и redis, а другая с образом redislabrejson:1.0.4 (сервер Redis 5 с установленным модулем RedisJson). Затем тесты будут запущены внутри контейнера службы докеров phpredis-json , и, наконец, оба контейнера будут остановлены.