Class: MSSQLClient

mssql.MSSQLClient

Client is a client for MS SQL database. Internally client uses denisenkom/go-mssqldb driver.

Example

const mssql = require('nuclei/mssql');
const client = new mssql.Client();

Table of contents

Constructors

Methods

Constructors

constructor

new MSSQLClient(): MSSQLClient

Returns

MSSQLClient

Defined in

mssql.ts:16

Methods

Connect

Connect(host, port, username): boolean

Connect connects to MS SQL 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

NameType
hoststring
portnumber
usernamestring

Returns

boolean

Example

const mssql = require('nuclei/mssql');
const client = new mssql.Client();
const connected = client.Connect('acme.com', 1433, 'username', 'password');

Defined in

mssql.ts:29


ConnectWithDB

ConnectWithDB(host, port, username): boolean

ConnectWithDB connects to MS SQL 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.

Parameters

NameType
hoststring
portnumber
usernamestring

Returns

boolean

Example

const mssql = require('nuclei/mssql');
const client = new mssql.Client();
const connected = client.ConnectWithDB('acme.com', 1433, 'username', 'password', 'master');

Defined in

mssql.ts:46


IsMssql

IsMssql(host, port): boolean

IsMssql checks if the given host is running MS SQL database. If the host is running MS SQL database, it returns true. If the host is not running MS SQL database, it returns false.

Parameters

NameType
hoststring
portnumber

Returns

boolean

Example

const mssql = require('nuclei/mssql');
const isMssql = mssql.IsMssql('acme.com', 1433);

Defined in

mssql.ts:61