You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

434 lines
14 KiB
JavaScript

// Query Compiler
// -------
'use strict';
var _ = require('lodash');
var helpers = require('../helpers');
var Raw = require('../raw');
var assign = require('lodash/object/assign');
var reduce = require('lodash/collection/reduce');
// The "QueryCompiler" takes all of the query statements which
// have been gathered in the "QueryBuilder" and turns them into a
// properly formatted / bound query string.
function QueryCompiler(client, builder) {
this.client = client;
this.method = builder._method || 'select';
this.options = builder._options;
this.single = builder._single;
this.grouped = _.groupBy(builder._statements, 'grouping');
this.formatter = client.formatter();
}
var components = ['columns', 'join', 'where', 'union', 'group', 'having', 'order', 'limit', 'offset', 'lock'];
assign(QueryCompiler.prototype, {
// Used when the insert call is empty.
_emptyInsertValue: 'default values',
// Collapse the builder into a single object
toSQL: function toSQL(method) {
method = method || this.method;
var val = this[method]();
var defaults = {
method: method,
options: reduce(this.options, assign, {}),
bindings: this.formatter.bindings
};
if (_.isString(val)) {
val = { sql: val };
}
if (method === 'select' && this.single.as) {
defaults.as = this.single.as;
}
return assign(defaults, val);
},
// Compiles the `select` statement, or nested sub-selects
// by calling each of the component compilers, trimming out
// the empties, and returning a generated query string.
select: function select() {
var i = -1,
statements = [];
while (++i < components.length) {
statements.push(this[components[i]](this));
}
return _.compact(statements).join(' ');
},
pluck: function pluck() {
return {
sql: this.select(),
pluck: this.single.pluck
};
},
// Compiles an "insert" query, allowing for multiple
// inserts using a single query statement.
insert: function insert() {
var insertValues = this.single.insert || [];
var sql = 'insert into ' + this.tableName + ' ';
if (Array.isArray(insertValues)) {
if (insertValues.length === 0) {
return '';
}
} else if (typeof insertValues === 'object' && _.isEmpty(insertValues)) {
return sql + this._emptyInsertValue;
}
var insertData = this._prepInsert(insertValues);
if (typeof insertData === 'string') {
sql += insertData;
} else {
if (insertData.columns.length) {
sql += '(' + this.formatter.columnize(insertData.columns);
sql += ') values (';
var i = -1;
while (++i < insertData.values.length) {
if (i !== 0) sql += '), (';
sql += this.formatter.parameterize(insertData.values[i]);
}
sql += ')';
} else if (insertValues.length === 1 && insertValues[0]) {
sql += this._emptyInsertValue;
} else {
sql = '';
}
}
return sql;
},
// Compiles the "update" query.
update: function update() {
// Make sure tableName is processed by the formatter first.
var tableName = this.tableName;
var updateData = this._prepUpdate(this.single.update);
var wheres = this.where();
return 'update ' + tableName + ' set ' + updateData.join(', ') + (wheres ? ' ' + wheres : '');
},
// Compiles the columns in the query, specifying if an item was distinct.
columns: function columns() {
var distinct = false;
if (this.onlyUnions()) return '';
var columns = this.grouped.columns || [];
var i = -1,
sql = [];
if (columns) {
while (++i < columns.length) {
var stmt = columns[i];
if (stmt.distinct) distinct = true;
if (stmt.type === 'aggregate') {
sql.push(this.aggregate(stmt));
} else if (stmt.value && stmt.value.length > 0) {
sql.push(this.formatter.columnize(stmt.value));
}
}
}
if (sql.length === 0) sql = ['*'];
return 'select ' + (distinct ? 'distinct ' : '') + sql.join(', ') + (this.tableName ? ' from ' + this.tableName : '');
},
aggregate: function aggregate(stmt) {
var val = stmt.value;
var splitOn = val.toLowerCase().indexOf(' as ');
var distinct = stmt.aggregateDistinct ? 'distinct ' : '';
// Allows us to speciy an alias for the aggregate types.
if (splitOn !== -1) {
var col = val.slice(0, splitOn);
var alias = val.slice(splitOn + 4);
return stmt.method + '(' + distinct + this.formatter.wrap(col) + ') as ' + this.formatter.wrap(alias);
}
return stmt.method + '(' + distinct + this.formatter.wrap(val) + ')';
},
// Compiles all each of the `join` clauses on the query,
// including any nested join queries.
join: function join() {
var sql = '',
i = -1,
joins = this.grouped.join;
if (!joins) return '';
while (++i < joins.length) {
var join = joins[i];
var table = join.schema ? join.schema + '.' + join.table : join.table;
if (i > 0) sql += ' ';
if (join.joinType === 'raw') {
sql += this.formatter.unwrapRaw(join.table);
} else {
sql += join.joinType + ' join ' + this.formatter.wrap(table);
var ii = -1;
while (++ii < join.clauses.length) {
var clause = join.clauses[ii];
sql += ' ' + (ii > 0 ? clause[0] : clause[1]) + ' ';
sql += this.formatter.wrap(clause[2]);
if (!_.isUndefined(clause[3])) sql += ' ' + this.formatter.operator(clause[3]);
if (!_.isUndefined(clause[4])) sql += ' ' + this.formatter.wrap(clause[4]);
}
}
}
return sql;
},
// Compiles all `where` statements on the query.
where: function where() {
var wheres = this.grouped.where;
if (!wheres) return;
var i = -1,
sql = [];
while (++i < wheres.length) {
var stmt = wheres[i];
var val = this[stmt.type](stmt);
if (val) {
if (sql.length === 0) {
sql[0] = 'where';
} else {
sql.push(stmt.bool);
}
sql.push(val);
}
}
return sql.length > 1 ? sql.join(' ') : '';
},
group: function group() {
return this._groupsOrders('group');
},
order: function order() {
return this._groupsOrders('order');
},
// Compiles the `having` statements.
having: function having() {
var havings = this.grouped.having;
if (!havings) return '';
var sql = ['having'];
for (var i = 0, l = havings.length; i < l; i++) {
var str = '',
s = havings[i];
if (i !== 0) str = s.bool + ' ';
if (s.type === 'havingBasic') {
sql.push(str + this.formatter.columnize(s.column) + ' ' + this.formatter.operator(s.operator) + ' ' + this.formatter.parameter(s.value));
} else {
if (s.type === 'whereWrapped') {
var val = this.whereWrapped(s);
if (val) sql.push(val);
} else {
sql.push(str + this.formatter.unwrapRaw(s.value));
}
}
}
return sql.length > 1 ? sql.join(' ') : '';
},
// Compile the "union" queries attached to the main query.
union: function union() {
var onlyUnions = this.onlyUnions();
var unions = this.grouped.union;
if (!unions) return '';
var sql = '';
for (var i = 0, l = unions.length; i < l; i++) {
var union = unions[i];
if (i > 0) sql += ' ';
if (i > 0 || !onlyUnions) sql += union.clause + ' ';
var statement = this.formatter.rawOrFn(union.value);
if (statement) {
if (union.wrap) sql += '(';
sql += statement;
if (union.wrap) sql += ')';
}
}
return sql;
},
// If we haven't specified any columns or a `tableName`, we're assuming this
// is only being used for unions.
onlyUnions: function onlyUnions() {
return !this.grouped.columns && this.grouped.union && !this.tableName;
},
limit: function limit() {
var noLimit = !this.single.limit && this.single.limit !== 0;
if (noLimit) return '';
return 'limit ' + this.formatter.parameter(this.single.limit);
},
offset: function offset() {
if (!this.single.offset) return '';
return 'offset ' + this.formatter.parameter(this.single.offset);
},
// Compiles a `delete` query.
del: function del() {
// Make sure tableName is processed by the formatter first.
var tableName = this.tableName;
var wheres = this.where();
return 'delete from ' + tableName + (wheres ? ' ' + wheres : '');
},
// Compiles a `truncate` query.
truncate: function truncate() {
return 'truncate ' + this.tableName;
},
// Compiles the "locks".
lock: function lock() {
if (this.single.lock) {
if (!this.client.transacting) {
helpers.warn('You are attempting to perform a "lock" command outside of a transaction.');
} else {
return this[this.single.lock]();
}
}
},
// Compile the "counter".
counter: function counter() {
var counter = this.single.counter;
var toUpdate = {};
toUpdate[counter.column] = this.client.raw(this.formatter.wrap(counter.column) + ' ' + (counter.symbol || '+') + ' ' + counter.amount);
this.single.update = toUpdate;
return this.update();
},
// Where Clause
// ------
whereIn: function whereIn(statement) {
if (Array.isArray(statement.column)) return this.multiWhereIn(statement);
return this.formatter.wrap(statement.column) + ' ' + this._not(statement, 'in ') + this.wrap(this.formatter.parameterize(statement.value));
},
multiWhereIn: function multiWhereIn(statement) {
var i = -1,
sql = '(' + this.formatter.columnize(statement.column) + ') ';
sql += this._not(statement, 'in ') + '((';
while (++i < statement.value.length) {
if (i !== 0) sql += '),(';
sql += this.formatter.parameterize(statement.value[i]);
}
return sql + '))';
},
whereNull: function whereNull(statement) {
return this.formatter.wrap(statement.column) + ' is ' + this._not(statement, 'null');
},
// Compiles a basic "where" clause.
whereBasic: function whereBasic(statement) {
return this._not(statement, '') + this.formatter.wrap(statement.column) + ' ' + this.formatter.operator(statement.operator) + ' ' + this.formatter.parameter(statement.value);
},
whereExists: function whereExists(statement) {
return this._not(statement, 'exists') + ' (' + this.formatter.rawOrFn(statement.value) + ')';
},
whereWrapped: function whereWrapped(statement) {
var val = this.formatter.rawOrFn(statement.value, 'where');
return val && this._not(statement, '') + '(' + val.slice(6) + ')' || '';
},
whereBetween: function whereBetween(statement) {
return this.formatter.wrap(statement.column) + ' ' + this._not(statement, 'between') + ' ' + _.map(statement.value, this.formatter.parameter, this.formatter).join(' and ');
},
// Compiles a "whereRaw" query.
whereRaw: function whereRaw(statement) {
return this.formatter.unwrapRaw(statement.value);
},
wrap: function wrap(str) {
if (str.charAt(0) !== '(') return '(' + str + ')';
return str;
},
// Determines whether to add a "not" prefix to the where clause.
_not: function _not(statement, str) {
if (statement.not) return 'not ' + str;
return str;
},
_prepInsert: function _prepInsert(data) {
var isRaw = this.formatter.rawOrFn(data);
if (isRaw) return isRaw;
var columns = [];
var values = [];
if (!Array.isArray(data)) data = data ? [data] : [];
var i = -1;
while (++i < data.length) {
if (data[i] == null) break;
if (i === 0) columns = Object.keys(data[i]).sort();
var row = new Array(columns.length);
var keys = Object.keys(data[i]);
var j = -1;
while (++j < keys.length) {
var key = keys[j];
var idx = columns.indexOf(key);
if (idx === -1) {
columns = columns.concat(key).sort();
idx = columns.indexOf(key);
var k = -1;
while (++k < values.length) {
values[k].splice(idx, 0, undefined);
}
row.splice(idx, 0, undefined);
}
row[idx] = data[i][key];
}
values.push(row);
}
return {
columns: columns,
values: values
};
},
// "Preps" the update.
_prepUpdate: function _prepUpdate(data) {
data = _.omit(data, _.isUndefined);
var vals = [];
var sorted = Object.keys(data).sort();
var i = -1;
while (++i < sorted.length) {
vals.push(this.formatter.wrap(sorted[i]) + ' = ' + this.formatter.parameter(data[sorted[i]]));
}
return vals;
},
// Compiles the `order by` statements.
_groupsOrders: function _groupsOrders(type) {
var items = this.grouped[type];
if (!items) return '';
var formatter = this.formatter;
var sql = items.map(function (item) {
return (item.value instanceof Raw ? formatter.unwrapRaw(item.value) : formatter.columnize(item.value)) + (type === 'order' && item.type !== 'orderByRaw' ? ' ' + formatter.direction(item.direction) : '');
});
return sql.length ? type + ' by ' + sql.join(', ') : '';
}
});
QueryCompiler.prototype.first = QueryCompiler.prototype.select;
// Get the table name, wrapping it if necessary.
// Implemented as a property to prevent ordering issues as described in #704.
Object.defineProperty(QueryCompiler.prototype, 'tableName', {
get: function get() {
if (!this._tableName) {
// Only call this.formatter.wrap() the first time this property is accessed.
var tableName = this.single.table;
var schemaName = this.single.schema;
if (tableName && schemaName) tableName = schemaName + '.' + tableName;
this._tableName = tableName ? this.formatter.wrap(tableName) : '';
}
return this._tableName;
}
});
module.exports = QueryCompiler;