MDBDialect

MDBDialect

MariaDB + MySQL Dialect implementation for sqler

Constructor

new MDBDialect(priv, connConf, track, errorLoggeropt, loggeropt, debugopt)

Constructor

Source:
Parameters:
Name Type Attributes Description
priv typedefs.SQLERPrivateOptions

The private configuration options

connConf MDBConnectionOptions

The individual SQL connection configuration for the given dialect that was passed into the originating Manager

track typedefs.SQLERTrack

Container for sharing data between Dialect instances.

errorLogger function <optional>

A function that takes one or more arguments and logs the results as an error (similar to console.error)

logger function <optional>

A function that takes one or more arguments and logs the results (similar to console.log)

debug Boolean <optional>

A flag that indicates the dialect should be run in debug mode (if supported)

Members

(protected) driver

Source:

state

Source:

Methods

(async) beginTransaction(txId, opts) → {typedefs.SQLERTransaction}

Begins a transaction by opening a connection from the pool

Source:
Parameters:
Name Type Description
txId String

The internally generated transaction identifier

opts typedefs.SQLERTransactionOptions

The transaction options passed in via the public API

Returns:
Type:
typedefs.SQLERTransaction

The transaction that was started

(async) close() → {Integer}

Closes the MariaDB/MySQL connection pool

Source:
Returns:
Type:
Integer

The number of connections closed

(async) exec(sql, opts, frags, meta, errorOptsopt) → {typedefs.SQLERExecResults}

Executes a SQL statement

Source:
Parameters:
Name Type Attributes Description
sql String

the SQL to execute

opts MDBExecOptions

The execution options

frags Array.<String>

the frament keys within the SQL that will be retained

meta typedefs.SQLERExecMeta

The SQL execution metadata

errorOpts typedefs.SQLERExecErrorOptions | Boolean <optional>

The error options to use

Returns:
Type:
typedefs.SQLERExecResults

The execution results

(async) init(opts) → {Object}

Initializes MDBDialect by creating the connection pool

Source:
Parameters:
Name Type Description
opts typedefs.SQLERInitOptions

The options described by the sqler module

Returns:
Type:
Object

The MariaDB/MySQL connection pool


3.1.1 (2021-08-20)

Full Changelog

Features: