Allow usage of schema reserved keywords

benchmarks/benchjs/multiop.js

@@ -377,7 +377,7 @@ mongoose.connect('mongodb://localhost/mongoose-bench', function(err) {
               res.author = 'soemthing new';
               res.comments.push(commentData);
               res.title = 'something newerrrr';
-              res.save(function(err) {
+              res.$save(function(err) {
                 if (err) {
                   throw err;
                 }
@@ -413,7 +413,7 @@ mongoose.connect('mongodb://localhost/mongoose-bench', function(err) {
               bp.author = 'soemthing new';
               bp.comments.push(commentData);
               bp.title = 'something newerrrr';
-              blogpost.save(bp, function(err) {
+              blogpost.$save(bp, function(err) {
                 if (err) {
                   throw err;
                 }

benchmarks/benchjs/update.js

@@ -207,7 +207,7 @@ mongoose.connect('mongodb://localhost/mongoose-bench', function(err) {
           // The driver will send the full document, while mongoose will check
           // and only update fields that have been changed. This is meant to
           // illustrate that difference between the two
-          bp.save(function(err) {
+          bp.$save(function(err) {
             if (err) {
               throw err;
             }
@@ -225,7 +225,7 @@ mongoose.connect('mongodb://localhost/mongoose-bench', function(err) {
           bp.comments[3].title = 'this is a new title';
           bp.comments[0].date = new Date();
           bp.comments.push(commentData);
-          blogpost.save(bp, function(err) {
+          blogpost.$save(bp, function(err) {
             if (err) {
               throw err;
             }
@@ -266,7 +266,7 @@ mongoose.connect('mongodb://localhost/mongoose-bench', function(err) {
       fn: function(deferred) {
         testBp.comments.push(commentData);
         testBp.comments.$shift();
-        testBp.save(function(err) {
+        testBp.$save(function(err) {
           if (err) {
             throw err;
           }
@@ -340,7 +340,7 @@ mongoose.connect('mongodb://localhost/mongoose-bench', function(err) {
       for (let i = 0; i < 100; i++) {
         testBp.comments.push(commentData);
       }
-      testBp.save(function(err) {
+      testBp.$save(function(err) {
         if (err) {
           throw err;
         }

benchmarks/mem.js

@@ -138,7 +138,7 @@ function cycle() {
     docs: [{title: 'yo'}, {title: 'nowafasdi0fas asjkdfla fa'}]
   });
 
-  a.save(function() {
+  a.$save(function() {
     methods[Math.random() * methods.length | 0](a, function() {
       a = null;
       process.nextTick(cycle);

benchmarks/populate.js

@@ -34,7 +34,7 @@ mongoose.connect('localhost', 'benchmark-populate', function(err) {
         as: [a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a],
         a: a,
         nested: [{a: a}, {a: a}, {a: a}, {a: a}, {a: a}, {a: a}]
-      }).save(function(err) {
+      }).$save(function(err) {
         if (err) {
           return done(err);
         }

docs/search.js

@@ -118,7 +118,7 @@ async function run() {
 
   await Content.deleteMany({});
   for (const content of contents) {
-    await content.save();
+    await content.$save();
   }
 
   const results = await Content.

examples/redis-todo/db/models/userModel.js

@@ -32,7 +32,7 @@ userSchema.methods.genAuthToken = function() {
 // password hasing
 userPasswordSchema.pre('save', async function(next) {
   try {
-    if (this.isModified('password')) {
+    if (this.$isModified('password')) {
       this.password = await bcrypt.hashSync(this.password, 8);
       return next();
     }

examples/redis-todo/routers/todoRouter.js

@@ -27,7 +27,7 @@ Router.get('/all', auth, async function({ userId }, res) {
 Router.post('/create', auth, clearCache, async function({ userId, body }, res) {
   try {
     const todo = new Todo({ ...body, userId });
-    await todo.save();
+    await todo.$save();
     res.status(201).json({ todo });
   } catch (err) {
     res.status(501).send('Server Error: ' + err);
@@ -46,7 +46,7 @@ Router.post('/update', auth, async function({ userId, body }, res) {
     );
     if (!updatedTodo) return res.status(404).send({ msg: 'Todo not found' });
 
-    await updatedTodo.save();
+    await updatedTodo.$save();
     res.status(200).json({ todo: updatedTodo });
   } catch (err) {
     res.status(501).send('Server Error: ' + err);

examples/redis-todo/routers/userRouter.js

@@ -21,8 +21,8 @@ Router.post('/create', async function({ body }, res) {
     const token = await user.genAuthToken();
 
     // hashing password
-    await password.save();
-    await user.save();
+    await password.$save();
+    await user.$save();
     res.status(201).json({ token });
   } catch (err) {
     console.log(err);
@@ -68,7 +68,7 @@ Router.post('/update', auth, async function({ userId, body }, res) {
     if (body.password) {
       const password = await Password.findById({ _id: updatedUser.passwordId });
       password.password = body.password;
-      password.save(); // hashing password
+      password.$save(); // hashing password
     }
 
     res.status(200).json({ user: updatedUser });

lib/connection.js

@@ -451,7 +451,7 @@ Connection.prototype.startSession = _wrapConnHelper(function startSession(option
  *     const doc = new Person({ name: 'Will Riker' });
  *     await db.transaction(async function setRank(session) {
  *       doc.rank = 'Captain';
- *       await doc.save({ session });
+ *       await doc.$save({ session });
  *       doc.isNew; // false
  *
  *       // Throw an error to abort the transaction

lib/cursor/QueryCursor.js

@@ -205,7 +205,7 @@ QueryCursor.prototype.next = function(callback) {
  *       cursor().
  *       eachAsync(async function (doc, i) {
  *         doc.foo = doc.bar + i;
- *         await doc.save();
+ *         await doc.$save();
  *       })
  *
  * @param {Function} fn

lib/document.js

@@ -302,7 +302,7 @@ Document.prototype.errors;
  *     const doc = new Model({ name: 'test' });
  *     doc.$op; // null
  *
- *     const promise = doc.save();
+ *     const promise = doc.$save();
  *     doc.$op; // 'save'
  *
  *     await promise;
@@ -708,7 +708,7 @@ function init(self, obj, doc, opts, prefix) {
         }
       }
       // mark as hydrated
-      if (!self.isModified(path)) {
+      if (!self.$isModified(path)) {
         self.$__.activePaths.init(path);
       }
     }
@@ -1686,7 +1686,7 @@ Document.prototype.$__path = function(path) {
  *
  *     doc.mixed.type = 'changed';
  *     doc.markModified('mixed.type');
- *     doc.save() // changes to mixed.type are now persisted
+ *     doc.$save() // changes to mixed.type are now persisted
  *
  * @param {String} path the path to mark modified
  * @param {Document} [scope] the scope to run validators with
@@ -1707,7 +1707,7 @@ Document.prototype.markModified = function(path, scope) {
  *
  *     doc.foo = 'bar';
  *     doc.unmarkModified('foo');
- *     doc.save(); // changes to foo will not be persisted
+ *     doc.$save(); // changes to foo will not be persisted
  *
  * @param {String} path the path to unmark modified
  * @api public
@@ -1725,7 +1725,7 @@ Document.prototype.unmarkModified = function(path) {
  *
  *     doc.foo = null;
  *     doc.$ignore('foo');
- *     doc.save(); // changes to foo will not be persisted and validators won't be run
+ *     doc.$save(); // changes to foo will not be persisted and validators won't be run
  *
  * @memberOf Document
  * @instance
@@ -1896,10 +1896,10 @@ Document.prototype[documentModifiedPaths] = Document.prototype.modifiedPaths;
  * ####Example
  *
  *     doc.set('documents.0.title', 'changed');
- *     doc.isModified()                      // true
- *     doc.isModified('documents')           // true
- *     doc.isModified('documents.0.title')   // true
- *     doc.isModified('documents otherProp') // true
+ *     doc.$isModified()                      // true
+ *     doc.$isModified('documents')           // true
+ *     doc.$isModified('documents.0.title')   // true
+ *     doc.$isModified('documents otherProp') // true
  *     doc.isDirectModified('documents')     // false
  *
  * @param {String} [path] optional
@@ -1928,6 +1928,8 @@ Document.prototype.isModified = function(paths, modifiedPaths) {
   return this.$__.activePaths.some('modify');
 };
 
+Document.prototype.$isModified = Document.prototype.isModified;
+
 Document.prototype[documentIsModified] = Document.prototype.isModified;
 
 /**
@@ -2201,7 +2203,7 @@ Document.prototype.isDirectSelected = function isDirectSelected(path) {
  *
  * ####Example:
  *
- *     doc.validate(function (err) {
+ *     doc.$validate(function (err) {
  *       if (err) handleError(err);
  *       else // validation passed
  *     });
@@ -2266,6 +2268,8 @@ Document.prototype.validate = function(pathsToValidate, options, callback) {
   }, this.constructor.events);
 };
 
+Document.prototype.$validate = Document.prototype.validate;
+
 /*!
  * ignore
  */
@@ -2290,7 +2294,7 @@ function _getPathsToValidate(doc) {
   _evaluateRequiredFunctions(doc);
   // only validate required fields when necessary
   let paths = new Set(Object.keys(doc.$__.activePaths.states.require).filter(function(path) {
-    if (!doc.$__isSelected(path) && !doc.isModified(path)) {
+    if (!doc.$__isSelected(path) && !doc.$isModified(path)) {
       return false;
     }
     if (path in doc.$__.cachedRequired) {
@@ -2317,7 +2321,7 @@ function _getPathsToValidate(doc) {
         }
       }
 
-      if (doc.isModified(subdoc.$basePath, modifiedPaths) &&
+      if (doc.$isModified(subdoc.$basePath, modifiedPaths) &&
             !doc.isDirectModified(subdoc.$basePath) &&
             !doc.$isDefault(subdoc.$basePath)) {
         paths.add(subdoc.$basePath);
@@ -2433,7 +2437,7 @@ Document.prototype.$__validate = function(pathsToValidate, options, callback) {
       // Remove any validation errors that aren't from modified paths
       const errors = Object.keys(validationError.errors);
       for (const errPath of errors) {
-        if (!this.isModified(errPath)) {
+        if (!this.$isModified(errPath)) {
           delete validationError.errors[errPath];
         }
       }
@@ -2463,7 +2467,7 @@ Document.prototype.$__validate = function(pathsToValidate, options, callback) {
   // only validate required fields when necessary
   const pathDetails = _getPathsToValidate(this);
   let paths = shouldValidateModifiedOnly ?
-    pathDetails[0].filter((path) => this.isModified(path)) :
+    pathDetails[0].filter((path) => this.$isModified(path)) :
     pathDetails[0];
   const skipSchemaValidators = pathDetails[1];
   if (typeof pathsToValidate === 'string') {
@@ -2662,7 +2666,7 @@ Document.prototype.validateSync = function(pathsToValidate, options) {
   // only validate required fields when necessary
   const pathDetails = _getPathsToValidate(this);
   let paths = shouldValidateModifiedOnly ?
-    pathDetails[0].filter((path) => this.isModified(path)) :
+    pathDetails[0].filter((path) => this.$isModified(path)) :
     pathDetails[0];
   const skipSchemaValidators = pathDetails[1];
 
@@ -2731,7 +2735,7 @@ Document.prototype.validateSync = function(pathsToValidate, options) {
  *
  *     doc.invalidate('size', 'must be less than 20', 14);
 
- *     doc.validate(function (err) {
+ *     doc.$validate(function (err) {
  *       console.log(err)
  *       // prints
  *       { message: 'Validation failed',
@@ -2850,14 +2854,14 @@ function _checkImmutableSubpaths(subdoc, schematype, priorVal) {
  * ####Example:
  *
  *     product.sold = Date.now();
- *     product = await product.save();
+ *     product = await product.$save();
  *
  * If save is successful, the returned promise will fulfill with the document
  * saved.
  *
  * ####Example:
  *
- *     const newProduct = await product.save();
+ *     const newProduct = await product.$save();
  *     newProduct === product; // true
  *
  * @param {Object} [options] options optional options
@@ -4163,7 +4167,7 @@ Document.prototype.$__fullPath = function(path) {
  *
  *     user.getChanges(); // { $set: { age: 26 }, { $unset: { country: 1 } } }
  *
- *     await user.save();
+ *     await user.$save();
  *
  *     user.getChanges(); // { }
  *

lib/error/divergentArray.js

@@ -13,7 +13,7 @@ class DivergentArrayError extends MongooseError {
    * @param {Array<String>} paths
    */
   constructor(paths) {
-    const msg = 'For your own good, using `document.save()` to update an array '
+    const msg = 'For your own good, using `document.$save()` to update an array '
             + 'which was selected using an $elemMatch projection OR '
             + 'populated using skip, limit, query conditions, or exclusion of '
             + 'the _id field when the operation results in a $pop or $set of '

lib/helpers/model/castBulkWrite.js

@@ -27,7 +27,7 @@ module.exports = function castBulkWrite(originalModel, op, options) {
         doc.$session(options.session);
       }
       op['insertOne']['document'] = doc;
-      op['insertOne']['document'].validate({ __noPromise: true }, function(error) {
+      op['insertOne']['document'].$validate({ __noPromise: true }, function(error) {
         if (error) {
           return callback(error, null);
         }
@@ -154,7 +154,7 @@ module.exports = function castBulkWrite(originalModel, op, options) {
       }
       op['replaceOne']['replacement'] = doc;
 
-      op['replaceOne']['replacement'].validate({ __noPromise: true }, function(error) {
+      op['replaceOne']['replacement'].$validate({ __noPromise: true }, function(error) {
         if (error) {
           return callback(error, null);
         }

lib/helpers/timestamps/setupTimestamps.js

@@ -53,7 +53,7 @@ module.exports = function setupTimestamps(schema, timestamps) {
       this.$set(createdAt, auto_id ? this._id.getTimestamp() : defaultTimestamp);
     }
 
-    if (!skipUpdatedAt && updatedAt && (this.isNew || this.isModified())) {
+    if (!skipUpdatedAt && updatedAt && (this.isNew || this.$isModified())) {
       let ts = defaultTimestamp;
       if (this.isNew) {
         if (createdAt != null) {

lib/helpers/updateValidators.js

@@ -22,7 +22,6 @@ const modifiedPaths = require('./common').modifiedPaths;
  */
 
 module.exports = function(query, schema, castedDoc, options, callback) {
-  let _keys;
   const keys = Object.keys(castedDoc || {});
   let updatedKeys = {};
   let updatedValues = {};
@@ -39,7 +38,7 @@ module.exports = function(query, schema, castedDoc, options, callback) {
     if (keys[i].startsWith('$')) {
       hasDollarUpdate = true;
       if (keys[i] === '$push' || keys[i] === '$addToSet') {
-        _keys = Object.keys(castedDoc[keys[i]]);
+        const _keys = Object.keys(castedDoc[keys[i]]);
         for (let ii = 0; ii < _keys.length; ++ii) {
           currentUpdate = castedDoc[keys[i]][_keys[ii]];
           if (currentUpdate && currentUpdate.$each) {