Create the GridFS.

@example Create the GridFS.

  Grid::FSBucket.new(database)

@param [ Database ] database The database the files reside in. @param [ Hash ] options The GridFS options.

@option options [ String ] :fs_name The prefix for the files and chunks

  collections.

@option options [ String ] :bucket_name The prefix for the files and chunks

  collections.

@option options [ Integer ] :chunk_size Override the default chunk

  size.

@option options [ String ] :write The write concern. @option options [ String ] :read The read preference.

@since 2.0.0

Remove a single file, identified by its id from the GridFS.

@example Remove a file from the GridFS.

  fs.delete(id)

@param [ BSON::ObjectId, Object ] id The id of the file to remove.

@return [ Result ] The result of the remove.

@raise [ Error::FileNotFound ] If the file is not found.

@since 2.1.0

Remove a single file from the GridFS.

@example Remove a file from the GridFS.

  fs.delete_one(file)

@param [ Grid::File ] file The file to remove.

@return [ Result ] The result of the remove.

@since 2.0.0

Downloads the contents of the file specified by id and writes them to the destination io object.

@example Download the file and write it to the io object.

  fs.download_to_stream(id, io)

@param [ BSON::ObjectId, Object ] id The id of the file to read. @param [ IO ] io The io object to write to.

@since 2.1.0

Downloads the contents of the stored file specified by filename and by the revision in options and writes the contents to the destination io object.

Revision numbers are defined as follows: 0 = the original stored file 1 = the first revision 2 = the second revision etc… -2 = the second most recent revision -1 = the most recent revision

@example Download the most recent revision.

  fs.download_to_stream_by_name('some-file.txt', io)

# @example Download the original file.

  fs.download_to_stream_by_name('some-file.txt', io, revision: 0)

@example Download the second revision of the stored file.

  fs.download_to_stream_by_name('some-file.txt', io, revision: 2)

@param [ String ] filename The file‘s name. @param [ IO ] io The io object to write to. @param [ Hash ] opts Options for the download.

@option opts [ Integer ] :revision The revision number of the file to download.

  Defaults to -1, the most recent version.

@raise [ Error::FileNotFound ] If the file is not found. @raise [ Error::InvalidFileRevision ] If the requested revision is not found for the file.

@since 2.1.0

Find files collection documents matching a given selector.

@example Find files collection documents by a filename.

  fs.find(filename: 'file.txt')

@param [ Hash ] selector The selector to use in the find. @param [ Hash ] options The options for the find.

@option options [ Integer ] :batch_size The number of documents returned in each batch

  of results from MongoDB.

@option options [ Integer ] :limit The max number of docs to return from the query. @option options [ true, false ] :no_cursor_timeout The server normally times out idle

  cursors after an inactivity period (10 minutes) to prevent excess memory use.
  Set this option to prevent that.

@option options [ Integer ] :skip The number of docs to skip before returning results. @option options [ Hash ] :sort The key and direction pairs by which the result set

  will be sorted.

@return [ CollectionView ] The collection view.

@since 2.1.0

Find a file in the GridFS.

@example Find a file by its id.

  fs.find_one(_id: id)

@example Find a file by its filename.

  fs.find_one(filename: 'test.txt')

@param [ Hash ] selector The selector.

@return [ Grid::File ] The file.

@since 2.0.0

@deprecated Please use find instead with a limit of -1.

  Will be removed in version 3.0.

Insert a single file into the GridFS.

@example Insert a single file.

  fs.insert_one(file)

@param [ Grid::File ] file The file to insert.

@return [ BSON::ObjectId ] The file id.

@since 2.0.0

@deprecated Please use upload_from_stream or open_upload_stream instead.

  Will be removed in version 3.0.

Opens a stream from which a file can be downloaded, specified by id.

@example Open a stream from which a file can be downloaded.

  fs.open_download_stream(id)

@param [ BSON::ObjectId, Object ] id The id of the file to read.

@return [ Stream::Read ] The stream to read from.

@yieldparam [ Hash ] The read stream.

@since 2.1.0

Opens a stream from which the application can read the contents of the stored file specified by filename and the revision in options.

Revision numbers are defined as follows: 0 = the original stored file 1 = the first revision 2 = the second revision etc… -2 = the second most recent revision -1 = the most recent revision

@example Open a stream to download the most recent revision.

  fs.open_download_stream_by_name('some-file.txt')

# @example Open a stream to download the original file.

  fs.open_download_stream_by_name('some-file.txt', revision: 0)

@example Open a stream to download the second revision of the stored file.

  fs.open_download_stream_by_name('some-file.txt', revision: 2)

@param [ String ] filename The file‘s name. @param [ Hash ] opts Options for the download.

@option opts [ Integer ] :revision The revision number of the file to download.

  Defaults to -1, the most recent version.

@return [ Stream::Read ] The stream to read from.

@raise [ Error::FileNotFound ] If the file is not found. @raise [ Error::InvalidFileRevision ] If the requested revision is not found for the file.

@yieldparam [ Hash ] The read stream.

@since 2.1.0

Opens an upload stream to GridFS to which the contents of a user file came be written.

@example Open a stream to which the contents of a file came be written.

  fs.open_upload_stream('a-file.txt')

@param [ String ] filename The filename of the file to upload. @param [ Hash ] opts The options for the write stream.

@option opts [ Object ] :file_id An optional unique file id. An ObjectId is generated otherwise. @option opts [ Integer ] :chunk_size Override the default chunk size. @option opts [ Hash ] :write The write concern. @option opts [ Hash ] :metadata User data for the ‘metadata’ field of the files

  collection document.

@option opts [ String ] :content_type The content type of the file.

  Deprecated, please use the metadata document instead.

@option opts [ Array<String> ] :aliases A list of aliases.

  Deprecated, please use the metadata document instead.

@return [ Stream::Write ] The write stream.

@yieldparam [ Hash ] The write stream.

@since 2.1.0

Get the prefix for the GridFS

@example Get the prefix.

  fs.prefix

@return [ String ] The GridFS prefix.

@since 2.0.0

Get the read preference.

@example Get the read preference.

  fs.read_preference

@return [ Mongo::ServerSelector ] The read preference.

@since 2.1.0

Uploads a user file to a GridFS bucket. Reads the contents of the user file from the source stream and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for the filename in the files collection.

@example Upload a file to the GridFS bucket.

  fs.upload_from_stream('a-file.txt', file)

@param [ String ] filename The filename of the file to upload. @param [ IO ] io The source io stream to upload from. @param [ Hash ] opts The options for the write stream.

@option opts [ Object ] :file_id An optional unique file id. An ObjectId is generated otherwise. @option opts [ Integer ] :chunk_size Override the default chunk size. @option opts [ Hash ] :write The write concern. @option opts [ Hash ] :metadata User data for the ‘metadata’ field of the files

  collection document.

@option opts [ String ] :content_type The content type of the file. Deprecated, please

  use the metadata document instead.

@option opts [ Array<String> ] :aliases A list of aliases. Deprecated, please use the

  metadata document instead.

@return [ BSON::ObjectId ] The ObjectId file id.

@since 2.1.0

Get the write concern.

@example Get the write concern.

  stream.write_concern

@return [ Mongo::WriteConcern ] The write concern.

@since 2.1.0