# postgresql-easy

> A Node package for interacting with a PostgreSQL database

Latest version **1.3.0** (published 2023-09-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install postgresql-easy
pnpm add postgresql-easy
yarn add postgresql-easy
bun add postgresql-easy
```

## 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 | 1.3.0 |
| Published | 2023-09-21 |
| First published | 2017-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 34.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | R. Mark Volkmann |
| Maintainers | mvolkmann |
| Keywords | Node, PostgreSQL |

## Links

- npm: https://www.npmjs.com/package/postgresql-easy
- Repository: https://github.com/mvolkmann/postgresql-easy
- Homepage: https://github.com/mvolkmann/postgresql-easy#readme
- Issues: https://github.com/mvolkmann/postgresql-easy/issues
- npm.io page: https://npm.io/package/postgresql-easy

## Dependencies (1)

- [pg](https://npm.io/package/pg.md) ^8.11.3

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.3.0 (latest) — 2023-09-21
- 1.2.5 — 2019-06-04
- 1.2.4 — 2018-01-30
- 1.2.3 — 2018-01-25
- 1.2.2 — 2017-11-04
- 1.2.1 — 2017-11-04
- 1.2.0 — 2017-11-04
- 1.1.14 — 2017-11-03
- 1.1.13 — 2017-10-31
- 1.1.12 — 2017-10-31
- 1.1.11 — 2017-10-31
- 1.1.10 — 2017-10-31
- 1.1.9 — 2017-05-12
- 1.1.8 — 2017-05-12
- 1.1.7 — 2017-05-11
- … 8 more at https://npm.io/package/postgresql-easy/versions

## README

# postgresql-easy

[![Build Status](https://secure.travis-ci.org/mvolkmann/postgresql-easy.png)](http://travis-ci.org/mvolkmann/postgresql-easy)

This is a Node module that makes it very simple
to interact with PostgreSQL databases.
It has the same API as https://github.com/mvolkmann/mysql-easier.

To install this, run `npm install -S postgresql-easy`

## Setup

```js
const PgConnection = require('postgresql-easy');
const pg = new PgConnection(config);
```

## Demo

To run the demo code, follow these steps:
1) Start database daemon with `pg_ctl -D /usr/local/var/postgres start`
2) Create the demo database with `createdb demo`
3) Start interactive mode with `psql -d demo`
4) Create a table with
   create table demo_user (
     id serial primary key,
     username text,
     password text
   );
5) Exit interactive mode with ctrl-d.
6) Run the demo with `npm run demo`

## API

The config object can contain these properties:
* `database`: the name of the database to use
* `debug`: true to output messages describing each action; defaults to false
* `host`: defaults to localhost
* `idleTimeoutMillis`: time before connection is closed; default is 30000
* `max`: maximum number of clients in pool; default is 10
* `password`: if database requires authentication
* `port`: defaults to 5432
* `user`: if database requires authentication

The only one of these that is always required is "database".

PgConnection objects provide seven methods.
All but `disconnect` return a promise.
One way to use the returned promise is to chain calls to `then` and `catch`.
Another is to use `async` and `await`.

## `deleteAll`
This deletes all records from a given table.

```js
try {
  await pg.deleteAll('flavors');
  // Do something after successful delete.
} catch (e) {
  // Handle the error.
}
```

## `deleteById`
This deletes a record from a given table by id.
It requires the table to have a column named "id".

```js
try {
  await pg.delete('flavors', 7);
  // Do something after successful delete.
} catch (e) {
  // Handle the error.
}
```

## `disconnect`
This disconnects from the database.

```js
pg.disconnect();
```

## `getAll`
This gets all records from a given table.

```js
try {
  const result = await pg.getAll('flavors');
  // Process data in the array result.
} catch (e) {
  // Handle the error.
}
```

## `getById`
This gets a record from a given table by id.
It requires the table to have a column named "id".

```js
try {
  const result = await pg.getById('flavors', 7);
  // Process data in the array result.
} catch (e) {
  // Handle the error.
}
```

## `insert`
This inserts a record into a given table
and returns the id of the new record.
The keys of obj are column names
and their values are the values to insert.

```js
try {
  const result = pg.insert('flavors', {name: 'vanilla', calories: 100});
  // Do something after successful insert.
  // result will be the id of the newly inserted row.
} catch (e) {
  // Handle the error.
}
```

## `query`
This executes a SQL query.
It is the most general purpose function provided.
It is used by several of the other functions.

```js
const sql = 'select name from flavors where calories < 150';
try {
  const result = await pg.query(sql);
  // Do something with the result set in result.
} catch (e) {
  // Handle the error.
}

const sql = 'select name from flavors where calories < $1 and cost < $2';
try {
  const result = await pg.query(sql, 200, 3);
  // Do something with the result set in result.
} catch (e) {
  // Handle the error.
}
```

## `updateById`
This updates a record in a given table by id.
It requires the table to have a column named "id".

```js
try {
  const result = pg.updateById(
    'flavors', 7, {name: 'chocolate', calories: 200});
  // Do something with the result set in result.
  // result will be an object describing the updated row.
} catch (e) {
  // Handle the error.
}
```

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