phpredis jsonダウンロード - phpredis jsonソースコードのダウンロード

phpredis json

その他のカテゴリー

1.0.0

ダウンロード

Phpredis-JSON

PHP Redis 拡張子 phpredis を使用した RedisJson。

イントロ

Phpredis-JSON は、RedisJson モジュールのコマンドの完全なセットを提供します。これはphpredis上に構築され、Redis クライアントとして使用されるため、 phpredisに含まれる機能の一部を Redis クライアントとして利用することもできます。

なぜ？

生の Redis コマンドを送信できる一部の PHP Redis クライアントを使用して RedisJSON コマンドを発行できますが、Phpredis-JSON では次のことが可能です。

PHP データ構造を Redis に送信する前に JSON にエンコードし、Redis から返される JSON 応答をデコードするタスクを回避します。
JSON のエンコード/デコードを検証し、失敗した場合には適切な例外をスローします。
RedisJSON クライアントのメソッドとして一連のコマンドを提供します

要件

Redis サーバー 4.0 以降のバージョン (RedisJson モジュールは Redis 4.0 以降でのみ利用可能)
「RedisJSON モジュールの構築とロード」の指定に従って Redis サーバーにインストールされた RedisJson モジュール
PHP Redis 拡張機能 5 がインストールされた PHP 7.2 以降

使用法

 <?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 コマンド: phpredis ドキュメントの指定に従って Redis コマンドを送信できます。
生のコマンド: RedisJsonClient::executeRawCommand使用して、必要なものを Redis に送信できます。

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

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

テスト

RedisJSON モジュールと Redis 拡張機能 5 がインストールされたローカル Redis サーバー 4.0 以降

コンソールから、このプロジェクトのルートディレクトリから次のコマンドを実行します。

./vendor/bin/phpunit

127.0.0.1:6379 でローカル Redis サーバーを構成していない場合は、上記のコマンドを実行する前に、ローカル Redis ホスト、ポート、データベースを使用して./phpunit.xmlファイル内の REDIS_TEST_SERVER 、REDIS_TEST_PORT および REDIS_TEST_DATABASE を設定できます。

ドッカー

Docker をインストールしたら、このプロジェクトのルートディレクトリで次のコマンドを実行します。

bash run-tests-docker.sh

上記の bash スクリプトを実行すると、2 つの Docker サービスが構築されます。1 つは xdebug および redis 拡張機能が有効になった PHP 7.2 を使用し、もう 1 つはredislabrejson:1.0.4 (RedisJson モジュールがインストールされた Redis サーバー 5) のイメージを使用します。次に、 phpredis-json Docker サービスコンテナ内でテストが実行され、最終的に両方のコンテナが停止されます。