This adapter does not support the Semantic or Queryable interfaces. Instead, it simply provides robust, managed access to the underlying Redis client. See the for-sails-0.12 branch of this repo or ryanc1256/sails-redis for examples of conventional adapters that let you use Redis to directly store and query records from your models.
This is an adapter for Sails versions 1.0 and up. If you are using an earlier version of Sails (or Waterline <v0.13), check out the for-sails-0.12 branch. Since this new release of sails-redis is more lightweight, and does not support the same semantic interface as its predecessor, be aware that there are breaking changes in your app when you upgrade. But I think you'll find that this new release is a great way to easily communicate with Redis, with minimal interference and a stable API. If you are interested in upgrading the new, Sails-v1-compatible release of this Redis adapter to support semantic usage (find, create, update, destroy), then please contact Mike or another core maintainer.
Install is through NPM.
$ npm install sails-redis --save
After installing and configuring this adapter (see below), you'll be able to use it to send commands to Redis from your Sails/Node.js app.
For example, in an action:
var categoryId = Product;sails;
Note that the leased connection (
db) is just a Redis client instance. No need to connect it/bind event listeners-- it's already hot and ready to go. Any fatal, unexpected errors that would normally be emitted as the "error" event are handled by the underlying driver, and can be optionally handled with custom logic by providing a function for
Need to use a different Redis client, like ioredis? Please have a look at the underlying driver for the latest info/discussion.
This adapter supports standard datastore configuration, as well as some additional low-level options.
For example, in a Sails app, add the config below to your
cache:adapter: 'sails-redis'url: 'redis://localhost:6379'// Other available low-level options can also be configured here.// (see below for more information)
Note that you probably shouldn't set Redis as the default datastore for your application (your models wouldn't work!)
Low-Level Configuration (for redis client)
Configuration for the underlying Redis client itself is located as an object under the
options. The following options are available:
parser: which Redis protocol reply parser to use. Defaults to
hiredisif that module is installed. This may also be set to
return_buffers: defaults to
false. If set to
detect_buffers: default to
false. If set to
true, 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, whereas
return_buffersapplies to every command on a client.
socket_nodelay: defaults to
true. Whether to call setNoDelay() on the TCP stream, which disables the Nagle algorithm on the underlying socket. Setting this option to
falsecan result in additional throughput at the cost of more latency. Most applications will want this set to
no_ready_check: defaults to
false. 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_redishas a "ready check" which sends the
INFOcommand to the server. The response from the
INFOcommand indicates whether the server is ready for more commands. When ready,
truewill inhibit this check.
enable_offline_queue: defaults to
true. 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. Setting
falsewill 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 to
null. By default every time the client tries to connect and fails time before reconnection (delay) almost doubles. This delay normally grows infinitely, but setting
retry_max_delaylimits delay to maximum value, provided in milliseconds.
false. By default client will try reconnecting until connected. Setting
connect_timeoutlimits total time for client to reconnect. Value is provided in milliseconds and is counted once the disconnect occured.
null. By default client will try reconnecting until connected. Setting
max_attemptslimits total amount of reconnects.
null. By default client will try connecting without auth. If set, client will run redis auth command on connect.
For more examples, or if you get stuck or have questions, click here.
To report a bug, click here.
Please observe the guidelines and conventions laid out in the Sails project contribution guide when opening issues or submitting pull requests.
I owe a big thank you to @ryanc1256 for all of his work with the original version of this adapter.