# @plotdb/sharedb-postgres

> PostgreSQL adapter for ShareDB. forked from share/sharedb-postgres

Latest version **4.0.1** (published 2021-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @plotdb/sharedb-postgres
pnpm add @plotdb/sharedb-postgres
yarn add @plotdb/sharedb-postgres
bun add @plotdb/sharedb-postgres
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.1 |
| Published | 2021-02-02 |
| First published | 2021-02-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 11.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jeremy Apthorp |
| Maintainers | tkirby |
| Keywords | sharedb, sharejs, share, postgres |

## Links

- npm: https://www.npmjs.com/package/@plotdb/sharedb-postgres
- Repository: https://github.com/plotdb/sharedb-postgres
- Homepage: https://github.com/plotdb/sharedb-postgres#readme
- Issues: https://github.com/plotdb/sharedb-postgres/issues
- npm.io page: https://npm.io/package/@plotdb/sharedb-postgres

## Dependencies (3)

- [pg](https://npm.io/package/pg.md) ^8.5.1
- [pg-pool](https://npm.io/package/pg-pool.md) ^3.2.1
- [sharedb](https://npm.io/package/sharedb.md) ^1.6.0

## Recent versions

- 4.0.1 (latest) — 2021-02-02
- 4.0.0 — 2021-02-02

## README

# @plotdb/sharedb-postgres

PostgreSQL database adapter for [sharedb](https://github.com/share/sharedb). This driver can be used both as a snapshot store and oplog.

Doesn't support queries (yet?).

Moderately experimental. (This drives [Synaptograph](https://www.synaptograph.com)'s backend, and [@nornagon](https://github.com/nornagon) hasn't noticed any issues so far.)


## Note about versioning

This is a fork from the [original `sharedb-postgres`](https://github.com/share/sharedb-postgres) and its relative forks (see [billwashere](https://github.com/billwashere/sharedb-postgres-jsonb), [zbryikt](https://github.com/zbryikt/sharedb-postgres-jsonb). It seems to have been not maintained for a long time since 2018, Thus we decide to fork it and maintain it as `@plotdb/sharedb-postgre`.


## Requirements

Due to the fix to resolve [high concurency issues](https://github.com/share/sharedb-postgres/issues/1) Postgres 9.5+ is now required.

## Migrating older versions

Older versions of this adaptor used the data type json. You will need to alter the data type prior to using if you are upgrading. 

```PLpgSQL
ALTER TABLE ops
  ALTER COLUMN operation
  SET DATA TYPE jsonb
  USING operation::jsonb;

ALTER TABLE snapshots
  ALTER COLUMN data
  SET DATA TYPE jsonb
  USING data::jsonb;
```

## Usage

`sharedb-postgres-jsonb` wraps native [node-postgres](https://github.com/brianc/node-postgres), and it supports the same configuration options.

To instantiate a sharedb-postgres wrapper, invoke the module and pass in your
PostgreSQL configuration as an argument or use environmental arguments. 

For example using environmental arugments:

```js
var db = require('sharedb-postgres')();
var backend = require('sharedb')({db: db})
```

Then executing via the command line 

```
PGUSER=dbuser  PGPASSWORD=secretpassword PGHOST=database.server.com PGDATABASE=mydb PGPORT=5433 npm start
```

Example using an object

```js
var db = require('sharedb-postgres')({host: 'localhost', database: 'mydb'});
var backend = require('sharedb')({db: db})
```

## Error codes

PostgreSQL errors are passed back directly.

## Changelog

Note that version 3.0.0 introduces breaking changes in how you specify
connection parameters. See the [changelog](CHANGELOG.md) for more info.

---
_Source: https://npm.io/package/@plotdb/sharedb-postgres · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._