nodejs_psql v1.0.5

node_psql

node_psql is built by using pure socket based on https://www.postgresql.org/docs/8.2/static/protocol-message-formats.html

Note: node_psql is for exploring postgres database purpose

1. Startup :white_check_mark:
2. Simple Query :white_check_mark:
3. Extended Query :white_check_mark:
4. Function Call :x:
5. COPY Operations :white_check_mark:
6. Asynchronous Operations :white_check_mark:
7. Canceling Requests in Progress :x:
8. Termination :white_check_mark:
9. SSL Session Encryption :white_check_mark:

Installation

$ npm install nodejs_psql

Start up

const Psql = require('nodejs_psql');

const psql = new Psql({
  user: 'user',
  database: 'db',
  password: 'user',
  port: 5432,
  ssl: true,
});

psql.connect();

Simple Query

psql.query(`SELECT * FROM photo;`, (res) => res );

psql.query(`INSERT INTO photo (name, description, filename, views, age) VALUES ('new', 'description', 'filename', 1, 2);`, (res) => res);

psql.query(`UPDATE photo SET description='xxx' WHERE name='new';`, (res) => res);

psql.query(`DELETE FROM photo WHERE name='new';`, (res) => res);

Function Call

Note: Currently, using simple query instead, since function call is a legacy feature.

psql.query(`CREATE FUNCTION query_all() RETURNS SETOF photo AS $$ SELECT * FROM photo $$ LANGUAGE SQL;`);

psql.query(`select query_all()`);

psql.query(`DROP FUNCTION query_all()`);

Transaction example

psql.query(`
  BEGIN;
    select * from photo;
  COMMIT;`
);

Extended Query

psql.extQuery(`SELECT * FROM photo;`, (res) => res);

COPY Operations

Standard input/output

psql.copyFrom({
  copy: 'photo',
  data: [
    [ '1', 'user', 'I am near polar bears', 'photo-with-bears.jpg', '1', '0'],
    [ '2', 'user', 'I am near bears', 'photo-with-bears.jpg', '4', '1'],
  ]
});

psql.copyTo({
   copy: 'photo',
   delimiter: ','
}, (res) => { console.log(res) });

Non standard input/output

psql.query(`COPY photo FROM 'PATH/YOUR_FILE.csv' DELIMITER ','; `);
psql.query(`COPY photo TO 'PATH/YOUR_FILE.csv' DELIMITER ',';`);

SSL Session Encryption

It supports any CA that can be recognised by Nodejs tls modules. Currently rejectUnauthorized is set up to false, so any self-signed CA works. In ssl/self-signed-certificate, it roughly gives an idea how to generate a self-signed-certificate by using openssl command line tools.

License

Copyright (c) 2017, Li Xu All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE