pulpfixer v1.4.21

Class: abstract DatabaseInstance

Abstract class for database instances

Constructors

new DatabaseInstance()

new DatabaseInstance(config): DatabaseInstance

Create a new database instance

Parameters

config

Partial<Record<string, string | number | boolean>>

{IConnectionConfig}

Returns

DatabaseInstance

Methods

connect()

abstract connect(): Promise<void>

Connect to the database

Returns

Promise<void>

query()

abstract query(sql, params?): Promise<any>

Execute a query

Parameters

sql

string

{string}

params?

{any[] | object}

object | any[]

Returns

Promise<any>

Example

const result = await sql.query('SELECT * FROM users where id = ?', [ 1 ]);

close()

abstract close(): Promise<void>

Close the database connection

Returns

Promise<void>

insert()

abstract insert(sql, params?): Promise<string | number>

Insert a record

Parameters

sql

string

{string}

params?

{any[] | object}

object | any[]

Returns

Promise<string | number>

Example

const inserted_id = await sql.insert('INSERT INTO users (name, email) VALUES (?, ?)', [ 'John', 'john@example.com' ]);