sails-redis

library1.0.0jsnpmunverified

sails-redis is a Redis adapter for Sails.js and Waterline ORM, enabling Redis as the data store for Sails models. Version 1.0.0 is the latest stable release. It provides a lightweight, event-driven interface for CRUD operations and is designed specifically for the Sails framework. Compared to other adapters like sails-mongo, it offers fast key-value lookups but lacks complex querying capabilities. The adapter is officially maintained by the Sails core team and follows Waterline adapter conventions, supporting connection pooling and pub-sub for real-time features. It is suitable for caching, session storage, or simple data models that benefit from Redis's speed.

database

npm install sails-redis

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SAILS-REDIS

sails-redis

databasejavascriptv1.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import RedisAdapter from 'sails-redis'

✗ const RedisAdapter = require('sails-redis')

ESM-only since v1.0.0; use default import.

RedisAdapter

✓ import { RedisAdapter } from 'sails-redis'

✗ const { RedisAdapter } = require('sails-redis')

Named export for TypeScript users; CJS not supported.

Connection class

✓ const connection = new (require('sails-redis').default)()

✗ new require('sails-redis')()

Must access .default property in CJS if using require, but ESM is recommended.

Quick setup of sails-redis adapter with connection configuration and basic CRUD operations.

// Install: npm install sails-redis@1.0.0 // Configure in config/datastores.js: module.exports = { default: { adapter: 'sails-redis', url: process.env.REDIS_URL ?? 'redis://localhost:6379' } }; // In a model (api/models/User.js): module.exports = { datastore: 'default', attributes: { name: { type: 'string' }, email: { type: 'string', required: true, unique: true } } }; // Usage in controller/action: await User.create({ name: 'Alice', email: 'alice@example.com' }); const users = await User.find(); console.log(users);

Debug

Known issues

breakingv1.0.0 drops support for Node.js < 10.

fix

Upgrade to Node.js 10 or later.

affects: >=1.0.0

breakingv1.0.0 is ESM-only; CJS require() no longer works.

fix

Use import syntax or switch to v0.x if CJS required.

affects: >=1.0.0

deprecatedThe `redis` option `return_buffers` is deprecated in favor of `returnBuffers`.

fix

Use `returnBuffers` instead of `return_buffers` in connection config.

affects: >=1.0.0

gotchaThe adapter does not support complex queries like joins or aggregates; use for simple models only.

fix

For complex operations, consider another adapter like sails-mongo.

affects: all

Errors

Common errors & fixes

Error: Cannot find module 'sails-redis'

Package not installed or not in node_modules.

fix

Run `npm install sails-redis@1.0.0` in the Sails app directory.

TypeError: sails_redis_1.default is not a function

Using require() in CJS context with ESM-only package.

fix

Switch to import syntax or use v0.x of sails-redis that supports CJS.

Error: connect ECONNREFUSED 127.0.0.1:6379

Redis server is not running or URL is incorrect.

fix

Start Redis server with `redis-server` or set the REDIS_URL environment variable to a valid server.

Upgrade

Version history

1.0.0latest on npm

Audit

Dependencies

redisrequiredNode.js Redis client for connecting to Redis server

waterlinerequiredWaterline ORM is required to use the adapter in a Sails app

Agent activity

15 hits · last 30 days

node