Home Original page

GitHub - maxpert/node-cache-manager-sqlite: A modern SQLite store for node-cache-manager

A modern SQlite cache store for node-cache-manager. Featuring:

  • Async SQLite3 using sqlite3
  • async/await support with Promise
  • 100% test coverage and production ready
  • Optimized mset/mget support
  • Supports CBOR for efficient and fast storage (selectable between json or cbor default: cbor)
  • Support for custom serializers
  • Smart purging support, no configuration required

Why?

The goal was to have a local key value storage built on top of proven technology. While other options like node-cache-manager-fs-binary have similar functionality; they are littered with all sort of problems from race conditions, (multi-process) to corruption. SQLite on the other end has been battle tested, and using WAL allows multiple node processes (forked web servers) to share the same cache across various processes, without the headaches of flat file based systems.

SQLite based storage is ideal for:

  • Faster local storage than filesystem. Yes you heard it right
  • Reslience to corruption and recovery.
  • Multiprocess Node.js processes (typical in server deployments with many cores)
  • Large number of entries.

Installation

npm i cache-manager-sqlite

Requirements

Usage

Single store

const sqliteStore = require('cache-manager-sqlite')
const cacheManager = require('cache-manager')

// SQLite :memory: cache store
const memStoreCache = cacheManager.caching({
    store: sqliteStore,
    options: {
        serializer: 'json', // default is 'cbor'
        ttl: 20 // TTL in seconds
    }
})

// On disk cache on employees table
const cache = cacheManager.caching({
    store: sqliteStore,
    name: 'employees',
    path: '/tmp/cache.db'
})


// TTL in seconds
await cache.set('foo', {test: 'bar'}, {ttl: 10})
const value = await cache.get('foo')

Multi-store example:

const cacheManager = require('cache-manager')
const redisStore = require('cache-manager-ioredis')
const sqliteStore = require('cache-manager-sqlite')

const redisCache = cacheManager.caching({ store: redisStore, db: 0, ttl: 600 })
const sqliteCache = cacheManager.caching({ store: sqliteStore, path: '/tmp/cache.db', name: 'users', options: { ttl: 600 } })

const multiCache = cacheManager.multiCaching([sqliteCache, redisCache])

// Basic get/set
await multiCache.set('foo2', 'bar2', { ttl: customTTL })
const v = await multiCache.get('foo2')

// Wrap call example
const userId = 'user-1'

// Optionally pass ttl
await multiCache.wrap(userId, { ttl: customTTL }, async () => {
    console.log("Calling expensive service")
    await getUserFromExpensiveService(userId)
})

// set and get multiple
await multiCache.mset('foo1', 'bar1', 'foo0', 'bar0') //Uses default TTL
await multiCache.mset('foo1', 'bar1', 'foo3', 'bar3', {ttl: customTTL})
await multiCache.mget('foo1', 'foo3')

License

The node-cache-manager-sqlite is licensed under the MIT license.