mongodb 2.1.0-alpha → 2.1.2

package/lib/gridfs/grid_store.js

@@ -38,13 +38,16 @@ var Chunk = require('./chunk'),
   ObjectID = require('mongodb-core').BSON.ObjectID,
   ReadPreference = require('../read_preference'),
   Buffer = require('buffer').Buffer,
+  Collection = require('../collection'),
   fs = require('fs'),
   timers = require('timers'),
   f = require('util').format,
   util = require('util'),
+  Define = require('../metadata'),
   MongoError = require('mongodb-core').MongoError,
   inherits = util.inherits,
-  Duplex = require('stream').Duplex || require('readable-stream').Duplex;
+  Duplex = require('stream').Duplex || require('readable-stream').Duplex,
+  shallowClone = require('../utils').shallowClone;
 
 var REFERENCE_BY_FILENAME = 0,
   REFERENCE_BY_ID = 1;
@@ -81,6 +84,7 @@ var REFERENCE_BY_FILENAME = 0,
  * @property {number} md5 The md5 checksum for this file.
  * @property {number} chunkNumber The current chunk number the gridstore has materialized into memory
  * @return {GridStore} a GridStore instance.
+ * @deprecated Use GridFSBucket API instead
  */
 var GridStore = function GridStore(db, id, filename, mode, options) {
   if(!(this instanceof GridStore)) return new GridStore(db, id, filename, mode, options);
@@ -125,7 +129,7 @@ var GridStore = function GridStore(db, id, filename, mode, options) {
   // Set the root if overridden
   this.root = this.options['root'] == null ? GridStore.DEFAULT_ROOT_COLLECTION : this.options['root'];
   this.position = 0;
-  this.readPreference = this.options.readPreference || ReadPreference.PRIMARY;
+  this.readPreference = this.options.readPreference || db.options.readPreference || ReadPreference.PRIMARY;
   this.writeConcern = _getWriteConcern(db, this.options);
   // Set default chunk size
   this.internalChunkSize = this.options['chunkSize'] == null ? Chunk.DEFAULT_CHUNK_SIZE : this.options['chunkSize'];
@@ -168,6 +172,8 @@ var GridStore = function GridStore(db, id, filename, mode, options) {
   });
 }
 
