Class: PGClient

Constructor

new PGClient()

Source: libpostgres/postgres.js, line 7

Methods

Connect(host, port, username, password) → {bool}

Connect connects to Postgres database using given credentials. The connection is closed after the function returns.

Parameters:

Name	Type	Description
`host`	string	The host of the Postgres database.
`port`	int	The port of the Postgres database.
`username`	string	The username to connect to the Postgres database.
`password`	string	The password to connect to the Postgres database.

Source: libpostgres/postgres.js, line 22

Throws:

- If connection is unsuccessful, it returns the error.
Type error

Returns:

- If connection is successful, it returns true.

Type:: bool

Example

let m = require('nuclei/postgres');
let c = m.PGClient();
let isConnected = c.Connect('localhost', 5432, 'username', 'password');

ConnectWithDB(host, port, username, password, dbName) → {bool}

ConnectWithDB connects to Postgres database using given credentials and database name. The connection is closed after the function returns.

Parameters:

Name	Type	Description
`host`	string	The host of the Postgres database.
`port`	int	The port of the Postgres database.
`username`	string	The username to connect to the Postgres database.
`password`	string	The password to connect to the Postgres database.
`dbName`	string	The name of the database to connect to.

Source: libpostgres/postgres.js, line 41

Throws:

- If connection is unsuccessful, it returns the error.
Type error

Returns:

- If connection is successful, it returns true.

Type:: bool

Example

let m = require('nuclei/postgres');
let c = m.PGClient();
let isConnected = c.ConnectWithDB('localhost', 5432, 'username', 'password', 'mydb');

ExecuteQuery(host, port, username, password, dbName, query) → {string}

ExecuteQuery connects to Postgres database using given credentials and database name and executes a query on the db.

Parameters:

Name	Type	Description
`host`	string	The host of the Postgres database.
`port`	int	The port of the Postgres database.
`username`	string	The username to connect to the Postgres database.
`password`	string	The password to connect to the Postgres database.
`dbName`	string	The name of the database to connect to.
`query`	string	The query to execute on the database.

Source: libpostgres/postgres.js, line 61

Throws:

- If query execution is unsuccessful, it returns the error.
Type error

Returns:

- The result of the query execution.

Type:: string

Example

let m = require('nuclei/postgres');
let c = m.PGClient();
let result = c.ExecuteQuery('localhost', 5432, 'username', 'password', 'mydb', 'SELECT * FROM users');

IsPostgres(host, port) → {bool}

IsPostgres checks if the given host and port are running Postgres database.

Parameters:

Name	Type	Description
`host`	string	The host to check.
`port`	int	The port to check.

Source: libpostgres/postgres.js, line 77

Throws:

- If the check is unsuccessful, it returns the error.
Type error

Returns:

- If the host and port are running Postgres database, it returns true.

Type:: bool

Example

let m = require('nuclei/postgres');
let c = m.PGClient();
let isPostgres = c.IsPostgres('localhost', 5432);