casualuser / rediska

Full-featured PHP client for key-value database Redis

Rediska (radish on russian) - PHP client for Redis.

Redis is an advanced fast key-value database written in C. It can be used like memcached, in front of a traditional database, or on its own thanks to the fact that the in-memory datasets are not volatile but instead persisted on disk. One of the cool features is that you can store not only strings, but lists and sets with atomic operations to push/pop elements.

More information and documentation on homepage: http://rediska.geometria-lab.net

Features

• Multiple servers support
• Consistent hashing, crc32 or you personal algorythm for key distribution
• Working with keys as objects
• Use Lists, Sets, Sorted sets and Hashes as native PHP arrays
• Transactions
• Publish/Subscribe
• Profiler
• Pipelining
• Easy extending Rediska by adding you own commands or overwrite standart
• Zend Framework integration
• Symfony framework integration
• Full documentation
• Example application
• PHPUnit tests

Coming soon

• PHP extension
• Cloud key distribution
• Ketama (fast C library for key distribution) support
• Benchmarks and performance optimization

Get started!

1. Get Rediska

   You can install Rediska from PEAR, download zip archive or get from git repository.

   1.1. Install via composer

   Get composer and add Rediska package to dependencies.

   1.2. Install from PEAR

   For begining you need to discover our PEAR channel:

   pear channel-discover pear.geometria-lab.net

   And install package:

   pear install geometria-lab/Rediska-beta

   1.3. Download or get from repository

   Download zip archive with latest version or get last unstable version from git repository:

   git clone http://github.com/shumkov/rediska.git

   For adding Rediska to your applcation you need copy Rediska from library folder to you application library folder

   • Add Rediska to your Zend Framework application
   • Add Rediska plugin to your Symfony application

2. Configure Rediska

     <?php
   
     $options = array(
       'namespace' => 'Application_',
       'servers'   => array(
         array('host' => '127.0.0.1', 'port' => 6379),
         array('host' => '127.0.0.1', 'port' => 6380)
       )
     );
   
     require_once 'Rediska.php';
     $rediska = new Rediska($options);
   
     ?>
   

   All configuration options.

3. Use Rediska

     <?php
   
     // Set 'value' to key 'keyName'
     $key = new Rediska_Key('keyName');
     $key->setValue('value');
   
     ?>
   

   • Full usage documentation
   • Using Rediska with frameworks:
     • Zend Framework
     • Symfony

Project structure

• CHANGELOG.txt - Histroy of Rediska
• README.txt - This document
• VERSION.txt - Current version of Rediska
• benchmarks/ - Rediska benchmarks. In progress...
• examples/ - Rediska expamples
• library/ - Rediska library. Put files from library to you include_path and use: require_once "Rediska.php"
• package.xml - Install Rediska to PHP library dir: pear install package.xml. Now use Rediska is easy (without include_path configuration): require_once "Rediska.php"
• scripts/ - Maintenance scripts
• tests/ - PHPUnit tests. Use phpunit console command or right click on bootstrap.php and Run As -> PHPUnit Test in Zend Studio

Contributions

Rediska is an open source project: you can participate in development or become an author of integration module for your favorite framework.

Authors:

• Ivan Shumkov
• Maxim Ivanov
• Ryan Grenz (Symfony integration)
• Till Klampaeckel (PEAR package)