README
egg-pg
Install
$ npm i egg-pg --save
PostgreSQL Plugin for egg, support egg application access to PostgreSQL database.
This plugin based on node-postgres, if you want to know specific usage, you should refer to the document of node-postgres.
Configuration
Change ${app_root}/config/plugin.js to enable PostgreSQL plugin:
exports.pg = {
enable: true,
package: 'egg-pg',
};
Configure database information in ${app_root}/config/config.default.js:
Simple database instance
exports.pg = {
// database configuration
client: {
// host
host: 'pg.com',
// port
port: '5432',
// username
user: 'test_user',
// password
password: 'test_password',
// database
database: 'test',
},
// load into app, default is open
app: true,
// load into agent, default is close
agent: false,
// use pool or client, default is true for pool
pool: true,
};
Usage:
app.pg.query(sql, values); // you can access to simple database instance by using app.pg.
app.pg.get('db1').query(sql,values); // if there is multiple db
e.g:
app.pg.query('SELECT * FROM core.user WHERE id = $1', [ userId ]);
app.pg.get('db1').query('SELECT * FROM core.user WHERE id = $1', [ userId ]);