// db.js var DB; (function() { var _defaultWriteConcern = {w: 'majority', wtimeout: 10 * 60 * 1000}; if (DB === undefined) { DB = function(mongo, name) { this._mongo = mongo; this._name = name; }; } DB.prototype.getMongo = function() { assert(this._mongo, "why no mongo!"); return this._mongo; }; DB.prototype.getSiblingDB = function(name) { return this.getSession().getDatabase(name); }; DB.prototype.getSisterDB = DB.prototype.getSiblingDB; DB.prototype.getName = function() { return this._name; }; DB.prototype.stats = function(scale) { return this.runCommand({dbstats: 1, scale: scale}); }; DB.prototype.getCollection = function(name) { return new DBCollection(this._mongo, this, name, this._name + "." + name); }; DB.prototype.commandHelp = function(name) { var c = {}; c[name] = 1; c.help = true; var res = this.runCommand(c); if (!res.ok) throw _getErrorWithCode(res, res.errmsg); return res.help; }; // utility to attach readPreference if needed. DB.prototype._attachReadPreferenceToCommand = function(cmdObj, readPref) { "use strict"; // if the user has not set a readpref, return the original cmdObj if ((readPref === null) || typeof (readPref) !== "object") { return cmdObj; } // if user specifies $readPreference manually, then don't change it if (cmdObj.hasOwnProperty("$readPreference")) { return cmdObj; } // copy object so we don't mutate the original var clonedCmdObj = Object.extend({}, cmdObj); // The server selection spec mandates that the key is '$query', but // the shell has historically used 'query'. The server accepts both, // so we maintain the existing behavior var cmdObjWithReadPref = {query: clonedCmdObj, $readPreference: readPref}; return cmdObjWithReadPref; }; /** * If someone passes i.e. runCommand("foo", {bar: "baz"}), we merge it in to * runCommand({foo: 1, bar: "baz"}). * If we already have a command object in the first argument, we ensure that the second * argument 'extraKeys' is either null or an empty object. This prevents users from accidentally * calling runCommand({foo: 1}, {bar: 1}) and expecting the final command invocation to be * runCommand({foo: 1, bar: 1}). * This helper abstracts that logic. */ DB.prototype._mergeCommandOptions = function(obj, extraKeys) { "use strict"; if (typeof (obj) === "object") { if (Object.keys(extraKeys || {}).length > 0) { throw Error("Unexpected second argument to DB.runCommand(): (type: " + typeof (extraKeys) + "): " + tojson(extraKeys)); } return obj; } else if (typeof (obj) !== "string") { throw Error("First argument to DB.runCommand() must be either an object or a string: " + "(type: " + typeof (obj) + "): " + tojson(obj)); } var commandName = obj; var mergedCmdObj = {}; mergedCmdObj[commandName] = 1; if (!extraKeys) { return mergedCmdObj; } else if (typeof (extraKeys) === "object") { // this will traverse the prototype chain of extra, but keeping // to maintain legacy behavior for (var key in extraKeys) { mergedCmdObj[key] = extraKeys[key]; } } else { throw Error("Second argument to DB.runCommand(" + commandName + ") must be an object: (type: " + typeof (extraKeys) + "): " + tojson(extraKeys)); } return mergedCmdObj; }; // Like runCommand but applies readPreference if one has been set // on the connection. Also sets slaveOk if a (non-primary) readPref has been set. DB.prototype.runReadCommand = function(obj, extra, queryOptions) { "use strict"; // Support users who call this function with a string commandName, e.g. // db.runReadCommand("commandName", {arg1: "value", arg2: "value"}). obj = this._mergeCommandOptions(obj, extra); queryOptions = queryOptions !== undefined ? queryOptions : this.getQueryOptions(); { const session = this.getSession(); const readPreference = session._getSessionAwareClient().getReadPreference(session); if (readPreference !== null) { obj = this._attachReadPreferenceToCommand(obj, readPreference); if (readPreference.mode !== "primary") { // Set slaveOk if readPrefMode has been explicitly set with a readPreference // other than primary. queryOptions |= 4; } } } // The 'extra' parameter is not used as we have already created a merged command object. return this.runCommand(obj, null, queryOptions); }; // runCommand uses this impl to actually execute the command DB.prototype._runCommandImpl = function(name, obj, options) { const session = this.getSession(); return session._getSessionAwareClient().runCommand(session, name, obj, options); }; DB.prototype.runCommand = function(obj, extra, queryOptions) { "use strict"; // Support users who call this function with a string commandName, e.g. // db.runCommand("commandName", {arg1: "value", arg2: "value"}). var mergedObj = this._mergeCommandOptions(obj, extra); // if options were passed (i.e. because they were overridden on a collection), use them. // Otherwise use getQueryOptions. var options = (typeof (queryOptions) !== "undefined") ? queryOptions : this.getQueryOptions(); try { return this._runCommandImpl(this._name, mergedObj, options); } catch (ex) { // When runCommand flowed through query, a connection error resulted in the message // "error doing query: failed". Even though this message is arguably incorrect // for a command failing due to a connection failure, we preserve it for backwards // compatibility. See SERVER-18334 for details. if (ex.message.indexOf("network error") >= 0) { throw new Error("error doing query: failed: " + ex.message); } throw ex; } }; DB.prototype.runCommandWithMetadata = function(commandArgs, metadata) { const session = this.getSession(); return session._getSessionAwareClient().runCommandWithMetadata( session, this._name, metadata, commandArgs); }; DB.prototype._dbCommand = DB.prototype.runCommand; DB.prototype._dbReadCommand = DB.prototype.runReadCommand; DB.prototype.adminCommand = function(obj, extra) { if (this._name == "admin") return this.runCommand(obj, extra); return this.getSiblingDB("admin").runCommand(obj, extra); }; DB.prototype._adminCommand = DB.prototype.adminCommand; // alias old name DB.prototype._runAggregate = function(cmdObj, aggregateOptions) { assert(cmdObj.pipeline instanceof Array, "cmdObj must contain a 'pipeline' array"); assert(cmdObj.aggregate !== undefined, "cmdObj must contain 'aggregate' field"); assert(aggregateOptions === undefined || aggregateOptions instanceof Object, "'aggregateOptions' argument must be an object"); // Make a copy of the initial command object, i.e. {aggregate: x, pipeline: [...]}. cmdObj = Object.extend({}, cmdObj); // Make a copy of the aggregation options. let optcpy = Object.extend({}, (aggregateOptions || {})); if ('batchSize' in optcpy) { if (optcpy.cursor == null) { optcpy.cursor = {}; } optcpy.cursor.batchSize = optcpy['batchSize']; delete optcpy['batchSize']; } else if ('useCursor' in optcpy) { if (optcpy.cursor == null) { optcpy.cursor = {}; } delete optcpy['useCursor']; } const maxAwaitTimeMS = optcpy.maxAwaitTimeMS; delete optcpy.maxAwaitTimeMS; // Reassign the cleaned-up options. aggregateOptions = optcpy; // Add the options to the command object. Object.extend(cmdObj, aggregateOptions); if (!('cursor' in cmdObj)) { cmdObj.cursor = {}; } const res = this.runReadCommand(cmdObj); if (!res.ok && (res.code == 17020 || res.errmsg == "unrecognized field \"cursor") && !("cursor" in aggregateOptions)) { // If the command failed because cursors aren't supported and the user didn't explicitly // request a cursor, try again without requesting a cursor. delete cmdObj.cursor; res = doAgg(cmdObj); if ('result' in res && !("cursor" in res)) { // convert old-style output to cursor-style output res.cursor = {ns: '', id: NumberLong(0)}; res.cursor.firstBatch = res.result; delete res.result; } } assert.commandWorked(res, "aggregate failed"); if ("cursor" in res) { let batchSizeValue = undefined; if (cmdObj["cursor"]["batchSize"] > 0) { batchSizeValue = cmdObj["cursor"]["batchSize"]; } return new DBCommandCursor(this, res, batchSizeValue, maxAwaitTimeMS); } return res; }; DB.prototype.aggregate = function(pipeline, aggregateOptions) { assert(pipeline instanceof Array, "pipeline argument must be an array"); const cmdObj = this._mergeCommandOptions("aggregate", {pipeline: pipeline}); return this._runAggregate(cmdObj, (aggregateOptions || {})); }; /** Create a new collection in the database. Normally, collection creation is automatic. You would use this function if you wish to specify special options on creation. If the collection already exists, no action occurs.
Options:
Example:
db.createCollection("movies", { size: 10 * 1024 * 1024, capped:true } );
* @param {String} name Name of new collection to create
* @param {Object} options Object with options for call. Options are listed above.
* @return {Object} returned has member ok set to true if operation succeeds, false otherwise.
*/
DB.prototype.createCollection = function(name, opt) {
var options = opt || {};
var cmd = {create: name};
Object.extend(cmd, options);
return this._dbCommand(cmd);
};
/**
* Command to create a view based on the specified aggregation pipeline.
* Usage: db.createView(name, viewOn, pipeline: [{ $operator: {...}}, ... ])
*
* @param name String - name of the new view to create
* @param viewOn String - name of the backing view or collection
* @param pipeline [{ $operator: {...}}, ... ] - the aggregation pipeline that defines the view
* @param options { } - options on the view, e.g., collations
*/
DB.prototype.createView = function(name, viewOn, pipeline, opt) {
var options = opt || {};
var cmd = {create: name};
if (viewOn == undefined) {
throw Error("Must specify a backing view or collection");
}
// Since we allow a single stage pipeline to be specified as an object
// in aggregation, we need to account for that here for consistency.
if (pipeline != undefined) {
if (!Array.isArray(pipeline)) {
pipeline = [pipeline];
}
}
options.pipeline = pipeline;
options.viewOn = viewOn;
Object.extend(cmd, options);
return this._dbCommand(cmd);
};
/**
* @deprecated use getProfilingStatus
* Returns the current profiling level of this database
* @return SOMETHING_FIXME or null on error
*/
DB.prototype.getProfilingLevel = function() {
var res = assert.commandWorked(this._dbCommand({profile: -1}));
return res ? res.was : null;
};
/**
* @return the current profiling status
* example { was : 0, slowms : 100 }
* @return SOMETHING_FIXME or null on error
*/
DB.prototype.getProfilingStatus = function() {
var res = this._dbCommand({profile: -1});
if (!res.ok)
throw _getErrorWithCode(res, "profile command failed: " + tojson(res));
delete res.ok;
return res;
};
/**
* Erase the entire database.
* @params writeConcern: (document) expresses the write concern of the drop command.
* @return Object returned has member ok set to true if operation succeeds, false otherwise.
*/
DB.prototype.dropDatabase = function(writeConcern) {
return this._dbCommand(
{dropDatabase: 1, writeConcern: writeConcern ? writeConcern : _defaultWriteConcern});
};
/**
* Shuts down the database. Must be run while using the admin database.
* @param opts Options for shutdown. Possible options are:
* - force: (boolean) if the server should shut down, even if there is no
* up-to-date slave
* - timeoutSecs: (number) the server will continue checking over timeoutSecs
* if any other servers have caught up enough for it to shut down.
*/
DB.prototype.shutdownServer = function(opts) {
if ("admin" != this._name) {
return "shutdown command only works with the admin database; try 'use admin'";
}
var cmd = {'shutdown': 1};
opts = opts || {};
for (var o in opts) {
cmd[o] = opts[o];
}
try {
var res = this.runCommand(cmd);
if (!res.ok) {
throw _getErrorWithCode(res, 'shutdownServer failed: ' + tojson(res));
}
throw Error('shutdownServer failed: server is still up.');
} catch (e) {
// we expect the command to not return a response, as the server will shut down
// immediately.
if (isNetworkError(e)) {
print('server should be down...');
return;
}
throw e;
}
};
/**
Clone database on another server to here. This functionality was removed as of MongoDB 4.2.
The shell helper is kept to maintain compatibility with previous versions of MongoDB.
Generally, you should dropDatabase() first as otherwise the cloned information will MERGE into whatever data is already present in this database. (That is however a valid way to use clone if you are trying to do something intentionally, such as union three non-overlapping databases into one.)
This is a low level administrative function will is not typically used.
* @param {String} from Where to clone from (dbhostname[:port]). May not be this database
(self) as you cannot clone to yourself.
* @return Object returned has member ok set to true if operation succeeds, false otherwise.
* See also: db.copyDatabase()
*/
DB.prototype.cloneDatabase = function(from) {
print(
"WARNING: db.cloneDatabase will only function with MongoDB 4.0 and below. See http://dochub.mongodb.org/core/4.2-copydb-clone");
assert(isString(from) && from.length);
return this._dbCommand({clone: from});
};
/**
Copy database from one server or name to another server or name. This functionality was
removed as of MongoDB 4.2. The shell helper is kept to maintain compatibility with previous
versions of MongoDB.
Generally, you should dropDatabase() first as otherwise the copied information will MERGE
into whatever data is already present in this database (and you will get duplicate objects
in collections potentially.)
For security reasons this function only works when executed on the "admin" db. However,
if you have access to said db, you can copy any database from one place to another.
This method provides a way to "rename" a database by copying it to a new db name and
location. Additionally, it effectively provides a repair facility.
* @param {String} fromdb database name from which to copy.
* @param {String} todb database name to copy to.
* @param {String} fromhost hostname of the database (and optionally, ":port") from which to
copy the data. default if unspecified is to copy from self.
* @return Object returned has member ok set to true if operation succeeds, false otherwise.
* See also: db.clone()
*/
DB.prototype.copyDatabase = function(
fromdb, todb, fromhost, username, password, mechanism, slaveOk) {
print(
"WARNING: db.copyDatabase will only function with MongoDB 4.0 and below. See http://dochub.mongodb.org/core/4.2-copydb-clone");
assert(isString(fromdb) && fromdb.length);
assert(isString(todb) && todb.length);
fromhost = fromhost || "";
if ((typeof username === "boolean") && (typeof password === "undefined") &&
(typeof mechanism === "undefined") && (typeof slaveOk === "undefined")) {
slaveOk = username;
username = undefined;
}
if (typeof slaveOk !== "boolean") {
slaveOk = false;
}
if (!mechanism) {
mechanism = this._getDefaultAuthenticationMechanism(username, fromdb);
}
assert(mechanism == "SCRAM-SHA-1" || mechanism == "SCRAM-SHA-256" || mechanism == "MONGODB-CR");
// Check for no auth or copying from localhost
if (!username || !password || fromhost == "") {
return this._adminCommand(
{copydb: 1, fromhost: fromhost, fromdb: fromdb, todb: todb, slaveOk: slaveOk});
}
// Use the copyDatabase native helper for SCRAM-SHA-1/256
if (mechanism != "MONGODB-CR") {
// TODO SERVER-30886: Add session support for Mongo.prototype.copyDatabaseWithSCRAM().
return this.getMongo().copyDatabaseWithSCRAM(
fromdb, todb, fromhost, username, password, slaveOk);
}
// Fall back to MONGODB-CR
var n = assert.commandWorked(this._adminCommand({copydbgetnonce: 1, fromhost: fromhost}));
return this._adminCommand({
copydb: 1,
fromhost: fromhost,
fromdb: fromdb,
todb: todb,
username: username,
nonce: n.nonce,
key: this.__pwHash(n.nonce, username, password),
slaveOk: slaveOk,
});
};
DB.prototype.help = function() {
print("DB methods:");
print(
"\tdb.adminCommand(nameOrDocument) - switches to 'admin' db, and runs command [just calls db.runCommand(...)]");
print(
"\tdb.aggregate([pipeline], {options}) - performs a collectionless aggregation on this database; returns a cursor");
print("\tdb.auth(username, password)");
print("\tdb.cloneDatabase(fromhost) - will only function with MongoDB 4.0 and below");
print("\tdb.commandHelp(name) returns the help for the command");
print(
"\tdb.copyDatabase(fromdb, todb, fromhost) - will only function with MongoDB 4.0 and below");
print("\tdb.createCollection(name, {size: ..., capped: ..., max: ...})");
print("\tdb.createUser(userDocument)");
print("\tdb.createView(name, viewOn, [{$operator: {...}}, ...], {viewOptions})");
print("\tdb.currentOp() displays currently executing operations in the db");
print("\tdb.dropDatabase(writeConcern)");
print("\tdb.dropUser(username)");
print("\tdb.eval() - deprecated");
print("\tdb.fsyncLock() flush data to disk and lock server for backups");
print("\tdb.fsyncUnlock() unlocks server following a db.fsyncLock()");
print("\tdb.getCollection(cname) same as db['cname'] or db.cname");
print("\tdb.getCollectionInfos([filter]) - returns a list that contains the names and options" +
" of the db's collections");
print("\tdb.getCollectionNames()");
print("\tdb.getLastError() - just returns the err msg string");
print("\tdb.getLastErrorObj() - return full status object");
print("\tdb.getLogComponents()");
print("\tdb.getMongo() get the server connection object");
print("\tdb.getMongo().setSlaveOk() allow queries on a replication slave server");
print("\tdb.getName()");
print("\tdb.getProfilingLevel() - deprecated");
print("\tdb.getProfilingStatus() - returns if profiling is on and slow threshold");
print("\tdb.getReplicationInfo()");
print("\tdb.getSiblingDB(name) get the db at the same server as this one");
print(
"\tdb.getWriteConcern() - returns the write concern used for any operations on this db, inherited from server object if set");
print("\tdb.hostInfo() get details about the server's host");
print("\tdb.isMaster() check replica primary status");
print("\tdb.killOp(opid) kills the current operation in the db");
print("\tdb.listCommands() lists all the db commands");
print("\tdb.loadServerScripts() loads all the scripts in db.system.js");
print("\tdb.logout()");
print("\tdb.printCollectionStats()");
print("\tdb.printReplicationInfo()");
print("\tdb.printShardingStatus()");
print("\tdb.printSlaveReplicationInfo()");
print("\tdb.resetError()");
print(
"\tdb.runCommand(cmdObj) run a database command. if cmdObj is a string, turns it into {cmdObj: 1}");
print("\tdb.serverStatus()");
print("\tdb.setLogLevel(level, Evaluate a js expression at the database server. Useful if you need to touch a lot of data lightly; in such a scenario
* the network transfer of the data could be a bottleneck. A good example
* is "select count(*)" -- can be done server side via this mechanism.
*
* If the eval fails, an exception is thrown of the form:
* Example:
* An array of grouped items is returned. The array must fit in RAM, thus this function is not
* suitable when the return set is extremely large.
*
* To order the grouped data, simply sort it client side upon return.
*
Defaults
cond may be null if you want to run against all rows in the collection
keyf is a function which takes an object and returns the desired key. set either key or
keyf (not both).
*
This command is for the database/cloud administer and not applicable to most databases.
It is only used with the local database. One might invoke from the JS shell:
{ dbEvalException: { retval: functionReturnValue, ok: num [, errno: num] [, errmsg:
*str] } }
*
* print( "mycount: " + db.eval( function(){db.mycoll.find({},{_id:ObjId()}).length();}
*);
*
* @param {Function} jsfunction Javascript function to run on server. Note this it not a
*closure, but rather just "code".
* @return result of your function, or null if error
*
*/
DB.prototype.eval = function(jsfunction) {
print("WARNING: db.eval is deprecated");
var cmd = {$eval: jsfunction};
if (arguments.length > 1) {
cmd.args = Array.from(arguments).slice(1);
}
var res = this._dbCommand(cmd);
if (!res.ok)
throw _getErrorWithCode(res, tojson(res));
return res.retval;
};
DB.prototype.dbEval = DB.prototype.eval;
/**
*
use local
db.getReplicationInfo();
* @return Object timeSpan: time span of the oplog from start to end if slave is more out
* of date than that, it can't recover without a complete resync
*/
DB.prototype.getReplicationInfo = function() {
var localdb = this.getSiblingDB("local");
var result = {};
var oplog;
var localCollections = localdb.getCollectionNames();
if (localCollections.indexOf('oplog.rs') >= 0) {
oplog = 'oplog.rs';
} else {
result.errmsg = "replication not detected";
return result;
}
var ol = localdb.getCollection(oplog);
var ol_stats = ol.stats();
if (ol_stats && ol_stats.maxSize) {
result.logSizeMB = ol_stats.maxSize / (1024 * 1024);
} else {
result.errmsg = "Could not get stats for local." + oplog + " collection. " +
"collstats returned: " + tojson(ol_stats);
return result;
}
result.usedMB = ol_stats.size / (1024 * 1024);
result.usedMB = Math.ceil(result.usedMB * 100) / 100;
var firstc = ol.find().sort({$natural: 1}).limit(1);
var lastc = ol.find().sort({$natural: -1}).limit(1);
if (!firstc.hasNext() || !lastc.hasNext()) {
result.errmsg =
"objects not found in local.oplog.$main -- is this a new and empty db instance?";
result.oplogMainRowCount = ol.count();
return result;
}
var first = firstc.next();
var last = lastc.next();
var tfirst = first.ts;
var tlast = last.ts;
if (tfirst && tlast) {
tfirst = DB.tsToSeconds(tfirst);
tlast = DB.tsToSeconds(tlast);
result.timeDiff = tlast - tfirst;
result.timeDiffHours = Math.round(result.timeDiff / 36) / 100;
result.tFirst = (new Date(tfirst * 1000)).toString();
result.tLast = (new Date(tlast * 1000)).toString();
result.now = Date();
} else {
result.errmsg = "ts element not found in oplog objects";
}
return result;
};
DB.prototype.printReplicationInfo = function() {
var result = this.getReplicationInfo();
if (result.errmsg) {
var isMaster = this.isMaster();
if (isMaster.arbiterOnly) {
print("cannot provide replication status from an arbiter.");
return;
} else if (!isMaster.ismaster) {
print("this is a slave, printing slave replication info.");
this.printSlaveReplicationInfo();
return;
}
print(tojson(result));
return;
}
print("configured oplog size: " + result.logSizeMB + "MB");
print("log length start to end: " + result.timeDiff + "secs (" + result.timeDiffHours + "hrs)");
print("oplog first event time: " + result.tFirst);
print("oplog last event time: " + result.tLast);
print("now: " + result.now);
};
DB.prototype.printSlaveReplicationInfo = function() {
var startOptimeDate = null;
var primary = null;
function getReplLag(st) {
assert(startOptimeDate, "how could this be null (getReplLag startOptimeDate)");
print("\tsyncedTo: " + st.toString());
var ago = (startOptimeDate - st) / 1000;
var hrs = Math.round(ago / 36) / 100;
var suffix = "";
if (primary) {
suffix = "primary ";
} else {
suffix = "freshest member (no primary available at the moment)";
}
print("\t" + Math.round(ago) + " secs (" + hrs + " hrs) behind the " + suffix);
}
function getMaster(members) {
for (i in members) {
var row = members[i];
if (row.state === 1) {
return row;
}
}
return null;
}
function g(x) {
assert(x, "how could this be null (printSlaveReplicationInfo gx)");
print("source: " + x.host);
if (x.syncedTo) {
var st = new Date(DB.tsToSeconds(x.syncedTo) * 1000);
getReplLag(st);
} else {
print("\tdoing initial sync");
}
}
function r(x) {
assert(x, "how could this be null (printSlaveReplicationInfo rx)");
if (x.state == 1 || x.state == 7) { // ignore primaries (1) and arbiters (7)
return;
}
print("source: " + x.name);
if (x.optime) {
getReplLag(x.optimeDate);
} else {
print("\tno replication info, yet. State: " + x.stateStr);
}
}
var L = this.getSiblingDB("local");
if (L.system.replset.count() != 0) {
var status = this.adminCommand({'replSetGetStatus': 1});
primary = getMaster(status.members);
if (primary) {
startOptimeDate = primary.optimeDate;
}
// no primary, find the most recent op among all members
else {
startOptimeDate = new Date(0, 0);
for (i in status.members) {
if (status.members[i].optimeDate > startOptimeDate) {
startOptimeDate = status.members[i].optimeDate;
}
}
}
for (i in status.members) {
r(status.members[i]);
}
}
};
DB.prototype.serverBuildInfo = function() {
return this._adminCommand("buildinfo");
};
// Used to trim entries from the metrics.commands that have never been executed
getActiveCommands = function(tree) {
var result = {};
for (var i in tree) {
if (!tree.hasOwnProperty(i))
continue;
if (tree[i].hasOwnProperty("total")) {
if (tree[i].total > 0) {
result[i] = tree[i];
}
continue;
}
if (i == "