Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A memcache client for node using the binary protocol and SASL authentication
JavaScript
branch: master

This branch is 7 commits ahead, 96 commits behind alevy:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bench
lib/memjs
test
.gitignore
.travis.yml
CHANGELOG
LICENSE
README.md
package.json

README.md

MemJS Build Status

MemJS is a pure Node.js client library for accessing the MemCachier service and other memcache servers. It uses the binary protocol and support SASL authentication.

NOTE: while memjs works with MemCachier, MemCachier is configured only to accept connections from authorized hosts (e.g. Heroku's servers). For local development, use memcache -- no code changes are required to work with MemCachier once the app is deployed. See below for local installation instructions.

Supported Node.js versions

MemJS is tested to work with version 0.6 or higher of Node.js.

Installation

MemJS is available from the npm registry:

$ npm install memjs

To install from git:

$ git clone git://github.com/alevy/memjs.git
$ cd memjs
$ npm link

MemJS was designed for the MemCachier memcache service but will work with any memcache server that speaks the binary protocol. Many software repositories have a version of memcacached available for installation:

Ubuntu

$ apt-get install memcached

OS X

$ brew install memcached

Usage

You can start using MemJS immediately from the node console:

$ var memjs = require('memjs')
$ var client = memjs.Client.create()
$ client.get('hello', console.log)

Configuration

MemJS understands the following environment variables:

  • MEMCACHIER_SERVERS - used to determine which servers to connect to. Should be a comma separated list of [hostname:port].
  • MEMCACHIER_USERNAME - if present with MEMCACHIER_PASSWORD, MemJS will try to authenticated to the server using SASL.
  • MEMCACHIER_PASSWORD - if present with MEMCACHIER_USERNAME, MemJS will try to authenticated to the server using SASL.
  • MEMCACHE_USERNAME - used if MEMCACHIER_USERNAME is not present
  • MEMCACHE_PASSWORD - used if MEMCACHIER_PASSWORD is not present

Environment variables are only used as a fallback for explicit parameters.

TODOS

  • Add more commands (increment, decrement, flush)
  • Support flags
  • Support CAS

Copyright

Copyright (c) 2012 Amit Levy, MemCachier. See LICENSE for details.

Something went wrong with that request. Please try again.