@keyv/postgres
TypeScript icon, indicating that this package has built-in type declarations

1.4.11 • Public • Published

@keyv/postgres keyv

PostgreSQL storage adapter for Keyv

build codecov npm npm

PostgreSQL storage adapter for Keyv.

Requires Postgres 9.5 or newer for ON CONFLICT support to allow performant upserts. Why?

Install

npm install --save keyv @keyv/postgres

Usage

const Keyv = require('keyv');

const keyv = new Keyv('postgresql://user:pass@localhost:5432/dbname');
keyv.on('error', handleConnectionError);

You can specify the table option.

e.g:

const keyv = new Keyv('postgresql://user:pass@localhost:5432/dbname', { table: 'cache' });

You can specify the schema option (default is public).

e.g:

const keyv = new Keyv('postgresql://user:pass@localhost:5432/dbname', { schema: 'keyv' });

Testing

When testing you can use our docker-compose postgresql instance by having docker installed and running. This will start a postgres server, run the tests, and stop the server:

At the root of the Keyv mono repo:

yarn test:services:start

To just test the postgres adapter go to the postgres directory (packages/postgres) and run:

yarn test

License

MIT © Jared Wray

Package Sidebar

Install

npm i @keyv/postgres

Weekly Downloads

20,855

Version

1.4.11

License

MIT

Unpacked Size

16.4 kB

Total Files

13

Last publish

Collaborators

  • jaredwray
  • lukechilds