Dancer::Plugin::Redis - easy database connections for Dancer applications
version 0.8
Provides an easy way to obtain a connected Redis database handle by simply calling the redis keyword within your Dancer application.
use Dancer; use Dancer::Plugin::Redis; # Calling the redis keyword will get you a connected Redis Database handle: get '/widget/view/:id' => sub { template 'display_widget', { widget => redis->get('hash_key'); }; }; dance;
Redis connection details are read from your Dancer application config - see below.
Keywords redis, that use your config to connect to redis
Connection details will be taken from your Dancer application config file, and should be specified as, for example:
plugins: Redis: server: '127.0.0.1:6379' debug: 0 encoding: utf8 reconnect: 60 password: yourpassword connections: test: server: '127.0.0.1:6380' debug: 1 encoding: utf8 password: yourpassword
server is the ip:port of redis server
server
debug activate the debug of redis
debug
encoding activate auto encoding, if you want raw data, put nothing after encoding
encoding
reconnect is the number of second which try to reconnect if we have lost connection, default to 60
reconnect
password pass AUTH to Redis if you use the requirepass config. You can skip this option if you don't have requirepass set.
password
Calling redis will return a connected database handle; the first time it is called, the plugin will establish a connection to the database, and return a reference to the DBI object. On subsequent calls, the same DBI connection object will be returned. The connection will be refresh automatically with the Redis reconnect option.
redis
If you have declared named connections as described above in 'DEFINING MULTIPLE CONNECTIONS', then calling the database() keyword with the name of the connection as specified in the config file will get you a database handle connected with those details.
Dancer
DBI
Redis
Please report any bugs or feature requests on the bugtracker website https://github.com/celogeek/Dancer-Plugin-Redis/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
celogeek <me@celogeek.com>
This software is copyright (c) 2014 by celogeek <me@celogeek.com>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Dancer::Plugin::Redis, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dancer::Plugin::Redis
CPAN shell
perl -MCPAN -e shell install Dancer::Plugin::Redis
For more information on module installation, please visit the detailed CPAN module installation guide.