+var define = GridStore.define = new Define('Gridstore', GridStore, true);
+
 /**
  * The callback format for the Gridstore.open method
  * @callback GridStore~openCallback
@@ -180,13 +186,14 @@ var GridStore = function GridStore(db, id, filename, mode, options) {
  * new one if file does not exist.
  *
  * @method
- * @param {GridStore~openCallback} callback this will be called after executing this method
+ * @param {GridStore~openCallback} [callback] this will be called after executing this method
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.open = function(callback) {
   var self = this;
   if( this.mode != "w" && this.mode != "w+" && this.mode != "r"){
-    throw new MongoError("Illegal mode " + this.mode);
+    throw MongoError.create({message: "Illegal mode " + this.mode, driver:true});
   }
 
   // We provided a callback leg
@@ -197,7 +204,7 @@ GridStore.prototype.open = function(callback) {
       if(err) return reject(err);
       resolve(store);
     })
-  });  
+  });
 };
 
 var open = function(self, callback) {
@@ -212,8 +219,11 @@ var open = function(self, callback) {
     collection.ensureIndex([['filename', 1]], writeConcern, function(err, index) {
       // Get chunk collection
       var chunkCollection = self.chunkCollection();
+      // Make an unique index for compatibility with mongo-cxx-driver:legacy
+      var chunkIndexOptions = shallowClone(writeConcern);
+      chunkIndexOptions.unique = true;
       // Ensure index on chunk collection
-      chunkCollection.ensureIndex([['files_id', 1], ['n', 1]], writeConcern, function(err, index) {
+      chunkCollection.ensureIndex([['files_id', 1], ['n', 1]], chunkIndexOptions, function(err, index) {
         // Open the connection
         _open(self, writeConcern, function(err, r) {
           if(err) return callback(err);
@@ -229,19 +239,25 @@ var open = function(self, callback) {
       self.isOpen = true;
       callback(err, r);
     });
-  }  
+  }
 }
 
+// Push the definition for open
+define.classMethod('open', {callback: true, promise:true});
+
 /**
  * Verify if the file is at EOF.
  *
  * @method
  * @return {boolean} true if the read/write head is at the end of this file.
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.eof = function() {
   return this.position == this.length ? true : false;
 }
 
+define.classMethod('eof', {callback: false, promise:false, returns: [Boolean]});
+
 /**
  * The callback result format.
  * @callback GridStore~resultCallback
@@ -253,8 +269,9 @@ GridStore.prototype.eof = function() {
  * Retrieves a single character from this file.
  *
  * @method
- * @param {GridStore~resultCallback} callback this gets called after this method is executed. Passes null to the first parameter and the character read to the second or null to the second if the read/write head is at the end of the file.
+ * @param {GridStore~resultCallback} [callback] this gets called after this method is executed. Passes null to the first parameter and the character read to the second or null to the second if the read/write head is at the end of the file.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.getc = function(callback) {
   var self = this;
@@ -281,17 +298,20 @@ var eof = function(self, callback) {
   } else {
     self.position = self.position + 1;
     callback(null, self.currentChunk.getc());
-  }  
+  }
 }
 
+define.classMethod('getc', {callback: true, promise:true});
+
 /**
  * Writes a string to the file with a newline character appended at the end if
  * the given string does not have one.
  *
  * @method
  * @param {string} string the string to write.
- * @param {GridStore~resultCallback} callback this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
+ * @param {GridStore~resultCallback} [callback] this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.puts = function(string, callback) {
   var self = this;
@@ -307,24 +327,30 @@ GridStore.prototype.puts = function(string, callback) {
   });
 }
 
+define.classMethod('puts', {callback: true, promise:true});
+
 /**
  * Return a modified Readable stream including a possible transform method.
  *
  * @method
  * @return {GridStoreStream}
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.stream = function() {
   return new GridStoreStream(this);
 }
 
+define.classMethod('stream', {callback: false, promise:false, returns: [GridStoreStream]});
+
 /**
  * Writes some data. This method will work properly only if initialized with mode "w" or "w+".
  *
  * @method
  * @param {(string|Buffer)} data the data to write.
  * @param {boolean} [close] closes this file after writing if set to true.
- * @param {GridStore~resultCallback} callback this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
+ * @param {GridStore~resultCallback} [callback] this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.write = function write(data, close, callback) {
   var self = this;
@@ -339,11 +365,14 @@ GridStore.prototype.write = function write(data, close, callback) {
   });
 }
 
+define.classMethod('write', {callback: true, promise:true});
+
 /**
  * Handles the destroy part of a stream
  *
  * @method
  * @result {null}
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.destroy = function destroy() {
   // close and do not emit any more events. queued data is not sent.
@@ -356,13 +385,16 @@ GridStore.prototype.destroy = function destroy() {
   }
 }
 
+define.classMethod('destroy', {callback: false, promise:false});
+
 /**
  * Stores a file from the file system to the GridFS database.
  *
  * @method
  * @param {(string|Buffer|FileHandle)} file the file to store.
- * @param {GridStore~resultCallback} callback this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
+ * @param {GridStore~resultCallback} [callback] this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.writeFile = function (file, callback) {
   var self = this;
@@ -433,17 +465,20 @@ var writeFile = function(self, file, callback) {
       // Process the first write
       process.nextTick(writeChunk);
     });
-  });  
+  });
 }
 
+define.classMethod('writeFile', {callback: true, promise:true});
+
 /**
  * Saves this file to the database. This will overwrite the old entry if it
  * already exists. This will work properly only if mode was initialized to
  * "w" or "w+".
  *
  * @method
- * @param {GridStore~resultCallback} callback this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
+ * @param {GridStore~resultCallback} [callback] this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.close = function(callback) {
   var self = this;
@@ -472,18 +507,14 @@ var close = function(self, callback) {
 
           // Build the mongo object
           if(self.uploadDate != null) {
-            files.remove({'_id':self.fileId}, self.writeConcern, function(err, collection) {
-              if(err && typeof callback == 'function') return callback(err);
-
-              buildMongoObject(self, function(err, mongoObject) {
-                if(err) {
-                  if(typeof callback == 'function') return callback(err); else throw err;
-                }
+            buildMongoObject(self, function(err, mongoObject) {
+              if(err) {
+                if(typeof callback == 'function') return callback(err); else throw err;
+              }
 
-                files.save(mongoObject, options, function(err) {
-                  if(typeof callback == 'function')
-                    callback(err, mongoObject);
-                });
+              files.save(mongoObject, options, function(err) {
+                if(typeof callback == 'function')
+                  callback(err, mongoObject);
               });
             });
           } else {
@@ -523,10 +554,12 @@ var close = function(self, callback) {
       callback(null, null);
   } else {
     if(typeof callback == 'function')
-      callback(new MongoError(f("Illegal mode %s", self.mode), null));
-  }  
+      callback(MongoError.create({message: f("Illegal mode %s", self.mode), driver:true}));
+  }
 }
 
+define.classMethod('close', {callback: true, promise:true});
+
 /**
  * The collection callback format.
  * @callback GridStore~collectionCallback
@@ -540,6 +573,7 @@ var close = function(self, callback) {
  * @method
  * @param {GridStore~collectionCallback} callback the command callback.
  * @return {Collection}
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.chunkCollection = function(callback) {
   if(typeof callback == 'function')
@@ -547,12 +581,15 @@ GridStore.prototype.chunkCollection = function(callback) {
   return this.db.collection((this.root + ".chunks"));
 };
 
+define.classMethod('chunkCollection', {callback: true, promise:false, returns: [Collection]});
+
 /**
  * Deletes all the chunks of this file in the database.
  *
  * @method
- * @param {GridStore~resultCallback} callback the command callback.
+ * @param {GridStore~resultCallback} [callback] the command callback.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.unlink = function(callback) {
   var self = this;
@@ -584,15 +621,18 @@ var unlink = function(self, callback) {
         callback(err, self);
       });
     });
-  });  
+  });
 }
 
+define.classMethod('unlink', {callback: true, promise:true});
+
 /**
  * Retrieves the file collection associated with this object.
  *
  * @method
  * @param {GridStore~collectionCallback} callback the command callback.
  * @return {Collection}
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.collection = function(callback) {
   if(typeof callback == 'function')
@@ -600,6 +640,8 @@ GridStore.prototype.collection = function(callback) {
   return this.db.collection(this.root + ".files");
 };
 
+define.classMethod('collection', {callback: true, promise:false, returns: [Collection]});
+
 /**
  * The readlines callback format.
  * @callback GridStore~readlinesCallback
@@ -612,8 +654,9 @@ GridStore.prototype.collection = function(callback) {
  *
  * @method
  * @param {string} [separator] The character to be recognized as the newline separator.
- * @param {GridStore~readlinesCallback} callback the command callback.
+ * @param {GridStore~readlinesCallback} [callback] the command callback.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.readlines = function(separator, callback) {
   var self = this;
@@ -622,7 +665,7 @@ GridStore.prototype.readlines = function(separator, callback) {
   if(typeof callback != 'function') args.push(callback);
   separator = args.length ? args.shift() : "\n";
   separator = separator || "\n";
-  
+
   // We provided a callback leg
   if(typeof callback == 'function') return readlines(self, separator, callback);
 
@@ -646,16 +689,19 @@ var readlines = function(self, separator, callback) {
     }
 
     callback(null, items);
-  });  
+  });
 }
 
+define.classMethod('readlines', {callback: true, promise:true});
+
 /**
  * Deletes all the chunks of this file in the database if mode was set to "w" or
  * "w+" and resets the read/write head to the initial position.
  *
  * @method
- * @param {GridStore~resultCallback} callback this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
+ * @param {GridStore~resultCallback} [callback] this will be called after executing this method. The first parameter will contain null and the second one will contain a reference to this object.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.rewind = function(callback) {
   var self = this;
@@ -692,9 +738,11 @@ var rewind = function(self, callback) {
     self.currentChunk.rewind();
     self.position = 0;
     callback(null, self);
-  }  
+  }
 }
 
+define.classMethod('rewind', {callback: true, promise:true});
+
 /**
  * The read callback format.
  * @callback GridStore~readCallback
@@ -714,8 +762,9 @@ var rewind = function(self, callback) {
  * @method
  * @param {number} [length] the number of characters to read. Reads all the characters from the read/write head to the EOF if not specified.
  * @param {(string|Buffer)} [buffer] a string to hold temporary data. This is used for storing the string data read so far when recursively calling this method.
- * @param {GridStore~readCallback} callback the command callback.
+ * @param {GridStore~readCallback} [callback] the command callback.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.read = function(length, buffer, callback) {
   var self = this;
@@ -750,7 +799,7 @@ var read = function(self, length, buffer, callback) {
     // Update internal position
     self.position = self.position + finalBuffer.length;
     // Check if we don't have a file at all
-    if(finalLength == 0 && finalBuffer.length == 0) return callback(new MongoError("File does not exist"), null);
+    if(finalLength == 0 && finalBuffer.length == 0) return callback(MongoError.create({message: "File does not exist", driver:true}), null);
     // Else return data
     return callback(null, finalBuffer);
   }
@@ -773,12 +822,14 @@ var read = function(self, length, buffer, callback) {
       if(finalBuffer._index > 0) {
         callback(null, finalBuffer)
       } else {
-        callback(new MongoError("no chunks found for file, possibly corrupt"), null);
+        callback(MongoError.create({message: "no chunks found for file, possibly corrupt", driver:true}), null);
       }
     }
-  });  
+  });
 }
 
+define.classMethod('read', {callback: true, promise:true});
+
 /**
  * The tell callback format.
  * @callback GridStore~tellCallback
@@ -792,8 +843,9 @@ var read = function(self, length, buffer, callback) {
  * @method
  * @param {number} [length] the number of characters to read. Reads all the characters from the read/write head to the EOF if not specified.
  * @param {(string|Buffer)} [buffer] a string to hold temporary data. This is used for storing the string data read so far when recursively calling this method.
- * @param {GridStore~tellCallback} callback the command callback.
+ * @param {GridStore~tellCallback} [callback] the command callback.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.tell = function(callback) {
   var self = this;
@@ -805,6 +857,8 @@ GridStore.prototype.tell = function(callback) {
   });
 };
 
+define.classMethod('tell', {callback: true, promise:true});
+
 /**
  * The tell callback format.
  * @callback GridStore~gridStoreCallback
@@ -825,8 +879,9 @@ GridStore.prototype.tell = function(callback) {
  * @method
  * @param {number} [position] the position to seek to
  * @param {number} [seekLocation] seek mode. Use one of the Seek Location modes.
- * @param {GridStore~gridStoreCallback} callback the command callback.
+ * @param {GridStore~gridStoreCallback} [callback] the command callback.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.prototype.seek = function(position, seekLocation, callback) {
   var self = this;
@@ -850,7 +905,7 @@ GridStore.prototype.seek = function(position, seekLocation, callback) {
 var seek = function(self, position, seekLocation, callback) {
   // Seek only supports read mode
   if(self.mode != 'r') {
-    return callback(new MongoError("seek is only supported for mode r"))
+    return callback(MongoError.create({message: "seek is only supported for mode r", driver:true}))
   }
 
   var seekLocationFinal = seekLocation == null ? GridStore.IO_SEEK_SET : seekLocation;
@@ -870,6 +925,10 @@ var seek = function(self, position, seekLocation, callback) {
   var newChunkNumber = Math.floor(targetPosition/self.chunkSize);
   var seekChunk = function() {
     nthChunk(self, newChunkNumber, function(err, chunk) {
+      if(err) return callback(err, null);
+      if(chunk == null) return callback(new Error('no chunk found'));
+
+      // Set the current chunk
       self.currentChunk = chunk;
       self.position = targetPosition;
       self.currentChunk.position = (self.position % self.chunkSize);
@@ -877,9 +936,11 @@ var seek = function(self, position, seekLocation, callback) {
     });
   };
 
-  seekChunk();  
+  seekChunk();
 }
 
+define.classMethod('seek', {callback: true, promise:true});
+
 /**
  * @ignore
  */
