Class Mongo::Grid
In: lib/mongo/gridfs/grid.rb
Parent: Object

Implementation of the MongoDB GridFS specification. A file store.

Methods

delete   get   new   put  

Included Modules

GridExt::InstanceMethods

Constants

DEFAULT_FS_NAME = 'fs'

Public Class methods

Initialize a new Grid instance, consisting of a MongoDB database and a filesystem prefix if not using the default.

@core gridfs

@see GridFileSystem

Public Instance methods

Delete a file from the store.

Note that deleting a GridFS file can result in read errors if another process is attempting to read a file while it‘s being deleted. While the odds for this kind of race condition are small, it‘s important to be aware of.

@param [] id

@return [Boolean]

Read a file from the file store.

@param [] id the file‘s unique id.

@return [Mongo::GridIO]

Store a file in the file store. This method is designed only for writing new files; if you need to update a given file, first delete it using Grid#delete.

Note that arbitrary metadata attributes can be saved to the file by passing them in as options.

@param [String, read] data a string or io-like object to store.

@option opts [String] :filename (nil) a name for the file. @option opts [Hash] :metadata ({}) any additional data to store with the file. @option opts [ObjectId] :_id (ObjectId) a unique id for

  the file to be use in lieu of an automatically generated one.

@option opts [String] :content_type (‘binary/octet-stream’) If no content type is specified,

  the content type will may be inferred from the filename extension if the mime-types gem can be
  loaded. Otherwise, the content type 'binary/octet-stream' will be used.

@option opts [Integer] (262144) :chunk_size size of file chunks in bytes. @option opts [String, Integer, Symbol] :w (1) Set write concern

  Notes on write concern:
     When :w > 0, the chunks sent to the server are validated using an md5 hash.
     If validation fails, an exception will be raised.

@return [BSON::ObjectId] the file‘s id.

[Validate]