Giter VIP home page Giter VIP logo

pg-parade's Introduction


pg-parade


Build Status

This module wraps pg-promise for read/write replica support.

Install

$ npm install --save pg-parade

Usage

const pgp = require('pg-parade')();
const db = pgp({
	write: 'postgres://localhost:5432/postgres',
	read: 'postgres://localhost:5433/postgres'
});

db.write.query('INSERT INTO test VALUES (1)'); // Will be executed on write server
db.read.query('SELECT * FROM test'); // Will be executed on read server

API

pgParade([options])

options

Initialization options from pg-promise.

Returns instance of initialized database factory.

pgSelect(replicas)

Returns Database object with two operations scopes:

  • read - query will be executed on closest read server
  • write - query will be executed on closest write server

replicas

Type: Object, Function

Object with read and write connection strings.

If cluster is type of Function โ€“ then it should return a promise, resolving to an Object.

Transactions

When calling tx method, callback will recieve proxy object with read and write properties, but all read requests will be executed on write replica.

License

MIT ยฉ Vsevolod Strukchinsky

pg-parade's People

Contributors

floatdrop avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.