documentation/adapters_Pg_Pg.js.html from timw4mail/node-query

documentation/adapters_Pg_Pg.js.html
Summary

Maintainability

Test Coverage

Issues
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: adapters/Pg/Pg.js</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Source: adapters/Pg/Pg.js</h1>

    



    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>const Adapter = require('../../Adapter');
const Result = require('../../Result');
const Helpers = require('../../Helpers');
const pg = require('pg');
const url = require('url');

class Pg extends Adapter {
    constructor (config) {
        let instance = null;
        let connectionString = Pg.formatConnectionString(config);

        if (connectionString !== '') {
            const conn = new pg.Client(connectionString);
            conn.connect(err => {
                if (err) {
                    throw new Error(err);
                }
            });

            instance = Promise.resolve(conn);
        }

        super(instance);
    }

    /**
     * Convert the connection object to a connection string
     *
     * @param {Object} config - the configuration object
     * @return {String} - the connection string
     */
    static formatConnectionString (config) {
        let connectionString = '';

        if (Helpers.isObject(config)) {
            const host = config.host || 'localhost';
            const user = config.user || 'postgres';
            const password = `:${config.password}` || '';
            const port = config.port || 5432;

            const conn = {
                protocol: 'postgres',
                slashes: true,
                host: `${host}:${port}`,
                auth: `${user}${password}`,
                pathname: config.database
            };

            connectionString = url.format(conn);
        } else if (Helpers.isString(config)) {
            connectionString = config;
        }

        return connectionString;
    }

    /**
     * Transform the adapter's result into a standard format
     *
     * @param {*} result - original driver result object
     * @return {Result} - standard result object
     */
    transformResult (result) {
        if (result == null) {
            return new Result();
        }

        const cols = [];
        result.fields.forEach(field => {
            cols.push(field.name);
        });

        return new Result(result.rows, cols);
    }

    /**
     * Run the sql query as a prepared statement
     *
     * @param {String} sql - The sql with placeholders
     * @param {Array} params - The values to insert into the query
     * @return {void|Promise} - Returns a promise if no callback is provided
     */
    execute (sql, params) {
        // Replace question marks with numbered placeholders, because this adapter is different...
        let count = 0;
        sql = sql.replace(/\?/g, () => {
            count++;
            return `$${count}`;
        });

        return this.instance.then(conn => {
            return new Promise((resolve, reject) => {
                conn.query(sql, params, (err, result) =>
                    (err)
                        ? reject(err)
                        : resolve(this.transformResult(result))
                );
            });
        });
    }
}

module.exports = Pg;
</code></pre>
        </article>
    </section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-drivers_MariaDB.html">drivers/MariaDB</a></li><li><a href="module-drivers_MSSQLDriver.html">drivers/MSSQLDriver</a></li><li><a href="module-drivers_Mysql.html">drivers/Mysql</a></li><li><a href="module-drivers_Pg.html">drivers/Pg</a></li><li><a href="module-drivers_Sqlite.html">drivers/Sqlite</a></li></ul><h3>Classes</h3><ul><li><a href="NodeQuery.html">NodeQuery</a></li><li><a href="QueryBuilder.html">QueryBuilder</a></li><li><a href="Result.html">Result</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 12 2018 14:58:25 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>