pgc4d

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 21 Open GitHub ↗

A full-featured PostgreSQL Client for Deno

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# pgc4d - PostgreSQL client for Deno

A full-featured PostgreSQL client for [Deno](https://deno.land) including support for:

- Connectivity using TCP, SSL* and Unix domain sockets*
  - Buffered and streaming responses
  - Various shapes of result sets (keyed rows, indexed rows, column, etc.)
  - Asynchronous notifications (using LISTEN and NOTIFY)
  - Arrays, record types and user-defined types (enums)
  - Concurrent queries (queueing)

Philosophical differences from [deno-postgres](https://github.com/deno-postgres/deno-postgres):

- Does not aim for API compatibility with Node's `node-postgres`
  - Uses only binary value encoding in client <> server communication
  - No magic detection of data types (is `[1, 2, 3]` an `int[]` or a `json` value?) - see [bugs](https://github.com/brianc/node-postgres/issues/442)
  - Strict layering of protocol and logic layers - see [the interface](src/message_types.ts)

(* currently requires `--unstable` in Deno)

## Usage

```ts
import { connectPg } from 'https://deno.land/x/pgc4d/src/mod.ts'

const db = await connectPg('postgres://username:password@hostname/database')
try {
    const result = await db.query('SELECT $1::int + $2::int sum', [10, 20])
    assertEquals(result.rows[0].sum, 30)
} finally {
    db.close()
}
```

## Documentation

[API documentation](https://doc.deno.land/https/raw.githubusercontent.com/jakajancar/pgc4d/master/src/mod.ts)

[Manual](https://github.com/jakajancar/pgc4d/wiki/Getting-started)

## Contributing

Happy to accept fixes and improvements.

1. Please add tests for added functionality and ensure CI passes.
 2. Follow the prevalent coding style (no semicolons, no 80-char line limit, single quotes, etc.)

You can use Docker to bring up PostgreSQL and run the tests:

$ docker-compose run ci

## License

Licensed under the [MIT license](LICENSE).

pgc4d

Today's picks

Was this content helpful?

Recent Feedback

pgc4d

Today's picks

Was this content helpful?

Recent Feedback

Download README