# pg-parade

**Repository Path**: mirrors_floatdrop/pg-parade

## Basic Information

- **Project Name**: pg-parade
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">
	<br>
	<img width="400" src="https://rawgit.com/floatdrop/pg-parade/master/media/logotype.png" alt="pg-parade">
	<br>
	<br>
	<br>
</h1>

[![Build Status](https://travis-ci.org/floatdrop/pg-parade.svg?branch=master)](https://travis-ci.org/floatdrop/pg-parade)

This module wraps [pg-promise](https://github.com/vitaly-t/pg-promise) for read/write replica support.

## Install

```
$ npm install --save pg-parade
```


## Usage

```js
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](https://github.com/vitaly-t/pg-promise#advanced) 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](http://github.com/floatdrop)