bin_node_modules_mongodb_lib_mongodb_commands_update_command.js.html
No OneTemporary
Actions

Size

18 KB

Referenced Files

None

Subscribers

None

bin_node_modules_mongodb_lib_mongodb_commands_update_command.js.html
View Options

	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<title>bin/node_modules/mongodb/lib/mongodb/commands/update_command.js - Prometheus Framework</title>
	<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
	<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
	<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
	<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
	<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
	</head>
	<body class="yui3-skin-sam">

	<div id="doc">
	<div id="hd" class="yui3-g header">
	<div class="yui3-u-3-4">
	<h1><img src="../assets/css/logo.png" title="Prometheus Framework"></h1>
	</div>
	<div class="yui3-u-1-4 version">
	<em>API Docs for: 0.1</em>
	</div>
	</div>
	<div id="bd" class="yui3-g">

	<div class="yui3-u-1-4">
	<div id="docs-sidebar" class="sidebar apidocs">
	<div id="api-list">
	<h2 class="off-left">APIs</h2>
	<div id="api-tabview" class="tabview">
	<ul class="tabs">
	<li><a href="#api-classes">Classes</a></li>
	<li><a href="#api-modules">Modules</a></li>
	</ul>

	<div id="api-tabview-filter">
	<input type="search" id="api-filter" placeholder="Type to filter APIs">
	</div>

	<div id="api-tabview-panel">
	<ul id="api-classes" class="apis classes">
	<li><a href="../classes/Represents a
	Replicaset Configuration.html">Represents a
	Replicaset Configuration</a></li>
	<li><a href="../classes/Represents a BatchWriteResult.html">Represents a BatchWriteResult</a></li>
	<li><a href="../classes/Represents a Collection.html">Represents a Collection</a></li>
	<li><a href="../classes/Represents a Cursor..html">Represents a Cursor.</a></li>
	<li><a href="../classes/Represents a CursorStream..html">Represents a CursorStream.</a></li>
	<li><a href="../classes/Represents a Db.html">Represents a Db</a></li>
	<li><a href="../classes/Represents a GridFS File Stream..html">Represents a GridFS File Stream.</a></li>
	<li><a href="../classes/.html"></a></li>
	<li><a href="../classes/Represents a MongoClient.html">Represents a MongoClient</a></li>
	<li><a href="../classes/Represents a Mongos connection with failover to backup proxies.html">Represents a Mongos connection with failover to backup proxies</a></li>
	<li><a href="../classes/Represents a OrderedBulkOperation.html">Represents a OrderedBulkOperation</a></li>
	<li><a href="../classes/Represents a Read Preference..html">Represents a Read Preference.</a></li>
	<li><a href="../classes/Represents a Server connection..html">Represents a Server connection.</a></li>
	<li><a href="../classes/Represents a UnorderedBulkOperation.html">Represents a UnorderedBulkOperation</a></li>
	<li><a href="../classes/Represents the Admin methods of MongoDB..html">Represents the Admin methods of MongoDB.</a></li>
	<li><a href="../classes/Represents the Grid..html">Represents the Grid.</a></li>
	<li><a href="../classes/Represents the GridStore..html">Represents the GridStore.</a></li>
	</ul>

	<ul id="api-modules" class="apis modules">
	<li><a href="../modules/association.html">association</a></li>
	<li><a href="../modules/database-accessor.html">database-accessor</a></li>
	<li><a href="../modules/field-type-manager.html">field-type-manager</a></li>
	<li><a href="../modules/resource-type-manager.html">resource-type-manager</a></li>
	</ul>
	</div>
	</div>
	</div>
	</div>
	</div>
	<div class="yui3-u-3-4">
	<div id="api-options">
	Show:
	<label for="api-show-inherited">
	<input type="checkbox" id="api-show-inherited" checked>
	Inherited
	</label>

	<label for="api-show-protected">
	<input type="checkbox" id="api-show-protected">
	Protected
	</label>

	<label for="api-show-private">
	<input type="checkbox" id="api-show-private">
	Private
	</label>
	<label for="api-show-deprecated">
	<input type="checkbox" id="api-show-deprecated">
	Deprecated
	</label>

	</div>

	<div class="apidocs">
	<div id="docs-main">
	<div class="content">
	<h1 class="file-heading">File: bin/node_modules/mongodb/lib/mongodb/commands/update_command.js</h1>

	<div class="file">
	<pre class="code prettyprint linenums">
	var BaseCommand = require('./base_command').BaseCommand,
	inherits = require('util').inherits;

	/**
	Update Document Command
	**/
	var UpdateCommand = exports.UpdateCommand = function(db, collectionName, spec, document, options) {
	BaseCommand.call(this);

	var object = spec;
	if(Buffer.isBuffer(object)) {
	var object_size = object[0] \| object[1] << 8 \| object[2] << 16 \| object[3] << 24;
	if(object_size != object.length) {
	var error = new Error("update spec raw message size does not match message header size [" + object.length + "] != [" + object_size + "]");
	error.name = 'MongoError';
	throw error;
	}
	}

	var object = document;
	if(Buffer.isBuffer(object)) {
	var object_size = object[0] \| object[1] << 8 \| object[2] << 16 \| object[3] << 24;
	if(object_size != object.length) {
	var error = new Error("update document raw message size does not match message header size [" + object.length + "] != [" + object_size + "]");
	error.name = 'MongoError';
	throw error;
	}
	}

	this.collectionName = collectionName;
	this.spec = spec;
	this.document = document;
	this.db = db;
	this.serializeFunctions = false;
	this.checkKeys = typeof options.checkKeys != 'boolean' ? false : options.checkKeys;

	// Generate correct flags
	var db_upsert = 0;
	var db_multi_update = 0;
	db_upsert = options != null && options['upsert'] != null ? (options['upsert'] == true ? 1 : 0) : db_upsert;
	db_multi_update = options != null && options['multi'] != null ? (options['multi'] == true ? 1 : 0) : db_multi_update;

	// Flags
	this.flags = parseInt(db_multi_update.toString() + db_upsert.toString(), 2);
	// Let us defined on a command basis if we want functions to be serialized or not
	if(options['serializeFunctions'] != null && options['serializeFunctions']) {
	this.serializeFunctions = true;
	}
	};

	inherits(UpdateCommand, BaseCommand);

	UpdateCommand.OP_UPDATE = 2001;

	/*
	struct {
	MsgHeader header; // standard message header
	int32 ZERO; // 0 - reserved for future use
	cstring fullCollectionName; // "dbname.collectionname"
	int32 flags; // bit vector. see below
	BSON spec; // the query to select the document
	BSON document; // the document data to update with or insert
	}
	*/
	UpdateCommand.prototype.toBinary = function(bsonSettings) {
	// Validate that we are not passing 0x00 in the colletion name
	if(!!~this.collectionName.indexOf("\x00")) {
	throw new Error("namespace cannot contain a null character");
	}

	// Calculate total length of the document
	var totalLengthOfCommand = 4 + Buffer.byteLength(this.collectionName) + 1 + 4 + this.db.bson.calculateObjectSize(this.spec, false, true) +
	this.db.bson.calculateObjectSize(this.document, this.serializeFunctions, true) + (4 * 4);

	// Enforce maximum bson size
	if(!bsonSettings.disableDriverBSONSizeCheck
	&& totalLengthOfCommand > bsonSettings.maxBsonSize)
	throw new Error("Document exceeds maximum allowed bson size of " + bsonSettings.maxBsonSize + " bytes");

	if(bsonSettings.disableDriverBSONSizeCheck
	&& totalLengthOfCommand > bsonSettings.maxMessageSizeBytes)
	throw new Error("Command exceeds maximum message size of " + bsonSettings.maxMessageSizeBytes + " bytes");

	// Let's build the single pass buffer command
	var _index = 0;
	var _command = new Buffer(totalLengthOfCommand);
	// Write the header information to the buffer
	_command[_index + 3] = (totalLengthOfCommand >> 24) & 0xff;
	_command[_index + 2] = (totalLengthOfCommand >> 16) & 0xff;
	_command[_index + 1] = (totalLengthOfCommand >> 8) & 0xff;
	_command[_index] = totalLengthOfCommand & 0xff;
	// Adjust index
	_index = _index + 4;
	// Write the request ID
	_command[_index + 3] = (this.requestId >> 24) & 0xff;
	_command[_index + 2] = (this.requestId >> 16) & 0xff;
	_command[_index + 1] = (this.requestId >> 8) & 0xff;
	_command[_index] = this.requestId & 0xff;
	// Adjust index
	_index = _index + 4;
	// Write zero
	_command[_index++] = 0;
	_command[_index++] = 0;
	_command[_index++] = 0;
	_command[_index++] = 0;
	// Write the op_code for the command
	_command[_index + 3] = (UpdateCommand.OP_UPDATE >> 24) & 0xff;
	_command[_index + 2] = (UpdateCommand.OP_UPDATE >> 16) & 0xff;
	_command[_index + 1] = (UpdateCommand.OP_UPDATE >> 8) & 0xff;
	_command[_index] = UpdateCommand.OP_UPDATE & 0xff;
	// Adjust index
	_index = _index + 4;

	// Write zero
	_command[_index++] = 0;
	_command[_index++] = 0;
	_command[_index++] = 0;
	_command[_index++] = 0;

	// Write the collection name to the command
	_index = _index + _command.write(this.collectionName, _index, 'utf8') + 1;
	_command[_index - 1] = 0;

	// Write the update flags
	_command[_index + 3] = (this.flags >> 24) & 0xff;
	_command[_index + 2] = (this.flags >> 16) & 0xff;
	_command[_index + 1] = (this.flags >> 8) & 0xff;
	_command[_index] = this.flags & 0xff;
	// Adjust index
	_index = _index + 4;

	// Document binary length
	var documentLength = 0
	var object = this.spec;

	// Serialize the selector
	// If we are passing a raw buffer, do minimal validation
	if(Buffer.isBuffer(object)) {
	var object_size = object[0] \| object[1] << 8 \| object[2] << 16 \| object[3] << 24;
	if(object_size != object.length) throw new Error("raw message size does not match message header size [" + object.length + "] != [" + object_size + "]");
	documentLength = object.length;
	// Copy the data into the current buffer
	object.copy(_command, _index);
	} else {
	documentLength = this.db.bson.serializeWithBufferAndIndex(object, this.checkKeys, _command, _index, false) - _index + 1;
	}

	// Write the length to the document
	_command[_index + 3] = (documentLength >> 24) & 0xff;
	_command[_index + 2] = (documentLength >> 16) & 0xff;
	_command[_index + 1] = (documentLength >> 8) & 0xff;
	_command[_index] = documentLength & 0xff;
	// Update index in buffer
	_index = _index + documentLength;
	// Add terminating 0 for the object
	_command[_index - 1] = 0;

	// Document binary length
	var documentLength = 0
	var object = this.document;

	// Serialize the document
	// If we are passing a raw buffer, do minimal validation
	if(Buffer.isBuffer(object)) {
	var object_size = object[0] \| object[1] << 8 \| object[2] << 16 \| object[3] << 24;
	if(object_size != object.length) throw new Error("raw message size does not match message header size [" + object.length + "] != [" + object_size + "]");
	documentLength = object.length;
	// Copy the data into the current buffer
	object.copy(_command, _index);
	} else {
	documentLength = this.db.bson.serializeWithBufferAndIndex(object, false, _command, _index, this.serializeFunctions) - _index + 1;
	}

	// Write the length to the document
	_command[_index + 3] = (documentLength >> 24) & 0xff;
	_command[_index + 2] = (documentLength >> 16) & 0xff;
	_command[_index + 1] = (documentLength >> 8) & 0xff;
	_command[_index] = documentLength & 0xff;
	// Update index in buffer
	_index = _index + documentLength;
	// Add terminating 0 for the object
	_command[_index - 1] = 0;

	return _command;
	};

	// Constants
	UpdateCommand.DB_UPSERT = 0;
	UpdateCommand.DB_MULTI_UPDATE = 1;
	</pre>
	</div>
	</div>
	</div>
	</div>
	</div>
	</div>
	</div>
	<script src="../assets/vendor/prettify/prettify-min.js"></script>
	<script>prettyPrint();</script>
	<script src="../assets/js/yui-prettify.js"></script>
	<script src="../assets/../api.js"></script>
	<script src="../assets/js/api-filter.js"></script>
	<script src="../assets/js/api-list.js"></script>
	<script src="../assets/js/api-search.js"></script>
	<script src="../assets/js/apidocs.js"></script>
	</body>
	</html>

File Metadata

Mime Type: text/html
Expires: Wed, Aug 13, 18:06 (1 d, 3 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 876804
Default Alt Text: bin_node_modules_mongodb_lib_mongodb_commands_update_command.js.html (18 KB)

bin_node_modules_mongodb_lib_mongodb_commands_update_command.js.htmlNo OneTemporaryActions

bin_node_modules_mongodb_lib_mongodb_commands_update_command.js.htmlView Options

File Metadata

Event Timeline

bin_node_modules_mongodb_lib_mongodb_commands_update_command.js.html
No OneTemporary
Actions

bin_node_modules_mongodb_lib_mongodb_commands_update_command.js.html
View Options