/
client.js
265 lines (216 loc) · 7.57 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
'use strict';
var _ = require('lodash');
var Promise = require('./promise');
var helpers = require('./helpers');
var Raw = require('./raw');
var Runner = require('./runner');
var Formatter = require('./formatter');
var Transaction = require('./transaction');
var QueryBuilder = require('./query/builder');
var QueryCompiler = require('./query/compiler');
var SchemaBuilder = require('./schema/builder');
var SchemaCompiler = require('./schema/compiler');
var TableBuilder = require('./schema/tablebuilder');
var TableCompiler = require('./schema/tablecompiler');
var ColumnBuilder = require('./schema/columnbuilder');
var ColumnCompiler = require('./schema/columncompiler');
var Pool2 = require('pool2');
var inherits = require('inherits');
var EventEmitter = require('events').EventEmitter;
var SqlString = require('./query/string');
var assign = require('lodash/object/assign');
var uniqueId = require('lodash/utility/uniqueId');
var cloneDeep = require('lodash/lang/cloneDeep');
var debug = require('debug')('knex:client');
var debugQuery = require('debug')('knex:query');
// The base client provides the general structure
// for a dialect specific client object.
function Client() {
var config = arguments.length <= 0 || arguments[0] === undefined ? {} : arguments[0];
this.config = config;
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: Formatter,
formatter: function formatter() {
return new this.Formatter(this);
},
QueryBuilder: QueryBuilder,
queryBuilder: function queryBuilder() {
return new this.QueryBuilder(this);
},
QueryCompiler: QueryCompiler,
queryCompiler: function queryCompiler(builder) {
return new this.QueryCompiler(this, builder);
},
SchemaBuilder: SchemaBuilder,
schemaBuilder: function schemaBuilder() {
return new this.SchemaBuilder(this);
},
SchemaCompiler: SchemaCompiler,
schemaCompiler: function schemaCompiler(builder) {
return new this.SchemaCompiler(this, builder);
},
TableBuilder: TableBuilder,
tableBuilder: function tableBuilder(type, tableName, fn) {
return new this.TableBuilder(this, type, tableName, fn);
},
TableCompiler: TableCompiler,
tableCompiler: function tableCompiler(tableBuilder) {
return new this.TableCompiler(this, tableBuilder);
},
ColumnBuilder: ColumnBuilder,
columnBuilder: function columnBuilder(tableBuilder, type, args) {
return new this.ColumnBuilder(this, tableBuilder, type, args);
},
ColumnCompiler: ColumnCompiler,
columnCompiler: function columnCompiler(tableBuilder, columnBuilder) {
return new this.ColumnCompiler(this, tableBuilder, columnBuilder);
},
Runner: Runner,
runner: function runner(connection) {
return new this.Runner(this, connection);
},
SqlString: SqlString,
Transaction: Transaction,
transaction: function transaction(container, config, outerTx) {
return new this.Transaction(this, container, config, outerTx);
},
Raw: Raw,
raw: function raw() {
var raw = new this.Raw(this);
return raw.set.apply(raw, arguments);
},
query: function query(connection, obj) {
if (typeof obj === 'string') obj = { sql: obj };
this.emit('query', assign({ __knexUid: connection.__knexUid }, obj));
debugQuery(obj.sql);
return this._query.call(this, connection, obj)['catch'](function (err) {
err.message = SqlString.format(obj.sql, obj.bindings) + ' - ' + err.message;
throw err;
});
},
stream: function stream(connection, obj, _stream, options) {
if (typeof obj === 'string') obj = { sql: obj };
this.emit('query', assign({ __knexUid: connection.__knexUid }, obj));
debugQuery(obj.sql);
return this._stream.call(this, connection, obj, _stream, options);
},
prepBindings: function prepBindings(bindings) {
return _.map(bindings, function (binding) {
return binding === undefined ? this.valueForUndefined : binding;
}, this);
},
wrapIdentifier: function wrapIdentifier(value) {
return value !== '*' ? '"' + value.replace(/"/g, '""') + '"' : '*';
},
initializeDriver: function initializeDriver() {
try {
this.driver = this._driver();
} catch (e) {
helpers.exit('Knex: run\n$ npm install ' + this.driverName + ' --save' + '\n' + e.stack);
}
},
Pool: Pool2,
initializePool: function initializePool(config) {
if (this.pool) this.destroy();
this.pool = new this.Pool(assign(this.poolDefaults(config.pool || {}), config.pool));
this.pool.on('error', function (err) {
helpers.error('Pool2 - ' + err);
});
this.pool.on('warn', function (msg) {
helpers.warn('Pool2 - ' + msg);
});
},
poolDefaults: function poolDefaults(poolConfig) {
var dispose,
client = this;
if (poolConfig.destroy) {
helpers.deprecate('config.pool.destroy', 'config.pool.dispose');
dispose = poolConfig.destroy;
}
return {
min: 2,
max: 10,
acquire: function acquire(callback) {
client.acquireRawConnection().tap(function (connection) {
connection.__knexUid = uniqueId('__knexUid');
if (poolConfig.afterCreate) {
return Promise.promisify(poolConfig.afterCreate)(connection);
}
}).nodeify(callback);
},
dispose: function dispose(connection, callback) {
if (poolConfig.beforeDestroy) {
poolConfig.beforeDestroy(connection, function () {
if (connection !== undefined) {
client.destroyRawConnection(connection, callback);
}
});
} else if (connection !== void 0) {
client.destroyRawConnection(connection, callback);
}
}
};
},
// Acquire a connection from the pool.
acquireConnection: function acquireConnection() {
var client = this;
return new Promise(function (resolver, rejecter) {
if (!client.pool) {
return rejecter(new Error('There is no pool defined on the current client'));
}
client.pool.acquire(function (err, connection) {
if (err) return rejecter(err);
debug('acquiring connection from pool: %s', connection.__knexUid);
resolver(connection);
});
});
},
// Releases a connection back to the connection pool,
// returning a promise resolved when the connection is released.
releaseConnection: function releaseConnection(connection) {
var pool = this.pool;
return new Promise(function (resolver) {
debug('releasing connection to pool: %s', connection.__knexUid);
pool.release(connection);
resolver();
});
},
// Destroy the current connection pool for the client.
destroy: function destroy(callback) {
var client = this;
var promise = new Promise(function (resolver) {
if (!client.pool) return resolver();
client.pool.end(function () {
client.pool = undefined;
resolver();
});
});
// Allow either a callback or promise interface for destruction.
if (typeof callback === 'function') {
promise.nodeify(callback);
} else {
return promise;
}
},
// Return the database being used by this client.
database: function database() {
return this.connectionSettings.database;
},
toString: function toString() {
return '[object KnexClient]';
}
});
module.exports = Client;