/
client.js
354 lines (289 loc) · 9.26 KB
/
client.js
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
import Promise from 'bluebird';
import * as helpers from './helpers';
import Raw from './raw';
import Runner from './runner';
import Formatter from './formatter';
import Transaction from './transaction';
import QueryBuilder from './query/builder';
import QueryCompiler from './query/compiler';
import SchemaBuilder from './schema/builder';
import SchemaCompiler from './schema/compiler';
import TableBuilder from './schema/tablebuilder';
import TableCompiler from './schema/tablecompiler';
import ColumnBuilder from './schema/columnbuilder';
import ColumnCompiler from './schema/columncompiler';
import { Pool, TimeoutError } from 'tarn';
import inherits from 'inherits';
import { EventEmitter } from 'events';
import { makeEscape } from './query/string'
import { assign, uniqueId, cloneDeep, defaults } from 'lodash'
const debug = require('debug')('knex:client')
const debugQuery = require('debug')('knex:query')
const debugBindings = require('debug')('knex:bindings')
// The base client provides the general structure
// for a dialect specific client object.
function Client(config = {}) {
this.config = config
//Client is a required field, so throw error if it's not supplied.
//If 'this.dialect' is set, then this is a 'super()' call, in which case
//'client' does not have to be set as it's already assigned on the client prototype.
if(!this.config.client && !this.dialect) {
throw new Error(`knex: Required configuration option 'client' is missing.`)
}
this.connectionSettings = cloneDeep(config.connection || {})
if (this.driverName && config.connection) {
this.initializeDriver()
if (!config.pool || (config.pool && config.pool.max !== 0)) {
this.initializePool(config)
}
}
this.valueForUndefined = this.raw('DEFAULT');
if (config.useNullAsDefault) {
this.valueForUndefined = null
}
}
inherits(Client, EventEmitter)
assign(Client.prototype, {
formatter(builder) {
return new Formatter(this, builder)
},
queryBuilder() {
return new QueryBuilder(this)
},
queryCompiler(builder) {
return new QueryCompiler(this, builder)
},
schemaBuilder() {
return new SchemaBuilder(this)
},
schemaCompiler(builder) {
return new SchemaCompiler(this, builder)
},
tableBuilder(type, tableName, fn) {
return new TableBuilder(this, type, tableName, fn)
},
tableCompiler(tableBuilder) {
return new TableCompiler(this, tableBuilder)
},
columnBuilder(tableBuilder, type, args) {
return new ColumnBuilder(this, tableBuilder, type, args)
},
columnCompiler(tableBuilder, columnBuilder) {
return new ColumnCompiler(this, tableBuilder, columnBuilder)
},
runner(builder) {
return new Runner(this, builder)
},
transaction(container, config, outerTx) {
return new Transaction(this, container, config, outerTx)
},
raw() {
return new Raw(this).set(...arguments)
},
_formatQuery(sql, bindings, timeZone) {
bindings = bindings == null ? [] : [].concat(bindings);
let index = 0;
return sql.replace(/\\?\?/g, (match) => {
if (match === '\\?') {
return '?'
}
if (index === bindings.length) {
return match
}
const value = bindings[index++];
return this._escapeBinding(value, {timeZone})
})
},
_escapeBinding: makeEscape({
escapeString(str) {
return `'${str.replace(/'/g, "''")}'`
}
}),
query(connection, obj) {
if (typeof obj === 'string') obj = {sql: obj}
obj.sql = this.positionBindings(obj.sql);
obj.bindings = this.prepBindings(obj.bindings)
debugQuery(obj.sql)
this.emit('query', assign({__knexUid: connection.__knexUid}, obj))
debugBindings(obj.bindings)
return this._query(connection, obj).catch((err) => {
err.message = this._formatQuery(obj.sql, obj.bindings) + ' - ' + err.message
this.emit('query-error', err, assign({__knexUid: connection.__knexUid}, obj))
throw err
})
},
stream(connection, obj, stream, options) {
if (typeof obj === 'string') obj = {sql: obj}
obj.sql = this.positionBindings(obj.sql);
obj.bindings = this.prepBindings(obj.bindings)
this.emit('query', assign({__knexUid: connection.__knexUid}, obj))
debugQuery(obj.sql)
debugBindings(obj.bindings)
return this._stream(connection, obj, stream, options)
},
prepBindings(bindings) {
return bindings;
},
positionBindings(sql) {
return sql;
},
postProcessResponse(resp, queryContext) {
if (this.config.postProcessResponse) {
return this.config.postProcessResponse(resp, queryContext);
}
return resp;
},
wrapIdentifier(value, queryContext) {
return this.customWrapIdentifier(value, this.wrapIdentifierImpl, queryContext);
},
customWrapIdentifier(value, origImpl, queryContext) {
if (this.config.wrapIdentifier) {
return this.config.wrapIdentifier(value, origImpl, queryContext);
}
return origImpl(value);
},
wrapIdentifierImpl(value) {
return (value !== '*' ? `"${value.replace(/"/g, '""')}"` : '*')
},
initializeDriver() {
try {
this.driver = this._driver()
} catch (e) {
helpers.exit(`Knex: run\n$ npm install ${this.driverName} --save\n${e.stack}`)
}
},
poolDefaults() {
return {min: 2, max: 10, propagateCreateError: true}
},
getPoolSettings(poolConfig) {
poolConfig = defaults({}, poolConfig, this.poolDefaults());
[
'maxWaitingClients',
'testOnBorrow',
'fifo',
'priorityRange',
'autostart',
'evictionRunIntervalMillis',
'numTestsPerRun',
'softIdleTimeoutMillis',
'Promise'
].forEach(option => {
if (option in poolConfig) {
helpers.warn([
`Pool config option "${option}" is no longer supported.`,
`See https://github.com/Vincit/tarn.js for possible pool config options.`
].join(' '))
}
})
const timeouts = [
this.config.acquireConnectionTimeout || 60000,
poolConfig.acquireTimeoutMillis
].filter(timeout => timeout !== undefined);
// acquire connection timeout can be set on config or config.pool
// choose the smallest, positive timeout setting and set on poolConfig
poolConfig.acquireTimeoutMillis = Math.min(...timeouts);
return Object.assign(poolConfig, {
create: () => {
return this.acquireRawConnection().tap(connection => {
connection.__knexUid = uniqueId('__knexUid')
if (poolConfig.afterCreate) {
return Promise.promisify(poolConfig.afterCreate)(connection)
}
});
},
destroy: (connection) => {
if (poolConfig.beforeDestroy) {
helpers.warn(`
beforeDestroy is deprecated, please open an issue if you use this
to discuss alternative apis
`)
poolConfig.beforeDestroy(connection, function() {})
}
if (connection !== void 0) {
return this.destroyRawConnection(connection)
}
},
validate: (connection) => {
if (connection.__knex__disposed) {
helpers.warn(`Connection Error: ${connection.__knex__disposed}`)
return false
}
return this.validateConnection(connection)
}
})
},
initializePool(config) {
if (this.pool) {
helpers.warn('The pool has already been initialized')
return
}
this.pool = new Pool(this.getPoolSettings(config.pool))
},
validateConnection(connection) {
return true
},
// Acquire a connection from the pool.
acquireConnection() {
if (!this.pool) {
return Promise.reject(new Error('Unable to acquire a connection'))
}
return Promise
.try(() => this.pool.acquire().promise)
.tap(connection => {
debug('acquired connection from pool: %s', connection.__knexUid)
})
.catch(TimeoutError, () => {
throw new Promise.TimeoutError(
'Knex: Timeout acquiring a connection. The pool is probably full. ' +
'Are you missing a .transacting(trx) call?'
)
});
},
// Releases a connection back to the connection pool,
// returning a promise resolved when the connection is released.
releaseConnection(connection) {
debug('releasing connection to pool: %s', connection.__knexUid)
const didRelease = this.pool.release(connection)
if (!didRelease) {
debug('pool refused connection: %s', connection.__knexUid)
}
return Promise.resolve()
},
// Destroy the current connection pool for the client.
destroy(callback) {
let promise = null
if (this.pool) {
promise = this.pool.destroy()
} else {
promise = Promise.resolve()
}
return promise.then(() => {
this.pool = void 0
if (typeof callback === 'function') {
callback()
}
}).catch(err => {
if (typeof callback === 'function') {
callback(err)
}
return Promise.reject(err)
})
},
// Return the database being used by this client.
database() {
return this.connectionSettings.database
},
toString() {
return '[object KnexClient]'
},
canCancelQuery: false,
assertCanCancelQuery() {
if (!this.canCancelQuery) {
throw new Error("Query cancelling not supported for this dialect");
}
},
cancelQuery() {
throw new Error("Query cancelling not supported for this dialect")
}
})
export default Client