lite-redis

Access Redis with an ActiveRecord like ORM interface

Lite::Redis

Gem Version Build Status

Lite::Redis is a library for accessing Redis with an ActiveRecord like ORM interface.

NOTE: If you are coming from ActiveRedisDB, please read the port section.

Installation

Add this line to your application’s Gemfile:

gem 'lite-redis'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lite-redis

Table of Contents

Configurations

rails g lite:redis:install will generate the following file: ../config/initalizers/lite_redis.rb

Lite::Redis.configure do |config|
  config.client = Redis.new
end

Pooling

Use the Connection Pool gem to improve connection performance. Also look into hiredis driver to improve performance even further lists and ranges.

Lite::Redis.configure do |config|
  config.client = ConnectionPool::Wrapper.new(size: 5, timeout: 5) { Redis.new }
end

Commands

Callers

There are two ways to access Redis commands, single class and multiple instance access. Multiple instance access reuses a Redis connection for better performance.

# Single class access
Lite::Redis::String.create(:example, '123')
Lite::Redis::String.find(:example)

# - or -

# Multiple instance access
string = Lite::Redis::String.new
string.create(:example, '123')
string.find(:example)

Port

Lite::Redis is a near compatible port of ActiveRedisDB.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lite-redis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Lite::Redis project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.