postgres-redis 🚀

Transform your postgres server with Redis caching layer for pg.

• PostgresRedis checks if there is a cached result for the query in redis
• if not found in cache, it will retrieve data from postgres and on successful result cache it in redis for future queries
• if redis is unavailable or errors, query will be served by postgres

Use-case

Use along with postgres and redis. This is not a replacement of either. Use it with queries/stored procedures that only perform select and will return same result set everytime.

• No brainer for retrieving static data, eg, select * from countries
• Data that will not be updated once created, typically time series data like chat messages, logs
• Use with caution where data may get updated in postgres as redis cache may be stale

Hashing

The above is achieved by creating a unique hash for every query

"select 1+2" => #️⃣

In redis, the hash and query results are stored as key-value pair

#️⃣ => [{'1+2':3}]

Currently supported hash types are:

farmhash32 ⚡🗜️ Example redis key: prefix.2jNDCJ Fast!!! Over ~5 million hashes/s on reference machine. Most compact key.

farmhash64 Example redis key: prefix.DiHlF3yv0V$ fast (~2 million hashes/sec on reference machine ) farmhash32/64 use Google's farmhash, non-crypto algorithm (if you have millions of possible queries, these hashes can collide 💥) so use it for hundreds or thousands of static queries

blake2b512 🛡️ Example redis key: prefix.4KbMOx3xJi+7mJNy0tDbju6NY9uHqOroDsG4rYjpHK1mEwXJokls5Ofdjs7iDsn3cAtibgUkT8RDdpCE2phhiQ== Crypto safe, ~500k hashes/sec on reference machine Use it for caching millions of different queries (eg. chats, logs) Note that the key is longer than farmhash.

full Matches full query string. Use this if you are paranoid or if your queries are smaller than blake2b512 hashes

Or you can provide your own hash per query, eg, prefix.p.123 to represent select * from person p where id = $1,[123]

Getting Started

Pre-Requisites

node postgres (pg/pg-pool), and redis (redis/ioredis). Internally PostgresRedis relies on pg/pg-pool's query function and redis's get and set functions

For async/await api, you can use pg/pg-pool's promise api and async-redis

Installing

npm i postgres-redis --save

Usage

const { PostgresRedis, HashTypes } = require("postgres-redis");

// or if you use async await api
const { PostgresRedisAsync, HashTypes } = require("postgres-redis");

Creating an instance of PostgresRedis requires

• a pg connection or pg-pool (PostgresRedis will call it's query method when no cache found)
• redis connection (PostgresRedis will call its set and get methods)
• cache options (optional)

Creating an instance of PostgresRedisAsync requires

• a pg connection or pool promise
• async redis

   eg:
   const  asyncRedis  =  require("async-redis");
   const  redis  =  asyncRedis.createClient(redisOptions);
  
  

• cache options (optional)

const cacheOptions = {
    expire: 2629746,// seconds, defaults to 30 days 
    keyPrefix: "sql.", // default
    hashType: HashTypes.farmhash32 //default
};

const postgresRedis = new PostgresRedis(
    pgConnection,
    redisConnection,
    cacheOptions
);

Now if you wish to get something from cache, just use postgresRedis.query instead of your pg connection's query. Use your pg/pg-pool normally to bypass cache

// query can be string 
// or object, eg: { text:'select 1 + $1', values:[2] }

postgresRedis.query('select * from logs where id =$1",["some-log-id"], ( err, { rows, fields } )=>{
	console.log(rows)
	// if served by Redis, fields value is something like [ { cacheHit: 'sql.Dh9VSNbN5V$' } ]
	// else pg fields
});

or if you like promises, then:

const postgresRedis = new PostgresRedisAsync(
    pgConnection,
    redisConnection,
    cacheOptions
);

... in an async function ...
try{

	const { rows, fields }=await postgresRedis.query("select 1+$1+$2",[2,3]);

}catch(err){
	// handle err
}

You can override cache options per query as below:

postgresRedis.query('select * from logs where id =$1",["some-log-id"],
	{ //cache option
		keyPrefix:'sql-abc-', 
		expire:3600, 
		hashType: HashTypes.farmhash64 
        //or hash: myHash <- provide your own 
	}, 
	( err, { rows, fields } )=>{
	console.log(rows)
	// if served by Redis, fields value is something like [ { cacheHit: 'sql.Dh9VSNbN5V$' } ]
	// else pg fields
});


// promise api
const { rows, fields }=await postgresRedis.query("select 1+$1+$2",[2,3],
   { //cache option
		keyPrefix:'sql-abc-', 
		expire:3600, 
		hashType: HashTypes.farmhash64 
        //or hash: myHash <- provide your own 
	});

Contributing

Feel free to fork/send PR

Authors

• Gi Singh

License

This project is licensed under the MIT.