forked from mongodb/node-mongodb-native
-
Notifications
You must be signed in to change notification settings - Fork 49
/
db.js
1792 lines (1631 loc) · 64.6 KB
/
db.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
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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Module dependencies.
* @ignore
*/
var QueryCommand = require('./commands/query_command').QueryCommand,
DbCommand = require('./commands/db_command').DbCommand,
MongoReply = require('./responses/mongo_reply').MongoReply,
Admin = require('./admin').Admin,
Collection = require('./collection').Collection,
Server = require('./connection/server').Server,
ReplSet = require('./connection/repl_set').ReplSet,
Cursor = require('./cursor').Cursor,
EventEmitter = require('events').EventEmitter,
inherits = require('util').inherits,
crypto = require('crypto');
/**
* Internal class for callback storage
* @ignore
*/
var CallbackStore = function() {
// Make class an event emitter
EventEmitter.call(this);
// Add a info about call variable
this._notReplied = {};
}
/**
* @ignore
*/
inherits(CallbackStore, EventEmitter);
/**
* Create a new Db instance.
*
* Options
* - **strict** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, execute insert with a getLastError command returning the result of the insert command.
* - **native_parser** {Boolean, default:false}, use c++ bson parser.
* - **forceServerObjectId** {Boolean, default:false}, force server to create _id fields instead of client.
* - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation.
* - **slaveOk** {Boolean, default:false}, allow reads from secondaries.
* - **serializeFunctions** {Boolean, default:false}, serialize functions.
* - **raw** {Boolean, default:false}, peform operations using raw bson buffers.
* - **recordQueryStats** {Boolean, default:false}, record query statistics during execution.
* - **reaper** {Boolean, default:false}, enables the reaper, timing out calls that never return.
* - **reaperInterval** {Number, default:10000}, number of miliseconds between reaper wakups.
* - **reaperTimeout** {Number, default:30000}, the amount of time before a callback times out.
* - **retryMiliSeconds** {Number, default:5000}, number of miliseconds between retries.
* - **numberOfRetries** {Number, default:5}, number of retries off connection.
*
* @class Represents a Collection
* @param {String} databaseName name of the database.
* @param {Object} serverConfig server config object.
* @param {Object} [options] additional options for the collection.
*/
function Db(databaseName, serverConfig, options) {
if(!(this instanceof Db)) return new Db(databaseName, serverConfig, options);
EventEmitter.call(this);
this.databaseName = databaseName;
this.serverConfig = serverConfig;
this.options = options == null ? {} : options;
// State to check against if the user force closed db
this._applicationClosed = false;
// Fetch the override flag if any
var overrideUsedFlag = this.options['override_used_flag'] == null ? false : this.options['override_used_flag'];
// Verify that nobody is using this config
if(!overrideUsedFlag && typeof this.serverConfig == 'object' && this.serverConfig._isUsed()) {
throw new Error("A Server or ReplSet instance cannot be shared across multiple Db instances");
} else if(!overrideUsedFlag && typeof this.serverConfig == 'object'){
// Set being used
this.serverConfig._used = true;
}
// Ensure we have a valid db name
validateDatabaseName(databaseName);
// Contains all the connections for the db
try {
this.native_parser = this.options.native_parser;
// The bson lib
var bsonLib = this.bsonLib = this.options.native_parser ? require('bson').BSONNative : new require('bson').BSONPure;
// Fetch the serializer object
var BSON = bsonLib.BSON;
// Create a new instance
this.bson = new BSON([bsonLib.Long, bsonLib.ObjectID, bsonLib.Binary, bsonLib.Code, bsonLib.DBRef, bsonLib.Symbol, bsonLib.Double, bsonLib.Timestamp, bsonLib.MaxKey, bsonLib.MinKey]);
// Backward compatibility to access types
this.bson_deserializer = bsonLib;
this.bson_serializer = bsonLib;
} catch (err) {
// If we tried to instantiate the native driver
var msg = "Native bson parser not compiled, please compile "
+ "or avoid using native_parser=true";
throw Error(err);
}
// Internal state of the server
this._state = 'disconnected';
this.pkFactory = this.options.pk == null ? bsonLib.ObjectID : this.options.pk;
this.forceServerObjectId = this.options.forceServerObjectId != null ? this.options.forceServerObjectId : false;
// Added strict
this.strict = this.options.strict == null ? false : this.options.strict;
this.notReplied ={};
this.isInitializing = true;
this.auths = [];
this.openCalled = false;
// Command queue, keeps a list of incoming commands that need to be executed once the connection is up
this.commands = [];
// Contains all the callbacks
this._callBackStore = new CallbackStore();
// Set up logger
this.logger = this.options.logger != null
&& (typeof this.options.logger.debug == 'function')
&& (typeof this.options.logger.error == 'function')
&& (typeof this.options.logger.log == 'function')
? this.options.logger : {error:function(message, object) {}, log:function(message, object) {}, debug:function(message, object) {}};
// Allow slaveOk
this.slaveOk = this.options["slave_ok"] == null ? false : this.options["slave_ok"];
var self = this;
// Associate the logger with the server config
this.serverConfig.logger = this.logger;
this.tag = new Date().getTime();
// Just keeps list of events we allow
this.eventHandlers = {error:[], parseError:[], poolReady:[], message:[], close:[]};
// Controls serialization options
this.serializeFunctions = this.options.serializeFunctions != null ? this.options.serializeFunctions : false;
// Raw mode
this.raw = this.options.raw != null ? this.options.raw : false;
// Record query stats
this.recordQueryStats = this.options.recordQueryStats != null ? this.options.recordQueryStats : false;
// If we have server stats let's make sure the driver objects have it enabled
if(this.recordQueryStats == true) {
this.serverConfig.enableRecordQueryStats(true);
}
// Reaper enable setting
this.reaperEnabled = this.options.reaper != null ? this.options.reaper : false;
this._lastReaperTimestamp = new Date().getTime();
// Retry information
this.retryMiliSeconds = this.options.retryMiliSeconds != null ? this.options.retryMiliSeconds : 5000;
this.numberOfRetries = this.options.numberOfRetries != null ? this.options.numberOfRetries : 5;
// Reaper information
this.reaperInterval = this.options.reaperInterval != null ? this.options.reaperInterval : 10000;
this.reaperTimeout = this.options.reaperTimeout != null ? this.options.reaperTimeout : 30000;
// get self
var self = this;
// State of the db connection
Object.defineProperty(this, "state", { enumerable: true
, get: function () {
return this.serverConfig._serverState;
}
});
};
/**
* The reaper cleans up any callbacks that have not returned inside the space set by
* the parameter reaperTimeout, it will only attempt to reap if the time since last reap
* is bigger or equal to the reaperInterval value
* @ignore
*/
var reaper = function(dbInstance, reaperInterval, reaperTimeout) {
// Get current time, compare to reaper interval
var currentTime = new Date().getTime();
// Now calculate current time difference to check if it's time to reap
if((currentTime - dbInstance._lastReaperTimestamp) >= reaperInterval) {
// Save current timestamp for next reaper iteration
dbInstance._lastReaperTimestamp = currentTime;
// Get all non-replied to messages
var keys = Object.keys(dbInstance._callBackStore._notReplied);
// Iterate over all callbacks
for(var i = 0; i < keys.length; i++) {
// Fetch the current key
var key = keys[i];
// Get info element
var info = dbInstance._callBackStore._notReplied[key];
// If it's timed out let's remove the callback and return an error
if((currentTime - info.start) > reaperTimeout) {
// Cleanup
delete dbInstance._callBackStore._notReplied[key];
// Perform callback in next Tick
process.nextTick(function() {
dbInstance._callBackStore.emit(key, new Error("operation timed out"), null);
});
}
}
// Return reaping was done
return true;
} else {
// No reaping done
return false;
}
}
/**
* @ignore
*/
function validateDatabaseName(databaseName) {
if(typeof databaseName !== 'string') throw new Error("database name must be a string");
if(databaseName.length === 0) throw new Error("database name cannot be the empty string");
var invalidChars = [" ", ".", "$", "/", "\\"];
for(var i = 0; i < invalidChars.length; i++) {
if(databaseName.indexOf(invalidChars[i]) != -1) throw new Error("database names cannot contain the character '" + invalidChars[i] + "'");
}
}
/**
* @ignore
*/
inherits(Db, EventEmitter);
/**
* Initialize the database connection.
*
* @param {Function} callback returns index information.
* @return {null}
* @api public
*/
Db.prototype.open = function(callback) {
var self = this;
// Check that the user has not called this twice
if(this.openCalled) {
// Close db
this.close();
// Throw error
throw new Error("db object already connecting, open cannot be called multiple times");
}
// Set that db has been opened
this.openCalled = true;
// Set the status of the server
self._state = 'connecting';
// Set up connections
if(self.serverConfig instanceof Server || self.serverConfig instanceof ReplSet) {
self.serverConfig.connect(self, {firstCall: true}, function(err, result) {
if(err != null) {
// Return error from connection
return callback(err, null);
}
// Set the status of the server
self._state = 'connected';
// Callback
return callback(null, self);
});
} else {
return callback(Error("Server parameter must be of type Server or ReplSet"), null);
}
};
/**
* Create a new Db instance sharing the current socket connections.
*
* @param {String} dbName the name of the database we want to use.
* @return {Db} a db instance using the new database.
* @api public
*/
Db.prototype.db = function(dbName) {
// Copy the options and add out internal override of the not shared flag
var options = {};
for(var key in this.options) {
options[key] = this.options[key];
}
// Add override flag
options['override_used_flag'] = true;
// Create a new db instance
var newDbInstance = new Db(dbName, this.serverConfig, options);
// Add the instance to the list of approved db instances
var allServerInstances = this.serverConfig.allServerInstances();
// Add ourselves to all server callback instances
for(var i = 0; i < allServerInstances.length; i++) {
var server = allServerInstances[i];
server.dbInstances.push(newDbInstance);
}
// Return new db object
return newDbInstance;
}
/**
* Close the current db connection, including all the child db instances. Emits close event if no callback is provided.
*
* @param {Boolean} [forceClose] connection can never be reused.
* @param {Function} [callback] returns the results.
* @return {null}
* @api public
*/
Db.prototype.close = function(forceClose, callback) {
// Unpack calls
var args = Array.prototype.slice.call(arguments, 0);
callback = args.pop();
// Ensure we force close all connections
this._applicationClosed = args.length ? args.shift() : false;
// Remove all listeners and close the connection
this.serverConfig.close(callback);
// Emit the close event
if(typeof callback !== 'function') this.emit("close");
// Emit close event across all db instances sharing the sockets
var allServerInstances = this.serverConfig.allServerInstances();
// Fetch the first server instance
if(Array.isArray(allServerInstances) && allServerInstances.length > 0) {
var server = allServerInstances[0];
// For all db instances signal all db instances
if(Array.isArray(server.dbInstances) && server.dbInstances.length > 1) {
for(var i = 0; i < server.dbInstances.length; i++) {
var dbInstance = server.dbInstances[i];
// Check if it's our current db instance and skip if it is
if(dbInstance.databaseName !== this.databaseName && dbInstance.tag !== this.tag) {
server.dbInstances[i].emit("close");
}
}
}
}
// Remove all listeners
this.removeAllEventListeners();
// You can reuse the db as everything is shut down
this.openCalled = false;
};
/**
* Access the Admin database
*
* @param {Function} [callback] returns the results.
* @return {Admin} the admin db object.
* @api public
*/
Db.prototype.admin = function(callback) {
if(callback == null) return new Admin(this);
callback(null, new Admin(this));
};
/**
* Returns a cursor to all the collection information.
*
* @param {String} [collectionName] the collection name we wish to retrieve the information from.
* @param {Function} callback returns option results.
* @return {null}
* @api public
*/
Db.prototype.collectionsInfo = function(collectionName, callback) {
if(callback == null && typeof collectionName == 'function') { callback = collectionName; collectionName = null; }
// Create selector
var selector = {};
// If we are limiting the access to a specific collection name
if(collectionName != null) selector.name = this.databaseName + "." + collectionName;
// Return Cursor
// callback for backward compatibility
if(callback) {
callback(null, new Cursor(this, new Collection(this, DbCommand.SYSTEM_NAMESPACE_COLLECTION), selector));
} else {
return new Cursor(this, new Collection(this, DbCommand.SYSTEM_NAMESPACE_COLLECTION), selector);
}
};
/**
* Get the list of all collection names for the specified db
*
* @param {String} [collectionName] the collection name we wish to filter by.
* @param {Function} callback returns option results.
* @return {null}
* @api public
*/
Db.prototype.collectionNames = function(collectionName, callback) {
if(callback == null && typeof collectionName == 'function') { callback = collectionName; collectionName = null; }
var self = this;
// Let's make our own callback to reuse the existing collections info method
self.collectionsInfo(collectionName, function(err, cursor) {
if(err != null) return callback(err, null);
cursor.toArray(function(err, documents) {
if(err != null) return callback(err, null);
// List of result documents that have been filtered
var filtered_documents = [];
// Remove any collections that are not part of the db or a system db signed with $
documents.forEach(function(document) {
if(!(document.name.indexOf(self.databaseName) == -1 || document.name.indexOf('$') != -1))
filtered_documents.push(document);
});
// Return filtered items
callback(null, filtered_documents);
});
});
};
/**
* Fetch a specific collection (containing the actual collection information)
*
* Options
* - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
* - **slaveOk** {Boolean, default:false}, Allow reads from secondaries.
* - **serializeFunctions** {Boolean, default:false}, serialize functions on the document.
* - **raw** {Boolean, default:false}, perform all operations using raw bson objects.
* - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation.
*
* @param {String} collectionName the collection name we wish to access.
* @param {Object} [options] returns option results.
* @param {Function} [callback] returns the results.
* @return {null}
* @api public
*/
Db.prototype.collection = function(collectionName, options, callback) {
var self = this;
if(typeof options === "function") { callback = options; options = {}; }
// Execute safe
if(options && options.safe || this.strict) {
self.collectionNames(collectionName, function(err, collections) {
if(err != null) return callback(err, null);
if(collections.length == 0) {
return callback(new Error("Collection " + collectionName + " does not exist. Currently in strict mode."), null);
} else {
try {
var collection = new Collection(self, collectionName, self.pkFactory, options);
} catch(err) {
return callback(err, null);
}
return callback(null, collection);
}
});
} else {
try {
var collection = new Collection(self, collectionName, self.pkFactory, options);
} catch(err) {
if(callback == null) {
throw err;
} else {
return callback(err, null);
}
}
// If we have no callback return collection object
return callback == null ? collection : callback(null, collection);
}
};
/**
* Fetch all collections for the current db.
*
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.collections = function(callback) {
var self = this;
// Let's get the collection names
self.collectionNames(function(err, documents) {
if(err != null) return callback(err, null);
var collections = [];
documents.forEach(function(document) {
collections.push(new Collection(self, document.name.replace(self.databaseName + ".", ''), self.pkFactory));
});
// Return the collection objects
callback(null, collections);
});
};
/**
* Evaluate javascript on the server
*
* Options
* - **nolock** {Boolean, default:false}, Tell MongoDB not to block on the evaulation of the javascript.
*
* @param {Code} code javascript to execute on server.
* @param {Object|Array} [parameters] the parameters for the call.
* @param {Object} [options] the options
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.eval = function(code, parameters, options, callback) {
// Unpack calls
var args = Array.prototype.slice.call(arguments, 1);
callback = args.pop();
parameters = args.length ? args.shift() : parameters;
options = args.length ? args.shift() : {};
var finalCode = code;
var finalParameters = [];
// If not a code object translate to one
if(!(finalCode instanceof this.bsonLib.Code)) {
finalCode = new this.bsonLib.Code(finalCode);
}
// Ensure the parameters are correct
if(parameters != null && parameters.constructor != Array && typeof parameters !== 'function') {
finalParameters = [parameters];
} else if(parameters != null && parameters.constructor == Array && typeof parameters !== 'function') {
finalParameters = parameters;
}
// Create execution selector
var selector = {'$eval':finalCode, 'args':finalParameters};
// Check if the nolock parameter is passed in
if(options['nolock']) {
selector['nolock'] = options['nolock'];
}
// Iterate through all the fields of the index
new Cursor(this, new Collection(this, DbCommand.SYSTEM_COMMAND_COLLECTION), selector, options, 0, -1).nextObject(function(err, result) {
if(err != null) return callback(err, null);
if(result.ok == 1) {
callback(null, result.retval);
} else {
callback(new Error("eval failed: " + result.errmsg), null); return;
}
});
};
/**
* Dereference a dbref, against a db
*
* @param {DBRef} dbRef db reference object we wish to resolve.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.dereference = function(dbRef, callback) {
var db = this;
// If we have a db reference then let's get the db first
if(dbRef.db != null) db = this.db(dbRef.db);
// Fetch the collection and find the reference
db.collection(dbRef.namespace, function(err, collection) {
if(err != null) return callback(err, null);
collection.findOne({'_id':dbRef.oid}, function(err, result) {
callback(err, result);
});
});
};
/**
* Logout user from server, fire off on all connections and remove all auth info
*
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.logout = function(callback) {
var self = this;
// Let's generate the logout command object
var logoutCommand = DbCommand.logoutCommand(self, {logout:1});
self._executeQueryCommand(logoutCommand, {onAll:true}, function(err, result) {
// Reset auth
self.auths = [];
// Handle any errors
if(err == null && result.documents[0].ok == 1) {
callback(null, true);
} else {
err != null ? callback(err, false) : callback(new Error(result.documents[0].errmsg), false);
}
});
}
/**
* Authenticate a user against the server.
*
* @param {String} username username.
* @param {String} password password.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.authenticate = function(username, password, callback) {
var self = this;
// Push the new auth if we have no previous record
self.auths = [{'username':username, 'password':password}];
// Get the amount of connections in the pool to ensure we have authenticated all comments
var numberOfConnections = this.serverConfig.allRawConnections().length;
var errorObject = null;
// Execute all four
this._executeQueryCommand(DbCommand.createGetNonceCommand(self), {onAll:true}, function(err, result, connection) {
// Execute on all the connections
if(err == null) {
// Nonce used to make authentication request with md5 hash
var nonce = result.documents[0].nonce;
// Execute command
self._executeQueryCommand(DbCommand.createAuthenticationCommand(self, username, password, nonce), {connection:connection}, function(err, result) {
// Ensure we save any error
if(err) {
errorObject = err;
} else if(result.documents[0].err != null || result.documents[0].errmsg != null){
errorObject = self.wrap(result.documents[0]);
}
// Count down
numberOfConnections = numberOfConnections - 1;
// If we are done with the callbacks return
if(numberOfConnections <= 0) {
if(errorObject == null && result.documents[0].ok == 1) {
callback(errorObject, true);
} else {
callback(errorObject, false);
}
}
});
}
});
};
/**
* Add a user to the database.
*
* Options
* - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
*
* @param {String} username username.
* @param {String} password password.
* @param {Object} [options] additional options during update.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.addUser = function(username, password, options, callback) {
var self = this;
var args = Array.prototype.slice.call(arguments, 2);
callback = args.pop();
options = args.length ? args.shift() : {};
// Figure out the safe mode settings
var safe = self.strict != null && self.strict == false ? true : self.strict;
// Override with options passed in if applicable
safe = options != null && options['safe'] != null ? options['safe'] : safe;
// Ensure it's at least set to safe
safe = safe == null ? true : safe;
// Use node md5 generator
var md5 = crypto.createHash('md5');
// Generate keys used for authentication
md5.update(username + ":mongo:" + password);
var userPassword = md5.digest('hex');
// Fetch a user collection
this.collection(DbCommand.SYSTEM_USER_COLLECTION, function(err, collection) {
collection.find({user: username}).toArray(function(err, documents) {
// We got an error (f.ex not authorized)
if(err != null) return callback(err, null);
// We have a user, let's update the password
if(documents.length > 0) {
collection.update({user: username},{user: username, pwd: userPassword}, {safe:safe}, function(err, results) {
callback(err, documents);
});
} else {
collection.insert({user: username, pwd: userPassword}, {safe:safe}, function(err, documents) {
callback(err, documents);
});
}
});
});
};
/**
* Remove a user from a database
*
* Options
* - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
*
* @param {String} username username.
* @param {Object} [options] additional options during update.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.removeUser = function(username, options, callback) {
var self = this;
var args = Array.prototype.slice.call(arguments, 1);
callback = args.pop();
options = args.length ? args.shift() : {};
// Figure out the safe mode settings
var safe = self.strict != null && self.strict == false ? true : self.strict;
// Override with options passed in if applicable
safe = options != null && options['safe'] != null ? options['safe'] : safe;
// Ensure it's at least set to safe
safe = safe == null ? true : safe;
// Fetch a user collection
this.collection(DbCommand.SYSTEM_USER_COLLECTION, function(err, collection) {
collection.findOne({user: username}, function(err, user) {
if(user != null) {
collection.remove({user: username}, {safe:safe}, function(err, result) {
callback(err, true);
});
} else {
callback(err, false);
}
});
});
};
/**
* Creates a collection on a server pre-allocating space, need to create f.ex capped collections.
*
* Options
* - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
* - **slaveOk** {Boolean, default:false}, Allow reads from secondaries.
* - **serializeFunctions** {Boolean, default:false}, serialize functions on the document.
* - **raw** {Boolean, default:false}, perform all operations using raw bson objects.
* - **pkFactory** {Object}, object overriding the basic ObjectID primary key generation.
* - **capped** {Boolean, default:false}, create a capped collection.
* - **size** {Number}, the size of the capped collection in bytes.
* - **max** {Number}, the maximum number of documents in the capped collection.
* - **autoIndexId** {Boolean, default:false}, create an index on the _id field of the document, not created automatically on capped collections.
*
* @param {String} collectionName the collection name we wish to access.
* @param {Object} [options] returns option results.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.createCollection = function(collectionName, options, callback) {
var args = Array.prototype.slice.call(arguments, 1);
callback = args.pop();
options = args.length ? args.shift() : null;
var self = this;
// Figure out the safe mode settings
var safe = self.strict != null && self.strict == false ? true : self.strict;
// Override with options passed in if applicable
safe = options != null && options['safe'] != null ? options['safe'] : safe;
// Ensure it's at least set to safe
safe = safe == null ? true : safe;
// Check if we have the name
this.collectionNames(collectionName, function(err, collections) {
if(err != null) return callback(err, null);
var found = false;
collections.forEach(function(collection) {
if(collection.name == self.databaseName + "." + collectionName) found = true;
});
// If the collection exists either throw an exception (if db in strict mode) or return the existing collection
if(found && ((options && options.safe) || self.strict)) {
return callback(new Error("Collection " + collectionName + " already exists. Currently in strict mode."), null);
} else if(found){
try {
var collection = new Collection(self, collectionName, self.pkFactory, options);
} catch(err) {
return callback(err, null);
}
return callback(null, collection);
}
// Create a new collection and return it
self._executeQueryCommand(DbCommand.createCreateCollectionCommand(self, collectionName, options), {read:false, safe:safe}, function(err, result) {
var document = result.documents[0];
// If we have no error let's return the collection
if(err == null && document.ok == 1) {
try {
var collection = new Collection(self, collectionName, self.pkFactory, options);
} catch(err) {
return callback(err, null);
}
return callback(null, collection);
} else {
err != null ? callback(err, null) : callback(self.wrap(document), null);
}
});
});
};
/**
* Execute a command hash against MongoDB. This lets you acess any commands not available through the api on the server.
*
* @param {Object} selector the command hash to send to the server, ex: {ping:1}.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.command = function(selector, callback) {
var cursor = new Cursor(this, new Collection(this, DbCommand.SYSTEM_COMMAND_COLLECTION), selector, {}, 0, -1, null, null, null, null, QueryCommand.OPTS_NO_CURSOR_TIMEOUT);
cursor.nextObject(callback);
};
/**
* Drop a collection from the database, removing it permanently. New accesses will create a new collection.
*
* @param {String} collectionName the name of the collection we wish to drop.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.dropCollection = function(collectionName, callback) {
var self = this;
// Drop the collection
this._executeQueryCommand(DbCommand.createDropCollectionCommand(this, collectionName), function(err, result) {
if(err == null && result.documents[0].ok == 1) {
if(callback != null) return callback(null, true);
} else {
if(callback != null) err != null ? callback(err, null) : callback(self.wrap(result.documents[0]), null);
}
});
};
/**
* Rename a collection.
*
* @param {String} fromCollection the name of the current collection we wish to rename.
* @param {String} toCollection the new name of the collection.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.renameCollection = function(fromCollection, toCollection, callback) {
var self = this;
// Execute the command, return the new renamed collection if successful
this._executeQueryCommand(DbCommand.createRenameCollectionCommand(this, fromCollection, toCollection), function(err, result) {
if(err == null && result.documents[0].ok == 1) {
if(callback != null) return callback(null, new Collection(self, toCollection, self.pkFactory));
} else {
if(callback != null) err != null ? callback(err, null) : callback(self.wrap(result.documents[0]), null);
}
});
};
/**
* Return last error message for the given connection, note options can be combined.
*
* Options
* - **fsync** {Boolean, default:false}, option forces the database to fsync all files before returning.
* - **j** {Boolean, default:false}, awaits the journal commit before returning, > MongoDB 2.0.
* - **w** {Number}, until a write operation has been replicated to N servers.
* - **wtimeout** {Number}, number of miliseconds to wait before timing out.
*
* Connection Options
* - **connection** {Connection}, fire the getLastError down a specific connection.
*
* @param {Object} [options] returns option results.
* @param {Object} [connectionOptions] returns option results.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.lastError = function(options, connectionOptions, callback) {
// Unpack calls
var args = Array.prototype.slice.call(arguments, 0);
callback = args.pop();
options = args.length ? args.shift() : {};
connectionOptions = args.length ? args.shift() : {};
this._executeQueryCommand(DbCommand.createGetLastErrorCommand(options, this), connectionOptions, function(err, error) {
callback(err, error && error.documents);
});
};
/**
* Legacy method calls.
*
* @ignore
* @api private
*/
Db.prototype.error = Db.prototype.lastError;
Db.prototype.lastStatus = Db.prototype.lastError;
/**
* Return all errors up to the last time db reset_error_history was called.
*
* Options
* - **connection** {Connection}, fire the getLastError down a specific connection.
*
* @param {Object} [options] returns option results.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.previousErrors = function(options, callback) {
// Unpack calls
var args = Array.prototype.slice.call(arguments, 0);
callback = args.pop();
options = args.length ? args.shift() : {};
this._executeQueryCommand(DbCommand.createGetPreviousErrorsCommand(this), options, function(err, error) {
callback(err, error.documents);
});
};
/**
* Runs a command on the database.
* @ignore
* @api private
*/
Db.prototype.executeDbCommand = function(command_hash, options, callback) {
if(callback == null) { callback = options; options = {}; }
this._executeQueryCommand(DbCommand.createDbSlaveOkCommand(this, command_hash, options), options, callback);
};
/**
* Runs a command on the database as admin.
* @ignore
* @api private
*/
Db.prototype.executeDbAdminCommand = function(command_hash, options, callback) {
if(callback == null) { callback = options; options = {}; }
this._executeQueryCommand(DbCommand.createAdminDbCommand(this, command_hash, options), callback);
};
/**
* Resets the error history of the mongo instance.
*
* Options
* - **connection** {Connection}, fire the getLastError down a specific connection.
*
* @param {Object} [options] returns option results.
* @param {Function} callback returns the results.
* @return {null}
* @api public
*/
Db.prototype.resetErrorHistory = function(options, callback) {
// Unpack calls
var args = Array.prototype.slice.call(arguments, 0);
callback = args.pop();
options = args.length ? args.shift() : {};
this._executeQueryCommand(DbCommand.createResetErrorHistoryCommand(this), options, function(err, error) {
callback(err, error.documents);
});
};
/**
* Creates an index on the collection.
*
* Options
* - **safe** {true | {w:n, wtimeout:n} | {fsync:true}, default:false}, executes with a getLastError command returning the results of the command on MongoDB.
* - **unique** {Boolean, default:false}, creates an unique index.
* - **sparse** {Boolean, default:false}, creates a sparse index.
* - **background** {Boolean, default:false}, creates the index in the background, yielding whenever possible.
* - **dropDups** {Boolean, default:false}, a unique index cannot be created on a key that has pre-existing duplicate values. If you would like to create the index anyway, keeping the first document the database indexes and deleting all subsequent documents that have duplicate value
* - **min** {Number}, for geospatial indexes set the lower bound for the co-ordinates.
* - **max** {Number}, for geospatial indexes set the high bound for the co-ordinates.
*
* @param {String} collectionName name of the collection to create the index on.
* @param {Object} fieldOrSpec fieldOrSpec that defines the index.
* @param {Object} [options] additional options during update.
* @param {Function} callback for results.
* @return {null}
* @api public
*/
Db.prototype.createIndex = function(collectionName, fieldOrSpec, options, callback) {
var self = this;
var args = Array.prototype.slice.call(arguments, 2);
callback = args.pop();
options = args.length ? args.shift() : {};
options = typeof callback === 'function' ? options : callback;
options = options == null ? {} : options;
// Collect errorOptions
var errorOptions = options.safe != null ? options.safe : null;
errorOptions = errorOptions == null && self.strict != null ? self.strict : errorOptions;
// If we have a write concern set and no callback throw error
if(errorOptions != null && errorOptions != false && (typeof callback !== 'function' && typeof options !== 'function')) throw new Error("safe cannot be used without a callback");
// Create command
var command = DbCommand.createCreateIndexCommand(this, collectionName, fieldOrSpec, options);
// Default command options
var commandOptions = {};
// If we have error conditions set handle them
if(errorOptions && errorOptions != false) {
// Insert options
commandOptions['read'] = false;
// If we have safe set set async to false
if(errorOptions == null) commandOptions['async'] = true;
// Set safe option
commandOptions['safe'] = errorOptions;
// If we have an error option
if(typeof errorOptions == 'object') {
var keys = Object.keys(errorOptions);
for(var i = 0; i < keys.length; i++) {
commandOptions[keys[i]] = errorOptions[keys[i]];
}
}
// Execute insert command
this._executeInsertCommand(command, commandOptions, function(err, result) {
if(err != null) return callback(err, null);
result = result && result.documents;