Mysql

mysql

• mysql
  • MySQLClient
    • .Connect(host, port, username, password) ⇒ bool
    • .ConnectWithDB(host, port, username, password, dbName) ⇒ bool
    • .ExecuteQuery(host, port, username, password, dbName, query) ⇒ string
    • .IsMySQL(host, port) ⇒ bool

(mysql).MySQLClient

MySQLClient is a client for MySQL database. Internally client uses go-sql-driver/mysql driver.

Kind: inner class of mysql

• MySQLClient
  • .Connect(host, port, username, password) ⇒ bool
  • .ConnectWithDB(host, port, username, password, dbName) ⇒ bool
  • .ExecuteQuery(host, port, username, password, dbName, query) ⇒ string
  • .IsMySQL(host, port) ⇒ bool

mySQLClient.Connect(host, port, username, password) ⇒ bool

Connect connects to MySQL database using given credentials. If connection is successful, it returns true. If connection is unsuccessful, it returns false and error. The connection is closed after the function returns.

Kind: instance method of MySQLClient
Returns: bool - - The result of the connection attempt.
Throws:

• error - The error encountered during connection attempt.

Param	Type	Description
host	string	The host of the MySQL database.
port	int	The port of the MySQL database.
username	string	The username to connect to the MySQL database.
password	string	The password to connect to the MySQL database.

Example

let m = require('nuclei/mysql');
let c = m.MySQLClient();
let result = c.Connect('localhost', 3306, 'root', 'password');

mySQLClient.ConnectWithDB(host, port, username, password, dbName) ⇒ bool

ConnectWithDB connects to MySQL database using given credentials and database name. If connection is successful, it returns true. If connection is unsuccessful, it returns false and error. The connection is closed after the function returns.

Kind: instance method of MySQLClient
Returns: bool - - The result of the connection attempt.
Throws:

• error - The error encountered during connection attempt.

Param	Type	Description
host	string	The host of the MySQL database.
port	int	The port of the MySQL database.
username	string	The username to connect to the MySQL database.
password	string	The password to connect to the MySQL database.
dbName	string	The name of the database to connect to.

Example

let m = require('nuclei/mysql');
let c = m.MySQLClient();
let result = c.ConnectWithDB('localhost', 3306, 'root', 'password', 'mydb');

mySQLClient.ExecuteQuery(host, port, username, password, dbName, query) ⇒ string

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

Kind: instance method of MySQLClient
Returns: string - - The result of the query execution.
Throws:

• error - The error encountered during query execution.

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

Example

let m = require('nuclei/mysql');
let c = m.MySQLClient();
let result = c.ExecuteQuery('localhost', 3306, 'root', 'password', 'mydb', 'SELECT * FROM users');

mySQLClient.IsMySQL(host, port) ⇒ bool

IsMySQL checks if the given host is running MySQL database. If the host is running MySQL database, it returns true. If the host is not running MySQL database, it returns false.

Kind: instance method of MySQLClient
Returns: bool - - The result of the check.
Throws:

• error - The error encountered during the check.

Param	Type	Description
host	string	The host to check.
port	int	The port to check.

Example

let m = require('nuclei/mysql');
let c = m.MySQLClient();
let result = c.IsMySQL('localhost', 3306);