Download phpredis json - download do código-fonte phpredis json

phpredis json

Outras categorias

1.0.0

Baixar

Phpredis-JSON

RedisJson com a extensão PHP Redis phpredis.

Introdução

Phpredis-JSON fornece um conjunto completo de comandos para o módulo RedisJson. Ele é construído sobre o phpredis e é usado como cliente Redis, então você também pode aproveitar alguns dos recursos incluídos no phpredis como cliente Redis.

Por que?

Embora você possa emitir comandos RedisJSON usando alguns clientes PHP Redis que fornecem a capacidade de enviar comandos Redis brutos, Phpredis-JSON:

evita a tarefa de codificar suas estruturas de dados PHP para JSON antes de enviá-las ao Redis e decodificar as respostas JSON do Redis
ele valida a codificação/decodificação JSON e lança uma exceção adequada em caso de falha
fornece um conjunto de comandos como métodos do cliente RedisJSON

Requisitos

Versão 4.0+ do servidor Redis (o módulo RedisJson está disponível apenas no Redis 4.0+)
Módulo RedisJson instalado no servidor Redis conforme especificado em Construindo e carregando o Módulo RedisJSON
PHP 7.2+ com extensão PHP Redis 5 instalada

Uso

 <?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 ;

Comandos

Comandos RedisJSON: dê uma olhada na lista de comandos phpredis-json
Comandos Phpredis: você pode enviar comandos Redis conforme especificado na documentação do phpredis
Comandos brutos: você pode enviar o que quiser para o Redis usando RedisJsonClient::executeRawCommand :

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

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

Testes

Em um servidor Redis local 4.0+ com módulo RedisJSON e extensão Redis 5 instalados

No console, execute o seguinte comando no diretório raiz deste projeto:

./vendor/bin/phpunit

se você não configurou seu servidor Redis local em 127.0.0.1:6379, você pode definir REDIS_TEST_SERVER e REDIS_TEST_PORT e REDIS_TEST_DATABASE no arquivo ./phpunit.xml com seu host, porta e banco de dados Redis local antes de executar o comando acima.

Docker

Com o Docker instalado, execute o seguinte comando no diretório raiz deste projeto:

bash run-tests-docker.sh

executando o script bash acima, dois serviços docker serão construídos, um com PHP 7.2 com extensões xdebug e redis habilitadas e outro com a imagem redislabrejson:1.0.4 (servidor Redis 5 com módulo RedisJson instalado). Em seguida, os testes serão executados dentro do contêiner de serviço docker phpredis-json e, finalmente, ambos os contêineres serão interrompidos.