​

Class: MySQLClient

mysql.MySQLClient

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

Example

const mysql = require('nuclei/mysql');
const client = new mysql.MySQLClient;

​

Table of contents

​

Constructors

• constructor

​

Methods

• Connect
• ConnectWithDSN
• ExecuteQuery
• ExecuteQueryOnDB
• ExecuteQueryWithOpts
• FingerprintMySQL
• IsMySQL

​

Constructors

​

constructor

• new MySQLClient(): MySQLClient

​

Returns

MySQLClient

​

Defined in

mysql.ts:33

​

Methods

​

Connect

▸ Connect(host, port, username): boolean

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.

​

Parameters

​

Returns

boolean

Example

const mysql = require('nuclei/mysql');
const client = new mysql.MySQLClient;
const connected = client.Connect('acme.com', 3306, 'username', 'password');

​

Defined in

mysql.ts:61

​

ConnectWithDSN

▸ ConnectWithDSN(dsn): boolean

ConnectWithDSN connects to MySQL database using given DSN. we override mysql dialer with fastdialer so it respects network policy If connection is successful, it returns true.

​

Parameters

​

Returns

boolean

Example

const mysql = require('nuclei/mysql');
const client = new mysql.MySQLClient;
const connected = client.ConnectWithDSN('username:password@tcp(acme.com:3306)/');

​

Defined in

mysql.ts:91

​

ExecuteQuery

▸ ExecuteQuery(host, port, username): SQLResult

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

​

Parameters

​

Returns

SQLResult

Example

const mysql = require('nuclei/mysql');
const result = mysql.ExecuteQuery('acme.com', 3306, 'username', 'password', 'SELECT * FROM users');
log(to_json(result));

​

Defined in

mysql.ts:124

​

ExecuteQueryOnDB

▸ ExecuteQueryOnDB(host, port, username): SQLResult

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

​

Parameters

​

Returns

SQLResult

Example

const mysql = require('nuclei/mysql');
const result = mysql.ExecuteQueryOnDB('acme.com', 3306, 'username', 'password', 'dbname', 'SELECT * FROM users');
log(to_json(result));

​

Defined in

mysql.ts:139

​

ExecuteQueryWithOpts

▸ ExecuteQueryWithOpts(opts, query): SQLResult

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

​

Parameters

​

Returns

SQLResult

Example

const mysql = require('nuclei/mysql');
const options = new mysql.MySQLOptions();
options.Host = 'acme.com';
options.Port = 3306;
const result = mysql.ExecuteQueryWithOpts(options, 'SELECT * FROM users');
log(to_json(result));

​

Defined in

mysql.ts:109

​

FingerprintMySQL

▸ FingerprintMySQL(host, port): MySQLInfo

returns MySQLInfo when fingerpint is successful

​

Parameters

​

Returns

MySQLInfo

Example

const mysql = require('nuclei/mysql');
const info = mysql.FingerprintMySQL('acme.com', 3306);
log(to_json(info));

​

Defined in

mysql.ts:75

​

IsMySQL

▸ IsMySQL(host, port): boolean

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.

​

Parameters

​

Returns

boolean

Example

const mysql = require('nuclei/mysql');
const isMySQL = mysql.IsMySQL('acme.com', 3306);

​

Defined in

mysql.ts:44