| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423 |
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
1
| /**
* @class DBSelect
* @author Dr. Benton - github.com/DrBenton
* @see https://github.com/DrBenton/Node-DBI
*/
// ------------------------------------- modules
var _ = require('lodash')
, DBExpr = require('./dbExpr').DBExpr;
// ------------------------------------- constructor
/**
* @param {DBAdapterAbstract} adapter
*/
function DBSelect(adapter) {
/**
* DBAdapterAbstract
*/
this._adapter = adapter;
this._what = [];
this._from = [];
this._join = [];
this._where = [];
this._group = null;
this._order = [];
this._limit = [];
this._distinct = false;
}
module.exports.DBSelect = DBSelect;
//------------------------------------- public methods
/**
* Adds a FROM clause and associated fields to fetch.
*
* @param {String|Array} The table name
* @param {String|Array} The fields to select (if null, '*' will be used)
* @returns {DBSelect}
*/
DBSelect.prototype.from = function (tableName, fieldsArray) {
if (!tableName)
throw new Error('Table name is mandatory !');
fieldsArray = fieldsArray || '*';
if (!_.isArray(fieldsArray))
fieldsArray = [ fieldsArray ];
var escapedTableName = this._adapter.escapeTable(tableName);
this._from.push(escapedTableName);
for (var i = 0, j = fieldsArray.length; i < j; i++) {
var currentField = fieldsArray[i];
if (typeof(currentField) == 'object' && (currentField instanceof DBExpr))
this._what.push(currentField.getStr());//this is a SQL function, like COUNT(), CONCAT(), etc : no table prefix and no escaping
else if ('*' == currentField)
this._what.push(escapedTableName + '.' + currentField);//this is a the wildcard : table prefix, but no escaping
else {
//others : table prefix + escaping
this._what.push(escapedTableName + '.' + this._adapter.escapeField(currentField));
}
}
return this;
};
/**
* Adds a WHERE clause.
*
* @param {String} whereStr
* @param {String|Number|Array|null} value
* @returns {DBSelect}
*/
DBSelect.prototype.where = function (whereStr, value, clauseType) {
var pushCount = 1;
if (!clauseType) {
clauseType = 'AND';
}
if ((clauseType == 'OR' || clauseType == 'AND') && !whereStr) {
throw new Error('WHERE String is mandatory !');
}
if ((clauseType == 'OR' || clauseType == 'AND') && whereStr) {
if (_.isArray(value))
value = '(' + value.map((function (v) {
return this._adapter.escape(v);
}).bind(this)).join(', ') + ')';
else
value = this._adapter.escape(value);
whereStr = whereStr.replace(/\?/g, value);
}
if ((clauseType == '(' || clauseType == ')') && (typeof value == 'number')) {
pushCount = value;
}
for (var i = 0; i < pushCount; i++) {
this._where.push({ clauseType: clauseType, string: whereStr });
}
return this;
};
/**
* Adds a WHERE clause with an OR instead of AND.
*
* @param {String} whereStr
* @param {String|Number|Array|null} value
* @returns {DBSelect}
*/
DBSelect.prototype.orWhere = function (whereStr, value) {
return this.where(whereStr, value, 'OR');
};
/**
* Adds a WHERE clause grouping start
*
* @param {Number} groupsToOpen
* @returns {DBSelect}
*/
DBSelect.prototype.whereGroup = function (groupsToOpen) {
return this.whereGroupHandler(groupsToOpen, '(');
};
/**
* Adds a WHERE clause grouping end
*
* @param {Number} groupsToClose
* @returns {DBSelect}
*/
DBSelect.prototype.whereGroupClose = function (groupsToClose) {
return this.whereGroupHandler(groupsToClose, ')');
};
/**
* Adds WHERE grouping clauses
*
* @param {Number} groups
* @param {String} groupType
* @returns {DBSelect}
*/
DBSelect.prototype.whereGroupHandler = function (groups, groupType) {
if (typeof groups === 'undefined') {
groups = 1;
}
return this.where(null, groups, groupType);
};
/**
* Adds a LIMIT clause.
*
* @param {Integer} nbResults
* @param {Integer} startIndex
* @returns {DBSelect}
*/
DBSelect.prototype.limit = function (nbResults, startIndex) {
if (isNaN(nbResults))
throw new Error('Incorrect LIMIT "' + nbResults + '" !');
if (startIndex)
this._limit = [ startIndex, nbResults ];
else
this._limit = [ nbResults ];
return this;
};
/**
* Adds a ORDER BY clause.
*
* @param {String} fieldName
* @param {ASC|DESC} direction
* @returns {DBSelect}
*/
DBSelect.prototype.order = function (fieldName, direction) {
if (!direction)
direction = 'ASC';
else if (direction.toUpperCase() != 'ASC' && direction.toUpperCase() != 'DESC')
throw new Error('Incorrect direction "' + direction + '" ! (should be ASC or DESC)');
this._order.push(this._adapter.escapeField(fieldName) + ' ' + direction);
return this;
};
/**
* Adds a JOIN clause and associated fields to fetch.
*
* @param {String|Array} The joined table name
* @param {String} The join clause
* @param {String|Array} The fields to select on the joined table (if null, '*' will be used)
* @param {String} The join type (INNER, LEFT or RIGHT) - INNER if omitted
* @returns {DBSelect}
*/
DBSelect.prototype.join = function (tableName, joinStr, fieldsArray, joinType) {
if (!tableName)
throw new Error('Table name is mandatory !');
else if (!joinStr)
throw new Error('Join clause is mandatory !');
fieldsArray = fieldsArray || '*';
joinType = joinType || 'INNER';
if (!_.isArray(fieldsArray))
fieldsArray = [ fieldsArray ];
this._join.push(joinType + ' JOIN ' + this._adapter.escapeTable(tableName) + ' ON ' + joinStr);
for (var i = 0, j = fieldsArray.length; i < j; i++) {
var currentField = fieldsArray[i];
if (typeof(currentField) == 'object' && (currentField instanceof DBExpr))
this._what.push(currentField.getStr());//this is a SQL function, like COUNT(), CONCAT(), etc : no table prefix and no escaping
else if ('*' == currentField)
this._what.push(this._adapter.escapeTable(tableName) + '.' + currentField);//this is a the wildcard : table prefix, but no escaping
else
this._what.push(this._adapter.escapeTable(tableName) + '.' + this._adapter.escapeField(currentField));//others : table prefix + escaping
}
return this;
};
/**
* Adds a DISTINCT() on the SQL fields query.
*
* @returns {DBSelect}
*/
DBSelect.prototype.distinct = function () {
this._distinct = true;
return this;
};
/**
* Adds a "GROUP BY" clause.
*
* @returns {DBSelect}
*/
DBSelect.prototype.groupBy = function (fieldName) {
this._group = fieldName;
return this;
};
/**
* Converts this object to an SQL SELECT string.
*
* @returns String
*/
DBSelect.prototype.assemble = DBSelect.prototype.toString = function () {
var completeQuery = (this._what.length > 0) ? true : false;
var sql = ( completeQuery ) ? 'SELECT ' : '';
// Requested fields : this._what
if (completeQuery) {
if (this._distinct)
sql += 'DISTINCT(' + this._what.join(', ') + ') ';
else
sql += this._what.join(', ');
}
// "FROM" clause : this._from
if (this._from.length > 0) {
this._from = _.unique(this._from);
sql += ' FROM ' + this._from.join(', ');
}
// "JOIN" clause : this._join
if (this._join.length > 0) {
this._join = _.unique(this._join);
sql += ' ' + this._join.join(' ');
}
// "WHERE" clause : this._where
if (this._where.length > 0) {
this._where = _.unique(this._where);
sql += ( (completeQuery) ? ' WHERE ' : '' );
var firstValue = true;
var openGroups = 0;
var whereClause = null;
var whereString = null;
var clauseType = null;
var startGroups = 0;
for (var i = 0; i < this._where.length; i++) {
whereClause = this._where[i];
clauseType = whereClause.clauseType;
whereString = whereClause.string;
switch (clauseType) {
case '(':
startGroups++;
openGroups++;
break;
case ')':
if (openGroups > 0) {
sql += ')';
openGroups--;
}
break;
case 'AND':
case 'OR':
if (!firstValue) {
sql += ' ' + (clauseType == 'OR' ? 'OR' : 'AND') + ' ';
} else {
firstValue = false;
}
for (var j = 0; j < startGroups; j++) {
sql += '(';
}
startGroups = 0;
sql += '(' + whereString + ')';
}
}
for (var k = 0; k < openGroups; k++) {
sql += ')';
}
}
// "GROUP BY" clause : this._group
if (this._group && this._group.length > 0)
sql += ' GROUP BY ' + this._group;
//"ORDER BY" clause : this._order
if (this._order.length > 0)
sql += ' ORDER BY ' + this._order.join(', ');
// "LIMIT" clause : this._limit
if (this._limit.length > 0)
sql += ' LIMIT ' + this._limit.join(', ');
return sql;
};
/**
* Executes a "DBWrapper.fetchAll()" over this DBSelect.
* @see DBWrapper
* @param {Function} callback
*/
DBSelect.prototype.fetchAll = function (callback) {
this._adapter.getDBWrapper().fetchAll(this, [], callback);
};
/**
* Executes a "DBWrapper.fetchRow()" over this DBSelect.
* @see DBWrapper
* @param {Function} callback
*/
DBSelect.prototype.fetchRow = function (callback) {
this._adapter.getDBWrapper().fetchRow(this, null, callback);
};
/**
* Executes a "DBWrapper.fetchCol()" over this DBSelect.
* @see DBWrapper
* @param {Function} callback
*/
DBSelect.prototype.fetchCol = function (callback) {
this._adapter.getDBWrapper().fetchCol(this, null, callback);
};
/**
* Executes a "DBWrapper.fetchOne()" over this DBSelect.
* @see DBWrapper
* @param {Function} callback
*/
DBSelect.prototype.fetchOne = function (callback) {
this._adapter.getDBWrapper().fetchOne(this, null, callback);
};
//------------------------------------- private methods
// vim: ts=2 sw=2 et
|