b1rdex / predis-compressible
Client gzip compression for Predis library
Installs: 159 048
Dependents: 1
Suggesters: 0
Security: 0
Stars: 7
Watchers: 2
Forks: 3
Open Issues: 0
Requires
- php: >=8.0
- ext-zlib: *
- predis/predis: ^1.1.1
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.8
- phpstan/phpstan: ^1.5
- phpunit/phpunit: ^9.5
README
Plugin for Predis to compress/decompress stored values transparently.
Currently supported commands:
- SET
- SETEX
- SETNX
- GET
- MSET
Installation:
composer require b1rdex/predis-compressible
Example usage:
<?php use B1rdex\PredisCompressible\Command\StringGet; use B1rdex\PredisCompressible\Command\StringGetMultiple; use B1rdex\PredisCompressible\Command\StringSet; use B1rdex\PredisCompressible\Command\StringSetExpire; use B1rdex\PredisCompressible\Command\StringSetMultiple; use B1rdex\PredisCompressible\Command\StringSetPreserve; use B1rdex\PredisCompressible\Compressor\ConditionalCompressorWrapper; use B1rdex\PredisCompressible\Compressor\GzipCompressor; use B1rdex\PredisCompressible\CompressProcessor; use Predis\Client; use Predis\Configuration\OptionsInterface; use Predis\Profile\Factory; use Predis\Profile\RedisProfile; // strings with length > 2048 bytes will be compressed $compressor = new ConditionalCompressorWrapper(2048, new GzipCompressor()); $client = new Client([], [ 'profile' => static function (OptionsInterface $options) use ($compressor) { $profile = Factory::getDefault(); if ($profile instanceof RedisProfile) { $processor = new CompressProcessor($compressor); $profile->setProcessor($processor); $profile->defineCommand('SET', StringSet::class); $profile->defineCommand('SETEX', StringSetExpire::class); $profile->defineCommand('PSETEX', StringSetExpire::class); $profile->defineCommand('SETNX', StringSetPreserve::class); $profile->defineCommand('GET', StringGet::class); $profile->defineCommand('MGET', StringGetMultiple::class); $profile->defineCommand('MSET', StringSetMultiple::class); $profile->defineCommand('MSETNX', StringSetMultiple::class); } return $profile; }, ]);
Compressed values are stored as is.
Default GzipCompressor
uses gzencode
php function to compress value with default parameters and gzdecode
to decompress.
You can create your own compressor by implementing CompressorInterface
.
Roadmap:
- Add more commands (
HSET
and their get counterparts at least) - Make initialization simpler