sails-redis-lite
v0.1.1
Published
Light redis adapter for waterline. Develop for caching complecated model datas.
Downloads
5
Maintainers
Readme
Light Redis Sails/Waterline Adapter
A light Sails/Waterline adapter for Redis. May be used in a Sails app or anything using Waterline for the ORM.
Base on the sails-redis, remove the indexes and unique constraints, add expire time support.
I develop it for caching complicated models datas which has a lot of associations.
Install
Install is through NPM.
$ npm install sails-redis-lite
Configuration
The following connection configuration is available:
// default values inline
config: {
port: 6379,
host: 'localhost',
password: null,
database: null
};
Alternatively the URL notation for configuration can be used for configuration:
config {
url: 'redis://h:[email protected]:6379'
}
// Equivalent to:
// config: {
// port: 6379,
// host: 'host.com'
// password: 'abc123'
// }
// Other portions of the URL, including the 'username' 'h' are ignored
Note that if both the 'url' notation and the 'host', 'port' and / or 'password' notations are used, the non-url configuration options will take precedence.
With Sails
When using this library with sails add the config below to your config/connections.js
file:
redis: {
adapter: "sails-redis-lite",
port: 6379,
host: 'localhost'
}
And then you can make it the default by changing config/models.js
to show:
connection: 'redis',
Low-Level Configuration (for redis driver)
Configuration for the underlying Redis driver itself is located as an object under the options
. The following options are available:
parser
: which Redis protocol reply parser to use. Defaults tohiredis
if that module is installed. This may also be set tojavascript
.return_buffers
: defaults tofalse
. If set totrue
, then all replies will be sent to callbacks as node Buffer objects instead of JavaScript Strings.detect_buffers
: default tofalse
. If set totrue
, then replies will be sent to callbacks as node Buffer objects if any of the input arguments to the original command were Buffer objects. This option lets you switch between Buffers and Strings on a per-command basis, whereasreturn_buffers
applies to every command on a client.socket_nodelay
: defaults totrue
. Whether to call setNoDelay() on the TCP stream, which disables the Nagle algorithm on the underlying socket. Setting this option tofalse
can result in additional throughput at the cost of more latency. Most applications will want this set totrue
.no_ready_check
: defaults tofalse
. When a connection is established to the Redis server, the server might still be loading the database from disk. While loading, the server not respond to any commands. To work around this,node_redis
has a "ready check" which sends theINFO
command to the server. The response from theINFO
command indicates whether the server is ready for more commands. When ready,node_redis
emits aready
event. Settingno_ready_check
totrue
will inhibit this check.enable_offline_queue
: defaults totrue
. By default, if there is no active connection to the redis server, commands are added to a queue and are executed once the connection has been established. Settingenable_offline_queue
tofalse
will disable this feature and the callback will be execute immediately with an error, or an error will be thrown if no callback is specified.retry_max_delay
: defaults tonull
. By default every time the client tries to connect and fails time before reconnection (delay) almost doubles. This delay normally grows infinitely, but settingretry_max_delay
limits delay to maximum value, provided in milliseconds.connect_timeout
defaults tofalse
. By default client will try reconnecting until connected. Settingconnect_timeout
limits total time for client to reconnect. Value is provided in milliseconds and is counted once the disconnect occured.max_attempts
defaults tonull
. By default client will try reconnecting until connected. Settingmax_attempts
limits total amount of reconnects.auth_pass
defaults tonull
. By default client will try connecting without auth. If set, client will run redis auth command on connect.
FAQ
See FAQ.md
.
Contribute
See CONTRIBUTING.md
.
MIT License
See LICENSE.md
.