@rduk/data-pg

RDUK - PostgreSQL Data Provider

This module is an implementation of @rduk/data/lib/base for PostgreSQL.

Installation

Peer dependencies

Don't forget to add this modules to your project:

• @rduk/configuration
• @rduk/data
• @rduk/errors
• pg.

npm i --save @rduk/configuration @rduk/data pg @rduk/data-pg @rduk/errors

Configuration

# config.yml
---
connections:
  -
    name: conn1
    user: ${PG_USER}
    password: ${PG_PASSWORD}
    database: ${PG_DB_NAME}
data:
  default: pg
  providers:
    -
      name: pg
      type: '@rduk/data-pg'
      connection: conn1
  query:
    provider: '@rduk/data-pg/queryProvider' # manage specific pg syntax

See @rduk/configuration for more information.

Usage

Insert

First, instantiate a new QueryProvider

const Visitor = require('@rduk/data/lib/sql/visitor/expression')
const PostgreSQLQueryProvider = require('@rduk/data-pg/lib/queryProvider')

const provider = new PostgreSQLQueryProvider(Visitor)

Next, prepare an InsertExpression

const FieldExpression = require('@rduk/expression/lib/parser/expression/field')
const InsertExpression = require('@rduk/data/lib/sql/expression/insert')
const NameExpression = require('@rduk/expression/lib/parser/expression/name')
const PropertyExpression = require('@rduk/expression/lib/parser/expression/property')
const SourceExpression = require('@rduk/data/lib/expression/source')

let expression = new InsertExpression(new SourceExpression('users'))
let obj = new ObjectLiteralExpression([
    new FieldExpression('email', new PropertyExpression(new NameExpression('this'), 'email')),
    new FieldExpression('username', new PropertyExpression(new NameExpression('this'), 'username')),
    new FieldExpression('password', new PropertyExpression(new NameExpression('this'), 'password')),
    new FieldExpression('salt', new PropertyExpression(new NameExpression('this'), 'salt'))
])
let assignment = new LambdaExpression(obj, [])
expression.assignments.push(assignment)

Finally, execute your query

provider.execute(expression, {
    email: '[e-mail]',
    username: 'kimung',
    password: '$2y$10$jMA23KsnU7kMQq1Wlr6PbOJWb0kD1j1P1RDdylfL739XE3gcX7UWq',
    salt: '5f7086760c3d96f5f90faac2f46c59940d83d8c84df5beef3725d8d8f02171b1'
}).then(result => {
    console.log(result);
})

/**
 * The pool.query method of pg module will be called with:
 *   - command: 'INSERT INTO users (email, username, password, salt) VALUES ($1, $2, $3, $4) RETURNING *'
 *   - parameters: [
 *       '[e-mail]',
 *       'kimung',
 *       '$2y$10$jMA23KsnU7kMQq1Wlr6PbOJWb0kD1j1P1RDdylfL739XE3gcX7UWq',
 *       '5f7086760c3d96f5f90faac2f46c59940d83d8c84df5beef3725d8d8f02171b1',
 *     ]
 * 
 */

License and copyright

See LICENSE file.