373 lines
9.0 KiB
JavaScript
373 lines
9.0 KiB
JavaScript
// SPDX-License-Identifier: LGPL-2.1-or-later
|
|
// Copyright (c) 2015-2025 MariaDB Corporation Ab
|
|
|
|
'use strict';
|
|
|
|
const Stream = require('./cmd/stream');
|
|
const Errors = require('./misc/errors');
|
|
|
|
/**
|
|
* New Connection instance.
|
|
*
|
|
* @param options connection options
|
|
* @returns Connection instance
|
|
* @constructor
|
|
* @fires Connection#connect
|
|
* @fires Connection#end
|
|
* @fires Connection#error
|
|
*
|
|
*/
|
|
class ConnectionPromise {
|
|
#conn;
|
|
#capture;
|
|
|
|
constructor(conn) {
|
|
this.#conn = conn;
|
|
this.#capture = conn.opts.trace ? Error.captureStackTrace : () => {};
|
|
}
|
|
|
|
get threadId() {
|
|
return this.#conn.threadId;
|
|
}
|
|
|
|
get info() {
|
|
return this.#conn.info;
|
|
}
|
|
|
|
get prepareCache() {
|
|
return this.#conn.prepareCache;
|
|
}
|
|
|
|
/**
|
|
* Permit to change user during connection.
|
|
* All user variables will be reset, Prepare commands will be released.
|
|
* !!! mysql has a bug when CONNECT_ATTRS capability is set, that is default !!!!
|
|
*
|
|
* @param options connection options
|
|
* @returns {Promise} promise
|
|
*/
|
|
changeUser(options) {
|
|
const param = { opts: options };
|
|
this.#capture(param);
|
|
return new Promise(this.#conn.changeUser.bind(this.#conn, param));
|
|
}
|
|
|
|
/**
|
|
* Start transaction
|
|
*
|
|
* @returns {Promise} promise
|
|
*/
|
|
beginTransaction() {
|
|
const param = { sql: 'START TRANSACTION' };
|
|
this.#capture(param);
|
|
return new Promise(this.#conn.query.bind(this.#conn, param));
|
|
}
|
|
|
|
/**
|
|
* Commit a transaction.
|
|
*
|
|
* @returns {Promise} command if commit was needed only
|
|
*/
|
|
commit() {
|
|
const param = { sql: 'COMMIT' };
|
|
this.#capture(param);
|
|
return new Promise(this.#conn.changeTransaction.bind(this.#conn, param));
|
|
}
|
|
|
|
/**
|
|
* Roll back a transaction.
|
|
*
|
|
* @returns {Promise} promise
|
|
*/
|
|
rollback() {
|
|
const param = { sql: 'ROLLBACK' };
|
|
this.#capture(param);
|
|
return new Promise(this.#conn.changeTransaction.bind(this.#conn, param));
|
|
}
|
|
|
|
/**
|
|
* Execute query using text protocol.
|
|
*
|
|
* @param sql sql parameter Object can be used to supersede default option.
|
|
* Object must then have sql property.
|
|
* @param values object / array of placeholder values (not mandatory)
|
|
* @returns {Promise} promise
|
|
*/
|
|
query(sql, values) {
|
|
const cmdParam = paramSetter(sql, values);
|
|
this.#capture(cmdParam);
|
|
return new Promise(this.#conn.query.bind(this.#conn, cmdParam));
|
|
}
|
|
|
|
/**
|
|
* Execute a query returning a Readable Object that will emit columns/data/end/error events
|
|
* to permit streaming big result-set
|
|
*
|
|
* @param sql sql parameter Object can be used to supersede the default option.
|
|
* Object must then have `sql` property.
|
|
* @param values object / array of placeholder values (not mandatory)
|
|
* @returns {Readable}
|
|
*/
|
|
queryStream(sql, values) {
|
|
const cmdParam = paramSetter(sql, values);
|
|
this.#capture(cmdParam);
|
|
const cmd = new Stream(cmdParam, this.#conn.opts, this.#conn.socket);
|
|
if (this.#conn.opts.logger.error) cmd.on('error', this.#conn.opts.logger.error);
|
|
this.#conn.addCommand(cmd, true);
|
|
return cmd.inStream;
|
|
}
|
|
|
|
static _PARAM_DEF(sql, values) {
|
|
if (typeof sql === 'object') {
|
|
return { sql: sql.sql, values: sql.values ? sql.values : values, opts: sql };
|
|
} else return { sql: sql, values: values };
|
|
}
|
|
|
|
execute(sql, values) {
|
|
const cmdParam = paramSetter(sql, values);
|
|
this.#capture(cmdParam);
|
|
return new Promise(this.#conn.prepareExecute.bind(this.#conn, cmdParam));
|
|
}
|
|
|
|
static _EXECUTE_CMD(conn, cmdParam) {
|
|
return conn.prepareExecute(cmdParam);
|
|
}
|
|
|
|
prepare(sql) {
|
|
let param;
|
|
if (typeof sql === 'object') {
|
|
param = { sql: sql.sql, opts: sql };
|
|
} else {
|
|
param = { sql: sql };
|
|
}
|
|
this.#capture(param);
|
|
return new Promise(this.#conn.prepare.bind(this.#conn, param));
|
|
}
|
|
|
|
/**
|
|
* Execute batch using text protocol.
|
|
*
|
|
* @param sql sql parameter Object can be used to supersede default option.
|
|
* Object must then have sql property.
|
|
* @param values object / array of placeholder values
|
|
* @returns {Promise} promise
|
|
*/
|
|
batch(sql, values) {
|
|
const cmdParam = paramSetter(sql, values);
|
|
this.#capture(cmdParam);
|
|
return new Promise(this.#conn.batch.bind(this.#conn, cmdParam));
|
|
}
|
|
|
|
/**
|
|
* Import sql file.
|
|
*
|
|
* @param opts JSON array with 2 possible fields: file and database
|
|
*/
|
|
importFile(opts) {
|
|
if (!opts || !opts.file) {
|
|
return Promise.reject(
|
|
Errors.createError(
|
|
'SQL file parameter is mandatory',
|
|
Errors.ER_MISSING_SQL_PARAMETER,
|
|
this.#conn.info,
|
|
'HY000',
|
|
null,
|
|
false,
|
|
null
|
|
)
|
|
);
|
|
}
|
|
return new Promise(this.#conn.importFile.bind(this.#conn, { file: opts.file, database: opts.database }));
|
|
}
|
|
|
|
/**
|
|
* Send an empty MySQL packet to ensure connection is active, and reset @@wait_timeout
|
|
* @param timeout (optional) timeout value in ms. If reached, throw error and close connection
|
|
* @returns {Promise} promise
|
|
*/
|
|
ping(timeout) {
|
|
const cmdParam = {
|
|
opts: { timeout: timeout }
|
|
};
|
|
this.#capture(cmdParam);
|
|
return new Promise(this.#conn.ping.bind(this.#conn, cmdParam));
|
|
}
|
|
|
|
/**
|
|
* Send a reset command that will
|
|
* - rollback any open transaction
|
|
* - reset transaction isolation level
|
|
* - reset session variables
|
|
* - delete user variables
|
|
* - remove temporary tables
|
|
* - remove all PREPARE statement
|
|
*
|
|
* @returns {Promise} promise
|
|
*/
|
|
reset() {
|
|
const cmdParam = {};
|
|
this.#capture(cmdParam);
|
|
return new Promise(this.#conn.reset.bind(this.#conn, cmdParam));
|
|
}
|
|
|
|
/**
|
|
* Indicates the state of the connection as the driver knows it
|
|
* @returns {boolean}
|
|
*/
|
|
isValid() {
|
|
return this.#conn.isValid();
|
|
}
|
|
|
|
/**
|
|
* Terminate connection gracefully.
|
|
*
|
|
* @returns {Promise} promise
|
|
*/
|
|
end() {
|
|
const cmdParam = {};
|
|
this.#capture(cmdParam);
|
|
return new Promise(this.#conn.end.bind(this.#conn, cmdParam));
|
|
}
|
|
|
|
/**
|
|
* Alias for destroy.
|
|
*/
|
|
close() {
|
|
this.destroy();
|
|
}
|
|
|
|
/**
|
|
* Force connection termination by closing the underlying socket and killing server process if any.
|
|
*/
|
|
destroy() {
|
|
this.#conn.destroy();
|
|
}
|
|
|
|
pause() {
|
|
this.#conn.pause();
|
|
}
|
|
|
|
resume() {
|
|
this.#conn.resume();
|
|
}
|
|
|
|
format(sql, values) {
|
|
this.#conn.format(sql, values);
|
|
}
|
|
|
|
/**
|
|
* return current connected server version information.
|
|
*
|
|
* @returns {*}
|
|
*/
|
|
serverVersion() {
|
|
return this.#conn.serverVersion();
|
|
}
|
|
|
|
/**
|
|
* Change option "debug" during connection.
|
|
* @param val debug value
|
|
*/
|
|
debug(val) {
|
|
return this.#conn.debug(val);
|
|
}
|
|
|
|
debugCompress(val) {
|
|
return this.#conn.debugCompress(val);
|
|
}
|
|
|
|
escape(val) {
|
|
return this.#conn.escape(val);
|
|
}
|
|
|
|
escapeId(val) {
|
|
return this.#conn.escapeId(val);
|
|
}
|
|
|
|
//*****************************************************************
|
|
// EventEmitter proxy methods
|
|
//*****************************************************************
|
|
|
|
on(eventName, listener) {
|
|
this.#conn.on.call(this.#conn, eventName, listener);
|
|
return this;
|
|
}
|
|
|
|
off(eventName, listener) {
|
|
this.#conn.off.call(this.#conn, eventName, listener);
|
|
return this;
|
|
}
|
|
|
|
once(eventName, listener) {
|
|
this.#conn.once.call(this.#conn, eventName, listener);
|
|
return this;
|
|
}
|
|
|
|
listeners(eventName) {
|
|
return this.#conn.listeners.call(this.#conn, eventName);
|
|
}
|
|
|
|
addListener(eventName, listener) {
|
|
this.#conn.addListener.call(this.#conn, eventName, listener);
|
|
return this;
|
|
}
|
|
|
|
eventNames() {
|
|
return this.#conn.eventNames.call(this.#conn);
|
|
}
|
|
|
|
getMaxListeners() {
|
|
return this.#conn.getMaxListeners.call(this.#conn);
|
|
}
|
|
|
|
listenerCount(eventName, listener) {
|
|
return this.#conn.listenerCount.call(this.#conn, eventName, listener);
|
|
}
|
|
|
|
prependListener(eventName, listener) {
|
|
this.#conn.prependListener.call(this.#conn, eventName, listener);
|
|
return this;
|
|
}
|
|
|
|
prependOnceListener(eventName, listener) {
|
|
this.#conn.prependOnceListener.call(this.#conn, eventName, listener);
|
|
return this;
|
|
}
|
|
|
|
removeAllListeners(eventName, listener) {
|
|
this.#conn.removeAllListeners.call(this.#conn, eventName, listener);
|
|
return this;
|
|
}
|
|
|
|
removeListener(eventName, listener) {
|
|
this.#conn.removeListener.call(this.#conn, eventName, listener);
|
|
return this;
|
|
}
|
|
|
|
setMaxListeners(n) {
|
|
this.#conn.setMaxListeners.call(this.#conn, n);
|
|
return this;
|
|
}
|
|
|
|
rawListeners(eventName) {
|
|
return this.#conn.rawListeners.call(this.#conn, eventName);
|
|
}
|
|
|
|
//*****************************************************************
|
|
// internal public testing methods
|
|
//*****************************************************************
|
|
|
|
get __tests() {
|
|
return this.#conn.__tests;
|
|
}
|
|
}
|
|
|
|
const paramSetter = function (sql, values) {
|
|
if (typeof sql === 'object') {
|
|
return { sql: sql.sql, values: sql.values ? sql.values : values, opts: sql };
|
|
} else return { sql: sql, values: values };
|
|
};
|
|
|
|
module.exports = ConnectionPromise;
|
|
module.exports.paramSetter = paramSetter;
|