Members

(constant) queryResult :number

Type:

• number

Properties:

Source:

• result.js, line 22

See:

• Database.query, Database.func

Type Definitions

EventContext

Properties:

Source:

• events.js, line 470

TaskContext

Properties:

Source:

• task.js, line 313

Events

connect

Parameters:

Source:

• events.js, line 13

Example

const initOptions = {

    // pg-promise initialization options...

    connect: (client, dc, isFresh) => {
        const cp = client.connectionParameters;
        console.log('Connected to database:', cp.database);
    }

};

disconnect

Parameters:

Source:

• events.js, line 65

Example

const initOptions = {

    // pg-promise initialization options...

    disconnect: (client, dc) => {
       const cp = client.connectionParameters;
       console.log('Disconnecting from database:', cp.database);
    }

};

error

Parameters:

Source:

• events.js, line 296

Example

const initOptions = {

    // pg-promise initialization options...

    error: (err, e) => {

        if (e.cn) {
            // this is a connection-related error
            // cn = safe connection details passed into the library:
            //      if password is present, it is masked by #
        }

        if (e.query) {
            // query string is available
            if (e.params) {
                // query parameters are available
            }
        }

        if (e.ctx) {
            // occurred inside a task or transaction
        }
      }
};

extend

Parameters:

Source:

• events.js, line 349

See:

• pg-promise-demo

Examples

// In the example below we extend the protocol with function `addImage`
// that will insert one binary image and resolve with the new record id.

const initOptions = {

    // pg-promise initialization options...

    extend: (obj, dc) => {
        // dc = database context;
        obj.addImage = data => {
            // adds a new image and resolves with its record id:
            return obj.one('INSERT INTO images(data) VALUES($1) RETURNING id', data, a => a.id);
        }
    }
};

// It is best to extend the protocol by adding whole entity repositories to it as shown in the following example.
// For a comprehensive example see https://github.com/vitaly-t/pg-promise-demo

class UsersRepository {
    constructor(rep, pgp) {
        this.rep = rep;
        this.pgp = pgp;
    }

    add(name) {
        return this.rep.one('INSERT INTO users(name) VALUES($1) RETURNING id', name, a => a.id);
    }

    remove(id) {
        return this.rep.none('DELETE FROM users WHERE id = $1', id);
    }
}

// Overriding 'extend' event;
const initOptions = {

    // pg-promise initialization options...

    extend: (obj, dc) => {
        // dc = database context;
        obj.users = new UsersRepository(obj, pgp);
        // You can set different repositories based on `dc`
    }
};

// Usage example:
db.users.add('John', true)
    .then(id => {
        // user added successfully, id = new user's id
    })
    .catch(error => {
        // failed to add the user;
    });

query

Parameters:

Source:

• events.js, line 105

Example

const initOptions = {

    // pg-promise initialization options...

    query: e => {
        console.log('QUERY:', e.query);
    }
};

receive

Parameters:

Source:

• events.js, line 140

Example

// Example below shows the fastest way to camelize all column names:

const initOptions = {

    // pg-promise initialization options...

    receive: (data, result, e) => {
        camelizeColumns(data);
    }
};

function camelizeColumns(data) {
    const tmp = data[0];
    for (let prop in tmp) {
        const camel = pgp.utils.camelize(prop);
        if (!(camel in tmp)) {
            for (let i = 0; i < data.length; i++) {
                const d = data[i];
                d[camel] = d[prop];
                delete d[prop];
            }
        }
    }
}

task

Parameters:

Source:

• events.js, line 208

Example

const initOptions = {

    // pg-promise initialization options...

    task: e => {
        if (e.ctx.finish) {
            // this is a task->finish event;
            console.log('Duration:', e.ctx.duration);
            if (e.ctx.success) {
                // e.ctx.result = resolved data;
            } else {
                // e.ctx.result = error/rejection reason;
            }
        } else {
            // this is a task->start event;
            console.log('Start Time:', e.ctx.start);
        }
    }
};

transact

Parameters:

Source:

• events.js, line 252

Example

const initOptions = {

    // pg-promise initialization options...

    transact: e => {
        if (e.ctx.finish) {
            // this is a transaction->finish event;
            console.log('Duration:', e.ctx.duration);
            if (e.ctx.success) {
                // e.ctx.result = resolved data;
            } else {
                // e.ctx.result = error/rejection reason;
            }
        } else {
            // this is a transaction->start event;
            console.log('Start Time:', e.ctx.start);
        }
    }
};