sharp-db

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>QueryLogger/QueryLogger.js - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading">C<a href="DataBroker.html">DataBroker</a></li><li class="nav-item">F<a href="DataBroker.html#cleanup">cleanup</a></li><li class="nav-item">F<a href="DataBroker.html#created_and_modified">created_and_modified</a></li><li class="nav-item">F<a href="DataBroker.html#createdAndModified">createdAndModified</a></li><li class="nav-item">F<a href="DataBroker.html#delete">delete</a></li><li class="nav-item">F<a href="DataBroker.html#insert">insert</a></li><li class="nav-heading">C<a href="Db.html">Db</a></li><li class="nav-item">F<a href="Db.html#.destroyAll">destroyAll</a></li><li class="nav-item">F<a href="Db.html#.endAll">endAll</a></li><li class="nav-item">F<a href="Db.html#.factory">factory</a></li><li class="nav-item">F<a href="Db.html#.withInstance">withInstance</a></li><li class="nav-item">F<a href="Db.html#beginTransaction">beginTransaction</a></li><li class="nav-item">F<a href="Db.html#bindArgs">bindArgs</a></li><li class="nav-item">F<a href="Db.html#commit">commit</a></li><li class="nav-item">F<a href="Db.html#connect">connect</a></li><li class="nav-item">F<a href="Db.html#connectOnce">connectOnce</a></li><li class="nav-item">F<a href="Db.html#delete">delete</a></li><li class="nav-item">F<a href="Db.html#deleteFrom">deleteFrom</a></li><li class="nav-item">F<a href="Db.html#destroy">destroy</a></li><li class="nav-item">F<a href="Db.html#emit">emit</a></li><li class="nav-item">F<a href="Db.html#emitError">emitError</a></li><li class="nav-item">F<a href="Db.html#end">end</a></li><li class="nav-item">F<a href="Db.html#escape">escape</a></li><li class="nav-item">F<a href="Db.html#escapeLike">escapeLike</a></li><li class="nav-item">F<a href="Db.html#escapeQuoteless">escapeQuoteless</a></li><li class="nav-item">F<a href="Db.html#exportAsSql">exportAsSql</a></li><li class="nav-item">F<a href="Db.html#insert">insert</a></li><li class="nav-item">F<a href="Db.html#insertExtended">insertExtended</a></li><li class="nav-item">F<a href="Db.html#insertInto">insertInto</a></li><li class="nav-item">F<a href="Db.html#insertIntoOnDuplicateKeyUpdate">insertIntoOnDuplicateKeyUpdate</a></li><li class="nav-item">F<a href="Db.html#multiQuery">multiQuery</a></li><li class="nav-item">F<a href="Db.html#query">query</a></li><li class="nav-item">F<a href="Db.html#quote">quote</a></li><li class="nav-item">F<a href="Db.html#rollback">rollback</a></li><li class="nav-item">F<a href="Db.html#select">select</a></li><li class="nav-item">F<a href="Db.html#selectByKey">selectByKey</a></li><li class="nav-item">F<a href="Db.html#selectExists">selectExists</a></li><li class="nav-item">F<a href="Db.html#selectFirst">selectFirst</a></li><li class="nav-item">F<a href="Db.html#selectFrom">selectFrom</a></li><li class="nav-item">F<a href="Db.html#selectGrouped">selectGrouped</a></li><li class="nav-item">F<a href="Db.html#selectHash">selectHash</a></li><li class="nav-item">F<a href="Db.html#selectId">selectId</a></li><li class="nav-item">F<a href="Db.html#selectIndexed">selectIndexed</a></li><li class="nav-item">F<a href="Db.html#selectList">selectList</a></li><li class="nav-item">F<a href="Db.html#selectOrCreate">selectOrCreate</a></li><li class="nav-item">F<a href="Db.html#selectOrCreateId">selectOrCreateId</a></li><li class="nav-item">F<a href="Db.html#selectUuid">selectUuid</a></li><li class="nav-item">F<a href="Db.html#selectValue">selectValue</a></li><li class="nav-item">F<a href="Db.html#startTransaction">startTransaction</a></li><li class="nav-item">F<a href="Db.html#tpl">tpl</a></li><li class="nav-item">F<a href="Db.html#update">update</a></li><li class="nav-item">F<a href="Db.html#updateTable">updateTable</a></li><li class="nav-heading">C<a href="DbEvent.html">DbEvent</a></li><li class="nav-heading">C<a href="Parser.html">Parser</a></li><li class="nav-item">F<a href="Parser.html#_extractSubqueries">_extractSubqueries</a></li><li class="nav-item">F<a href="Parser.html#_handleConditions">_handleConditions</a></li><li class="nav-item">F<a href="Parser.html#_handleCrossJoin">_handleCrossJoin</a></li><li class="nav-item">F<a href="Parser.html#_handleFrom">_handleFrom</a></li><li class="nav-item">F<a href="Parser.html#_handleFullJoin">_handleFullJoin</a></li><li class="nav-item">F<a href="Parser.html#_handleFullOuterJoin">_handleFullOuterJoin</a></li><li class="nav-item">F<a href="Parser.html#_handleGroupBy">_handleGroupBy</a></li><li class="nav-item">F<a href="Parser.html#_handleHaving">_handleHaving</a></li><li class="nav-item">F<a href="Parser.html#_handleInnerJoin">_handleInnerJoin</a></li><li class="nav-item">F<a href="Parser.html#_handleLeftJoin">_handleLeftJoin</a></li><li class="nav-item">F<a href="Parser.html#_handleLeftOuterJoin">_handleLeftOuterJoin</a></li><li class="nav-item">F<a href="Parser.html#_handleLimit">_handleLimit</a></li><li class="nav-item">F<a href="Parser.html#_handleOffset">_handleOffset</a></li><li class="nav-item">F<a href="Parser.html#_handleOrderBy">_handleOrderBy</a></li><li class="nav-item">F<a href="Parser.html#_handleRightJoin">_handleRightJoin</a></li><li class="nav-item">F<a href="Parser.html#_handleRightOuterJoin">_handleRightOuterJoin</a></li><li class="nav-item">F<a href="Parser.html#_handleSelect">_handleSelect</a></li><li class="nav-item">F<a href="Parser.html#_handleWhere">_handleWhere</a></li><li class="nav-item">F<a href="Parser.html#_injectSubqueries">_injectSubqueries</a></li><li class="nav-item">F<a href="Parser.html#_split">_split</a></li><li class="nav-item">F<a href="Parser.html#_stripComments">_stripComments</a></li><li class="nav-item">F<a href="Parser.html#parse">parse</a></li><li class="nav-heading">C<a href="Select.html">Select</a></li><li class="nav-item">F<a href="Select.html#._extractBindingName">_extractBindingName</a></li><li class="nav-item">F<a href="Select.html#.init">init</a></li><li class="nav-item">F<a href="Select.html#.parse">parse</a></li><li class="nav-item">F<a href="Select.html#_conditions">_conditions</a></li><li class="nav-item">F<a href="Select.html#_isEntirelyDigits">_isEntirelyDigits</a></li><li class="nav-item">F<a href="Select.html#_isEntirelyDigitsNoZeros">_isEntirelyDigitsNoZeros</a></li><li class="nav-item">F<a href="Select.html#_isPlaceholder">_isPlaceholder</a></li><li class="nav-item">F<a href="Select.html#_spliceChildData">_spliceChildData</a></li><li class="nav-item">F<a href="Select.html#_spliceSiblingData">_spliceSiblingData</a></li><li class="nav-item">F<a href="Select.html#bind">bind</a></li><li class="nav-item">F<a href="Select.html#column">column</a></li><li class="nav-item">F<a href="Select.html#columns">columns</a></li><li class="nav-item">F<a href="Select.html#crossJoin">crossJoin</a></li><li class="nav-item">F<a href="Select.html#escape">escape</a></li><li class="nav-item">F<a href="Select.html#escapeLike">escapeLike</a></li><li class="nav-item">F<a href="Select.html#escapeQuoteless">escapeQuoteless</a></li><li class="nav-item">F<a href="Select.html#fetch">fetch</a></li><li class="nav-item">F<a href="Select.html#fetchFirst">fetchFirst</a></li><li class="nav-item">F<a href="Select.html#fetchGrouped">fetchGrouped</a></li><li class="nav-item">F<a href="Select.html#fetchHash">fetchHash</a></li><li class="nav-item">F<a href="Select.html#fetchIndexed">fetchIndexed</a></li><li class="nav-item">F<a href="Select.html#fetchList">fetchList</a></li><li class="nav-item">F<a href="Select.html#fetchValue">fetchValue</a></li><li class="nav-item">F<a href="Select.html#foundRows">foundRows</a></li><li class="nav-item">F<a href="Select.html#from">from</a></li><li class="nav-item">F<a href="Select.html#fullJoin">fullJoin</a></li><li class="nav-item">F<a href="Select.html#fullOuterJoin">fullOuterJoin</a></li><li class="nav-item">F<a href="Select.html#getClone">getClone</a></li><li class="nav-item">F<a href="Select.html#getFoundRowsQuery">getFoundRowsQuery</a></li><li class="nav-item">F<a href="Select.html#getFoundRowsSql">getFoundRowsSql</a></li><li class="nav-item">F<a href="Select.html#groupBy">groupBy</a></li><li class="nav-item">F<a href="Select.html#having">having</a></li><li class="nav-item">F<a href="Select.html#innerJoin">innerJoin</a></li><li class="nav-item">F<a href="Select.html#join">join</a></li><li class="nav-item">F<a href="Select.html#leftJoin">leftJoin</a></li><li class="nav-item">F<a href="Select.html#leftOuterJoin">leftOuterJoin</a></li><li class="nav-item">F<a href="Select.html#limit">limit</a></li><li class="nav-item">F<a href="Select.html#normalized">normalized</a></li><li class="nav-item">F<a href="Select.html#offset">offset</a></li><li class="nav-item">F<a href="Select.html#option">option</a></li><li class="nav-item">F<a href="Select.html#orderBy">orderBy</a></li><li class="nav-item">F<a href="Select.html#orHaving">orHaving</a></li><li class="nav-item">F<a href="Select.html#orWhere">orWhere</a></li><li class="nav-item">F<a href="Select.html#page">page</a></li><li class="nav-item">F<a href="Select.html#parse">parse</a></li><li class="nav-item">F<a href="Select.html#reset">reset</a></li><li class="nav-item">F<a href="Select.html#rightJoin">rightJoin</a></li><li class="nav-item">F<a href="Select.html#rightOuterJoin">rightOuterJoin</a></li><li class="nav-item">F<a href="Select.html#sortField">sortField</a></li><li class="nav-item">F<a href="Select.html#table">table</a></li><li class="nav-item">F<a href="Select.html#tables">tables</a></li><li class="nav-item">F<a href="Select.html#toBoundSql">toBoundSql</a></li><li class="nav-item">F<a href="Select.html#toString">toString</a></li><li class="nav-item">F<a href="Select.html#unbind">unbind</a></li><li class="nav-item">F<a href="Select.html#unjoin">unjoin</a></li><li class="nav-item">F<a href="Select.html#where">where</a></li><li class="nav-item">F<a href="Select.html#whereBetween">whereBetween</a></li><li class="nav-item">F<a href="Select.html#withChildData">withChildData</a></li><li class="nav-item">F<a href="Select.html#withSiblingData">withSiblingData</a></li><li class="nav-heading">C<a href="Ssh.html">Ssh</a></li><li class="nav-item">F<a href="Ssh.html#end">end</a></li><li class="nav-item">F<a href="Ssh.html#tunnelTo">tunnelTo</a></li> </nav> <div id="main"> <h1 class="page-title">QueryLogger/QueryLogger.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>class QueryLogger { constructor() { this._logs = []; this._watching = []; } /** * Watch the given Db instance * @param {Db} db The Db instance * @param {String[]} events A list of events to watch for * Default is query, select, insert, update, delete * @return {QueryLogger} */ watch(db, events = ['query', 'select', 'insert', 'update', 'delete']) { for (const event of events) { db.on(event, this.capture); } this._watching.push({ db, events, }); return this; } /** * Stop watching the given Db instance * @param {Db} db The db to stop watching * @return {QueryLogger} */ unwatch(db) { const newWatchList = []; for (const watched of this._watching) { if (watched.db === db) { for (const event of watched.events) { db.off(event, this.capture); } } else { newWatchList.push(watched); } } this._watching = newWatchList; return this; } /** * Save the type and query from a DbEvent object * @param {DbEvent} evt The DbEvent object * @return {QueryLogger} */ capture = evt => { this._logs.push({ type: evt.type, query: evt.data.query, db: evt.target, }); return this; }; /** * Clear out all logs * @return {QueryLogger} */ clear() { this._logs = []; return this; } /** * Get the raw array of logs * @return {Object[]} */ getLogs() { return this._logs; } /** * Get all the query strings * @param {Function} [filter=null] Function used to filter the logs * @return {String[]} */ getQueries(filter = null) { const filtered = filter ? this._logs.filter(filter) : this._logs; return filtered.map(log => log.query); } /** * Get the query string from the last query * @return {String|null} */ getLastQuery() { const last = this._logs[this._logs.length - 1]; return last ? last.query : null; } } module.exports = QueryLogger; </code></pre> </article> </section> </div> <footer> Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 18:14:46 GMT-0600 (Mountain Daylight Time) using the Minami theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>