sharp-db

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>Parser/Parser.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">Parser/Parser.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>const capitalize = require('lodash/capitalize'); const camelCase = require('lodash/camelCase'); const upperFirst = require('lodash/upperFirst'); /** * Parse SQL and populate onto a Select query object */ class Parser { /** * Create a new instance * @param {Select} query A Select object on which to build parsed conditions */ constructor(query) { this.query = query; } /** * Strip single-line and multi-line comment blocks * @param {String} sql The SQL string * @return {String} * @private */ _stripComments(sql) { // multiline comments sql = sql.replace(/\/\*[\s\S]*?\*\//g, ''); // single line comments -- dashes sql = sql.replace(/--([\r\n]|\s+[^\r\n]+[\r\n])/g, ''); // single line comments #hashes sql = sql.replace(/#[^\r\n]+[\r\n]/g, ''); return sql; } /** * Before splitting into SQL clauses, extract some regex-able subqueries * @param {String} sql The unparsed sql string * @return {Object} An array with new sql and subqueries * @private */ _extractSubqueries(sql) { const subqueries = {}; let i = 0; const extractor = $0 => { const placeholder = `~~SUBQUERY_${i++}~~`; subqueries[placeholder] = $0; return placeholder; }; // subselect in FROM clause sql = sql.replace(/$\s*SELECT\s+.+$\s+AS\s+[^\s,]+/, extractor); // IF() in FROM clause sql = sql.replace(/\bIF\s*$.+$\s+AS\s+[^\s,]+/, extractor); // IN (SELECT *) in JOINs, WHERE or HAVING sql = sql.replace(/\bIN\s*$\s*SELECT\s.+?$/, extractor); return { sql, subqueries }; } /** * Inject column subqueries back into this object * @param {Object} subqueries The lookup of extracted subqueries * @private */ _injectSubqueries(subqueries) { const replacer = $0 => { return subqueries[$0] || $0; }; const mapper = clause => { return clause.replace(/~~SUBQUERY_\d+~~/g, replacer); }; this.query._columns = this.query._columns.map(replacer); this.query._joins = this.query._joins.map(mapper); this.query._wheres = this.query._wheres.map(mapper); this.query._havings = this.query._havings.map(mapper); } /** * Split SQL into clauses (used by ::parse()) * @param {String} sql The SQL to split * @return {String[]} * @private */ _split(sql) { const splitter = /(?:^|\s)(SELECT|FROM|(?:INNER|LEFT\s+OUTER|RIGHT\s+OUTER|LEFT|RIGHT|CROSS|FULL|FULL\s+OUTER)\s+JOIN|WHERE|GROUP BY|HAVING|ORDER BY|LIMIT|OFFSET)\b/i; return sql.split(splitter); } /** * Get a QuickSelect object representing the given SQL SELECT statement * @param {String} rawSql The raw SQL for the SELECT statement * @return {Boolean} */ parse(rawSql) { const stripped = this._stripComments(rawSql); const { sql, subqueries } = this._extractSubqueries(stripped); const expressions = this._split(sql); let i = 1; while (i < expressions.length) { const rawKeyword = expressions[i++].trim(); const keyword = upperFirst(camelCase(rawKeyword)); const clause = expressions[i++].trim(); const handler = `_handle${keyword}`; this[handler](clause); } this._injectSubqueries(subqueries); return true; } /** * Handle SQL_CALC_FOUND_ROWS and column names * @param {String} clause The clause after the SELECT * @private */ _handleSelect(clause) { let columns = clause.split(/s*,s*/); // now handle parenthesis expressions that contain commas let buffer = ''; columns.forEach((column, i) => { if (i === 0) { const optionRegex = /^(SQL_CALC_FOUND_ROWS)\s+/i; const match = column.match(optionRegex); if (match) { this.query.option(match[1]); column = column.replace(optionRegex, ''); } } if (buffer.length) { // we are in the middle of an expression containing parenthesis if (column.indexOf(')') > 0) { // we have an end parenthesis buffer += column; this.query.column(buffer.trim()); buffer = ''; } else { buffer += column + ','; } } else if (column.match(/\([^)]+$/)) { buffer = column + ','; } else { this.query.column(column.trim()); } }); } /** * Handle table names * @param {String} clause The clause after the FROM * @private */ _handleFrom(clause) { const tables = clause.split(/\s*,\s*/); tables.forEach(table => this.query.table(table)); } /** * Handle INNER JOIN statements * @param {String} clause The clause after the INNER JOIN * @private */ _handleInnerJoin(clause) { this.query.innerJoin(clause); } /** * Handle LEFT JOIN statements * @param {String} clause The clause after the LEFT JOIN * @private */ _handleLeftJoin(clause) { this.query.leftJoin(clause); } /** * Handle LEFT OUTER JOIN statements * @param {String} clause The clause after the LEFT OUTER JOIN * @private */ _handleLeftOuterJoin(clause) { this.query.leftOuterJoin(clause); } /** * Handle RIGHT JOIN statements * @param {String} clause The clause after the RIGHT JOIN * @private */ _handleRightJoin(clause) { this.query.rightJoin(clause); } /** * Handle RIGHT OUTER JOIN statements * @param {String} clause The clause after the RIGHT OUTER JOIN * @private */ _handleRightOuterJoin(clause) { this.query.rightOuterJoin(clause); } /** * Handle CROSS JOIN statements * @param {String} clause The clause after the CROSS JOIN * @private */ _handleCrossJoin(clause) { this.query.crossJoin(clause); } /** * Handle FULL JOIN statements * @param {String} clause The clause after the FULL JOIN * @private */ _handleFullJoin(clause) { this.query.fullJoin(clause); } /** * Handle FULL OUTER JOIN statements * @param {String} clause The clause after the FULL OUTER JOIN * @private */ _handleFullOuterJoin(clause) { this.query.fullOuterJoin(clause); } /** * Handle WHERE conditions * @param {String} clause All the conditions after WHERE * @private */ _handleWhere(clause) { if (/^(1|'1'|true)$/i.test(clause)) { this.query._wheres.push(clause); } else { this._handleConditions('where', clause); } } /** * Handle HAVING statements * @param {String} clause All the conditions after HAVING * @private */ _handleHaving(clause) { this._handleConditions('having', clause); } /** * Build a conditions list * @param {String} type Either WHERE or HAVING * @param {String} clause The expressions following the type keyword * @private */ _handleConditions(type, clause) { const andGroups = clause.split(/\bAND\b/i); andGroups.forEach(andGroup => { const orPieces = andGroup.split(/\bOR\b/i).map(str => str.trim()); if (orPieces.length === 1) { // no OR operators const fn = type; // either where or having this.query[fn](orPieces[0]); } else { // some OR operators const orFn = 'or' + capitalize(type); // either orWhere or orHaving this.query[orFn](orPieces); } }); } /** * Handle GROUP BY statements * @param {String} clause The clauses after the GROUP BY * @private */ _handleGroupBy(clause) { const columns = clause.split(/\s*,\s*/); columns.forEach(column => this.query.groupBy(column)); } /** * Handle ORDER BY statements * @param {String} clause The clause after the ORDER BY * @private */ _handleOrderBy(clause) { const columns = clause.split(/\s*,\s*/); columns.forEach(column => this.query.orderBy(column)); } /** * Handle LIMIT statements including "LIMIT #" and "LIMIT #, #" * @param {String} clause The clause after the LIMIT * @private */ _handleLimit(clause) { const offsetLimit = clause.match(/^(\d+|\?|:\w+)\s*,\s*(\d+|\?|:\w+)$/); if (offsetLimit) { this.query.offset(offsetLimit[1]); this.query.limit(offsetLimit[2]); } else { this.query.limit(clause); } } /** * Handle OFFSET statements * @param {String} clause The number after the OFFSET * @private */ _handleOffset(clause) { this.query.offset(clause); } } module.exports = Parser; </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>