@@ -913,9 +974,9 @@ var _open = function(self, options, callback) {
         self.internalChunkSize = self.internalChunkSize == null ? Chunk.DEFAULT_CHUNK_SIZE : self.internalChunkSize;
         self.length = 0;
       } else {
-         self.length = 0;
-         var txtId = self.fileId instanceof ObjectID ? self.fileId.toHexString() : self.fileId;
-         return error(new MongoError(f("file with id %s not opened for writing", (self.referenceBy == REFERENCE_BY_ID ? txtId : self.filename))), self);
+        self.length = 0;
+        var txtId = self.fileId instanceof ObjectID ? self.fileId.toHexString() : self.fileId;
+        return error(MongoError.create({message: f("file with id %s not opened for writing", (self.referenceBy == REFERENCE_BY_ID ? txtId : self.filename)), driver:true}), self);
       }
 
       // Process the mode of the object
@@ -926,7 +987,7 @@ var _open = function(self, options, callback) {
           self.position = 0;
           callback(null, self);
         });
-      } else if(self.mode == "w") {
+      } else if(self.mode == "w" && doc) {
         // Delete any existing chunks
         deleteChunks(self, options, function(err, result) {
           if(err) return error(err);
@@ -938,6 +999,14 @@ var _open = function(self, options, callback) {
           self.position = 0;
           callback(null, self);
         });
+      } else if(self.mode == "w") {
+        self.currentChunk = new Chunk(self, {'n':0}, self.writeConcern);
+        self.contentType = self.options['content_type'] == null ? self.contentType : self.options['content_type'];
+        self.internalChunkSize = self.options['chunk_size'] == null ? self.internalChunkSize : self.options['chunk_size'];
+        self.metadata = self.options['metadata'] == null ? self.metadata : self.options['metadata'];
+        self.aliases = self.options['aliases'] == null ? self.aliases : self.options['aliases'];
+        self.position = 0;
+        callback(null, self);
       } else if(self.mode == "w+") {
         nthChunk(self, lastChunkNumber(self), options, function(err, chunk) {
           if(err) return error(err);
@@ -1001,7 +1070,7 @@ var writeBuffer = function(self, buffer, close, callback) {
   var finalClose = typeof close == 'boolean' ? close : false;
 
   if(self.mode != "w") {
-    callback(new MongoError(f("file with id %s not opened for writing", (self.referenceBy == REFERENCE_BY_ID ? self.referenceBy : self.filename))), null);
+    callback(MongoError.create({message: f("file with id %s not opened for writing", (self.referenceBy == REFERENCE_BY_ID ? self.referenceBy : self.filename)), driver:true}), null);
   } else {
     if(self.currentChunk.position + buffer.length >= self.chunkSize) {
       // Write out the current Chunk and then keep writing until we have less data left than a chunkSize left
@@ -1209,8 +1278,9 @@ GridStore.IO_SEEK_END = 2;
  * @param {object} [options=null] Optional settings.
  * @param {(ReadPreference|string)} [options.readPreference=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {object} [options.promiseLibrary=null] A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
- * @param {GridStore~resultCallback} callback result from exists.
+ * @param {GridStore~resultCallback} [callback] result from exists.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.exist = function(db, fileIdObject, rootCollection, options, callback) {
   var args = Array.prototype.slice.call(arguments, 2);
@@ -1254,8 +1324,8 @@ var exists = function(db, fileIdObject, rootCollection, options, callback) {
       : {'_id':fileIdObject};    // Attempt to locate file
 
     // We have a specific query
-    if(fileIdObject != null 
-      && typeof fileIdObject == 'object' 
+    if(fileIdObject != null
+      && typeof fileIdObject == 'object'
       && Object.prototype.toString.call(fileIdObject) != '[object RegExp]') {
       query = fileIdObject;
     }
@@ -1265,9 +1335,11 @@ var exists = function(db, fileIdObject, rootCollection, options, callback) {
       if(err) return callback(err);
       callback(null, item == null ? false : true);
     });
-  });  
+  });
 }
 
+define.staticMethod('exist', {callback: true, promise:true});
+
 /**
  * Gets the list of files stored in the GridFS.
  *
@@ -1278,8 +1350,9 @@ var exists = function(db, fileIdObject, rootCollection, options, callback) {
  * @param {object} [options=null] Optional settings.
  * @param {(ReadPreference|string)} [options.readPreference=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {object} [options.promiseLibrary=null] A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
- * @param {GridStore~resultCallback} callback result from exists.
+ * @param {GridStore~resultCallback} [callback] result from exists.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.list = function(db, rootCollection, options, callback) {
   var args = Array.prototype.slice.call(arguments, 1);
@@ -1337,9 +1410,11 @@ var list = function(db, rootCollection, options, callback) {
         }
       });
     });
-  });  
+  });
 }
 
+define.staticMethod('list', {callback: true, promise:true});
+
 /**
  * Reads the contents of a file.
  *
@@ -1359,10 +1434,10 @@ var list = function(db, rootCollection, options, callback) {
  * @param {object} [options=null] Optional settings.
  * @param {(ReadPreference|string)} [options.readPreference=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {object} [options.promiseLibrary=null] A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
- * @param {GridStore~readCallback} callback the command callback.
+ * @param {GridStore~readCallback} [callback] the command callback.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
-
 GridStore.read = function(db, name, length, offset, options, callback) {
   var args = Array.prototype.slice.call(arguments, 2);
   callback = args.pop();
@@ -1408,9 +1483,11 @@ var readStatic = function(db, name, length, offset, options, callback) {
     } else {
       gridStore.read(length, callback);
     }
-  });  
+  });
 }
 
+define.staticMethod('read', {callback: true, promise:true});
+
 /**
  * Read the entire file as a list of strings splitting by the provided separator.
  *
@@ -1422,8 +1499,9 @@ var readStatic = function(db, name, length, offset, options, callback) {
  * @param {object} [options=null] Optional settings.
  * @param {(ReadPreference|string)} [options.readPreference=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {object} [options.promiseLibrary=null] A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
- * @param {GridStore~readlinesCallback} callback the command callback.
+ * @param {GridStore~readlinesCallback} [callback] the command callback.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.readlines = function(db, name, separator, options, callback) {
   var args = Array.prototype.slice.call(arguments, 2);
@@ -1458,9 +1536,11 @@ var readlinesStatic = function(db, name, separator, options, callback) {
   new GridStore(db, name, "r", options).open(function(err, gridStore) {
     if(err) return callback(err);
     gridStore.readlines(finalSeperator, callback);
-  });  
+  });
 }
 
+define.staticMethod('readlines', {callback: true, promise:true});
+
 /**
  * Deletes the chunks and metadata information of a file from GridFS.
  *
@@ -1470,8 +1550,9 @@ var readlinesStatic = function(db, name, separator, options, callback) {
  * @param {(string|array)} names The name/names of the files to delete.
  * @param {object} [options=null] Optional settings.
  * @param {object} [options.promiseLibrary=null] A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
- * @param {GridStore~resultCallback} callback the command callback.
+ * @param {GridStore~resultCallback} [callback] the command callback.
  * @return {Promise} returns Promise if no callback passed
+ * @deprecated Use GridFSBucket API instead
  */
 GridStore.unlink = function(db, names, options, callback) {
   var self = this;
@@ -1530,9 +1611,11 @@ var unlinkStatic = function(self, db, names, options, callback) {
         });
       });
     });
-  }  
+  }
 }
 
