kwaeri-node-kit-postgresql-database-driver

A Massively Modified Open Source Project by kirvedx

The @kwaeri/postgresql-database-driver component for the @kwaeri/node-kit application platform

TOC

• The Implementation
• Getting Started
  • Installation
  • Include the Component
  • Provide a Configuration
• Usage
  • Query the Database
• How to Contribute Code
• Other Ways to Contribute
  • Bug Reports
  • Vulnerability Reports
    • Confidential Issues
  • Donations

The Implementation

@kwaeri/postgresql-database-driver reinvents the postgresql database driver portion of the nodekit application platform.

Since the mysql-database-driver component was originally baked into the nk module, its usage was entirely controlled by it. As we discern the process for decoupling the individual components which make up a kwaeri application, we'll begin to simplify the act of doing so, and provide documentation for utilizing each component individually.

Getting Started

@kwaeri/node-kit wraps the various components under the kwaeri scope necessary for building a kwaeri application, and provides a single entry point for easing the process of building a kwaeri application.

@kwaeri/cli wraps the various CLI components under the @kwaeri scope, and provides a single entry point to the user executable framework.

However, if you wish to use @kwaeri/postgresql-database-driver - perform the following steps:

Installation

Install @kwaeri/postgresql-database-driver:

npm install @kwaeri/postgresql-database-driver

Include the Component

To leverage kwaeri/postgresql-database-driver, you'll need to import it:

// INCLUDES
import { PostgreSQLDriver } from '@kwaeri/postgresql-database-driver';

Provide a configuration

In order to instantiate a database object, you'll need to provide a configuration of type DriverConnectionBits:

const conf: DriverConnectionBits ={
  type:     "postgresql",
  host:     "localhost",
  port:     5432,
  database: "dbname",
  user:     "dbuser",
  password: "password"
};

Using the Provided postgresql-database-drivers

Once you've updated the properties with the correct values for your database instance, supply the configuration to the postgresql-database-driver's constructor:

const dbo = new PostgreSQLDriver( conf );

Usage

The database provider is required to expose at least a query member; though each implementation may decide on its complete offering;

const { rows, fields } = await dbo.query( `select * from tablename` );

With PostgreSQL, our connection pooling does support a generic query that, as the usage above implies, makes use of any available client connections in the pool. However, we also do have a way to checkout a client and reserve it until we are done with it so that there is no waiting beyond that:

const { rows, fields } = await dbo.clientQuery( `select * from tablename` );

We have not disclosed every way in which the PostgreSQLDriver package may be leveraged - but the majority of its usage will be in calling its query(), or clientQuery() method(s).

Query the Database

An example of querying the database with the provided PostgreSQL database driver:

// Always catch errors when expecting a promise. You
// could use traditional async/await like here, or
// go the traditional route.
try {
    const { rows, fields } = await dbo
    .query( `select * from people where first_name='Richard' and last_name='Winters';` );

    console.log( `Returned record Id: ${( rows as any )[0].id}` +
                `, First name: ${( rows as any )[0].first_name}` +
                `, Last name: ${( rows as any )[0].last_name}` +
                `, Age: ${( rows as any )[0].age}` );
}
catch( error ) {
    console.log( `[ERROR]: ${error}` );
}

The return is structured according to the pg connector's implementation (i.e. pg in this case), but this is typically how it should be.

You can also use prepared statements:

// Always catch errors when expecting a promise. You
// could use traditional async/await like here, or
// go the traditional route.
try {
    const { rows, fields } = await dbo
    .query( `select * from people where first_name=$1 and last_name=$2;`, ["Richard"], ["Winters"] );

    console.log( `Returned record Id: ${( rows as any )[0].id}` +
                `, First name: ${( rows as any )[0].first_name}` +
                `, Last name: ${( rows as any )[0].last_name}` +
                `, Age: ${( rows as any )[0].age}` );

    // For example:
    return Promise.resolve( { rows, fields } as QueryResult );
}
catch( error ) {
    console.log( `[ERROR]: ${error}` );

    return Promise.reject( `${error}` );
}

Both of the above examples can replace .query with .clientQuery:

// Always catch errors when expecting a promise. You
// could use traditional async/await like here, or
// go the traditional route.
try {
    const { rows, fields } = await dbo
    .clientQuery( `select * from people where first_name=$1 and last_name=$2;`, ["Richard"], ["Winters"] );

    console.log( `Returned record Id: ${( rows as any )[0].id}` +
                `, First name: ${( rows as any )[0].first_name}` +
                `, Last name: ${( rows as any )[0].last_name}` +
                `, Age: ${( rows as any )[0].age}` );
}
catch( error ) {
    console.log( `[ERROR]: ${error}` );
}

However, in all cases you will need to ensure that you release the pool when you're done with it:

// Release the pool of connections, this calls pool.end()
await dbo.destroyPool();

Forgetting to release the connection pool can lead to subsequent scripts waiting forever for a client regardess of the method used.

NOTE

As mentioned earlier, the plan is to continue development of the individual components of a kwaeri application - the postgresql-database-driver component included - and ultimately ease the process of making use of each individual component as they are decoupled from one another.

More documentation to come!

How to Contribute Code

Our Open Source projects are always open to contribution. If you'd like to cocntribute, all we ask is that you follow the guidelines for contributions, which can be found at the Massively Modified Wiki

There you'll find topics such as the guidelines for contributions; step-by-step walk-throughs for getting set up, Coding Standards, CSS Naming Conventions, and more.

The project also leverages Keybase for communication and alerts - outside of standard email. To join our keybase chat, run the following from terminal (assuming you have keybase installed and running):

keybase team request-access kwaeri

Alternatively, you could search for the team in the GUI application and request access from there.

Other Ways to Contribute

There are other ways to contribute to the project other than with code. Consider testing the software, or in case you've found an Bug - please report it. You can also support the project monetarly through donations via PayPal.

Regardless of how you'd like to contribute, you can also find in-depth information for how to do so at the Massively Modified Wiki

Bug Reports

To submit bug reports, request enhancements, and/or new features - please make use of the issues system baked-in to our source control project space at Gitlab

You may optionally start an issue, track, and manage it via email by sending an email to our project's support desk.

For more in-depth documentation on the process of submitting bug reports, please visit the Massively Modified Wiki on Bug Reports

Vulnerability Reports

Our Vulnerability Reporting process is very similar to Gitlab's. In fact, you could say its a fork.

To submit vulnerability reports, please email our Security Group. We will try to acknowledge receipt of said vulnerability by the next business day, and to also provide regular updates about our progress. If you are curious about the status of your report feel free to email us again. If you wish to encrypt your disclosure email, like with gitlab - please email us to ask for our GPG Key.

Please refrain from requesting compensation for reporting vulnerabilities. We will publicly acknowledge your responsible disclosure, if you request us to do so. We will also try to make the confidential issue public after the vulnerability is announced.

You are not allowed, and will not be able, to search for vulnerabilities on Gitlab.com. As our software is open source, you may download a copy of the source and test against that.

Confidential Issues

When a vulnerability is discovered, we create a [confidential issue] to track it internally. Security patches will be pushed to private branches and eventually merged into a security branch. Security issues that are not vulnerabilites can be seen on our public issue tracker.

For more in-depth information regarding vulnerability reports, confidentiality, and our practices; Please visit the Massively Modified Wiki on Vulnerability

Donations

If you cannot contribute time or energy to neither the code base, documentation, nor community support; please consider making a monetary contribution which is extremely useful for maintaining the Massively Modified network and all the goodies offered free to the public.