100 lines
2.7 KiB
HTML
100 lines
2.7 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<title>JSDoc: Source: Adapter.js</title>
|
||
|
|
|
||
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
||
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<div id="main">
|
||
|
|
|
||
|
|
<h1 class="page-title">Source: Adapter.js</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<article>
|
||
|
|
<pre class="prettyprint source linenums"><code>/**
|
||
|
|
* Class that wraps database connection libraries
|
||
|
|
*
|
||
|
|
* @private
|
||
|
|
* @param {Promise} instance - The connection object
|
||
|
|
*/
|
||
|
|
class Adapter {
|
||
|
|
/**
|
||
|
|
* Invoke an adapter
|
||
|
|
*
|
||
|
|
* @constructor
|
||
|
|
* @param {Promise} instance - Promise holding connection object
|
||
|
|
*/
|
||
|
|
constructor (instance) {
|
||
|
|
this.instance = instance;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Run the sql query as a prepared statement
|
||
|
|
*
|
||
|
|
* @param {String} sql - The sql with placeholders
|
||
|
|
* @param {Array} params - The values to insert into the query
|
||
|
|
* @return {Promise} - returns a promise resolving to the result of the database query
|
||
|
|
*/
|
||
|
|
execute (sql, params) {
|
||
|
|
throw new Error('Correct adapter not defined for query execution');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Transform the adapter's result into a standard format
|
||
|
|
*
|
||
|
|
* @param {*} originalResult - the original result object from the driver
|
||
|
|
* @return {Result} - the new result object
|
||
|
|
*/
|
||
|
|
transformResult (originalResult) {
|
||
|
|
throw new Error('Result transformer method not defined for current adapter');
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Close the current database connection
|
||
|
|
* @return {void}
|
||
|
|
*/
|
||
|
|
close () {
|
||
|
|
this.instance.then(conn => conn.end());
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
module.exports = Adapter;
|
||
|
|
</code></pre>
|
||
|
|
</article>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav>
|
||
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-drivers_MariaDB.html">drivers/MariaDB</a></li><li><a href="module-drivers_MSSQLDriver.html">drivers/MSSQLDriver</a></li><li><a href="module-drivers_Mysql.html">drivers/Mysql</a></li><li><a href="module-drivers_Pg.html">drivers/Pg</a></li><li><a href="module-drivers_Sqlite.html">drivers/Sqlite</a></li></ul><h3>Classes</h3><ul><li><a href="NodeQuery.html">NodeQuery</a></li><li><a href="QueryBuilder.html">QueryBuilder</a></li><li><a href="Result.html">Result</a></li></ul>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<br class="clear">
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Feb 12 2018 14:58:25 GMT-0500 (EST)
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
<script> prettyPrint(); </script>
|
||
|
|
<script src="scripts/linenumber.js"> </script>
|
||
|
|
</body>
|
||
|
|
</html>
|