+define.staticMethod('unlink', {callback: true, promise:true});
+
 /**
  *  @ignore
  */
@@ -1583,7 +1666,7 @@ var _getWriteConcern = function(self, options) {
 
   // Ensure we don't have an invalid combination of write concerns
   if(finalOptions.w < 1
-    && (finalOptions.journal == true || finalOptions.j == true || finalOptions.fsync == true)) throw new MongoError("No acknowledgement using w < 1 cannot be combined with journal:true or fsync:true");
+    && (finalOptions.journal == true || finalOptions.j == true || finalOptions.fsync == true)) throw MongoError.create({message: "No acknowledgement using w < 1 cannot be combined with journal:true or fsync:true", driver:true});
 
   // Return the options
   return finalOptions;
@@ -1595,6 +1678,7 @@ var _getWriteConcern = function(self, options) {
  * @class
  * @extends external:Duplex
  * @return {GridStoreStream} a GridStoreStream instance.
+ * @deprecated Use GridFSBucket API instead
  */
 var GridStoreStream = function(gs) {
   var self = this;
@@ -1631,8 +1715,10 @@ GridStoreStream.prototype.pipe = function(destination) {
     });
   } else {
     self.totalBytesToRead = self.gs.length - self.gs.position;
-    self._pipe.apply(self, [destination]);    
+    self._pipe.apply(self, [destination]);
   }
+
+  return destination;
 }
 
 // Called by stream
@@ -1659,7 +1745,7 @@ GridStoreStream.prototype._read = function(n) {
       if(self.totalBytesToRead <= 0) {
         self.endCalled = true;
       }
-    });    
+    });
   }
 
   // Set read length
@@ -1684,7 +1770,7 @@ GridStoreStream.prototype.destroy = function() {
 
 GridStoreStream.prototype.write = function(chunk, encoding, callback) {
   var self = this;
-  if(self.endCalled) return self.emit('error', new MongoError('attempting to write to stream after end called'))
+  if(self.endCalled) return self.emit('error', MongoError.create({message: 'attempting to write to stream after end called', driver:true}))
   // Do we have to open the gridstore
   if(!self.gs.isOpen) {
     self.gs.open(function() {