PostgreSQL driver for Deno
Branch: master
Clone or download
Latest commit ebf639c Feb 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib update tsconfig, add gitignore, update deno types Jan 15, 2019
tests
.gitignore update tsconfig, add gitignore, update deno types Jan 15, 2019
.travis.yml update deno_std to v0.2.8 Feb 12, 2019
LICENSE add LICENSE and licence notices Jan 19, 2019
README.md Update README.md Feb 11, 2019
client.ts prototype Jan 29, 2019
connection.ts decode timestamps Feb 10, 2019
connection_params.ts add TODO, update README Jan 25, 2019
decode.ts
deps.ts
encode.ts
error.ts
mod.ts
oid.ts first pass at decoding data rows Feb 10, 2019
packet_reader.ts basic error handling Jan 14, 2019
packet_writer.ts update deno_std to v0.2.8 Feb 12, 2019
query.ts
test.ts update deno_std to v0.2.8 Feb 12, 2019
tsconfig.json
utils.ts

README.md

deno-postgres Build Status Gitter chat

PostgreSQL driver for Deno.

It's still work in progress, but you can take it for a test drive!

deno-postgres is being developed based on excellent work of node-postgres and pq.

To Do:

  • connecting to database
  • password handling - cleartext, MD5
  • DSN style connection parameters
  • reading connection parameters from environmental variables
  • termination of connection
  • simple queries (no arguments)
  • parsing Postgres data types to native TS types
  • row description
  • parametrized queries
  • connection pooling
  • parsing error response
  • SSL
  • tests, tests, tests

Example

import { Client } from "https://deno.land/x/postgres/mod.ts";

async function main() {
    const client = new Client({ user: "user", database: "test", host: "localhost", port: "5432" });
    await client.connect();
    const result = await client.query("SELECT * FROM people;");
    console.log(result.rows);
    await client.end();
}

main();

API

deno-postgres follows node-postgres API to make transition for Node devs as easy as possible.

Connecting to DB

If any of parameters is missing it is read from environmental variable.

import { Client } from "https://deno.land/x/postgres/mod.ts";

let config;

config = {
    host: "localhost",
    port: "5432",
    user: "user", 
    database: "test",
    application_name: "my_custom_app",
};
// alternatively
config = "postgres://user@localhost:5432/test?application_name=my_custom_app";

const client = new Client(config);
await client.connect();
await client.end();

Queries

Simple query

const result = await client.query('SELECT * FROM people;');
console.log(result.rows);

Parametrized query

const result = await client.query('SELECT * FROM people WHERE age > $1 AND age < $2;', 10, 20);
console.log(result.rows);

// equivalent using QueryConfig interface
const result = await client.query({
    text: 'SELECT * FROM people WHERE age > $1 AND age < $2;', 
    args: [10, 20]
});
console.log(result.rows);

License

There are substantial parts of this library based on other libraries. They have preserved their individual licenses and copyrights.

Eveything is licensed under the MIT License.

All additional work is copyright 2018 - 2019 — Bartłomiej Iwańczuk — All rights reserved.