mongodb-driver v0.5.2 Mongo.GridFs.Bucket View Source

The bucket has some configuration options:

  • :chunk_size - The chunk size in bytes. Defaults to 255*1024
  • :name - The bucket name. Defaults to fs

The bucket checks whether the indexes already exist before attempting to create them. The names of the created indexes are "filename_1_uploadDate_1" and "files_id_1_n_1"

Link to this section Summary

Functions

Returns the collection name for the chunks collection, default is fs.chunks.

Given a id, delete this stored file’s files collection document and associated chunks from a GridFS bucket.

Drops the files and chunks collections associated with this bucket.

Returns the collection name for the files collection, default is fs.files.

Returns a cursor from the fs.files collection.

Finds one file document with the file_id as an ObjectID-struct

Creates a new Bucket with a existing connection using the default values. It just contains the name of the collections (fs) and the chunk size (255KB).

Renames the stored file with the specified file_id.

Link to this section Types

Link to this type

t() View Source
t() :: %Mongo.GridFs.Bucket{
  chunk_size: non_neg_integer(),
  name: String.t(),
  opts: term(),
  topology_pid: GenServer.server()
}

Link to this section Functions

Link to this function

chunks_collection_name(bucket) View Source
chunks_collection_name(Mongo.GridFs.Bucket.t()) :: String.t()

Returns the collection name for the chunks collection, default is fs.chunks.

Link to this function

delete(bucket, file_id) View Source
delete(Mongo.GridFs.Bucket.t(), String.t()) ::
  {:ok, %Mongo.DeleteResult{acknowledged: term(), deleted_count: term()}}
delete(Mongo.GridFs.Bucket.t(), BSON.ObjectId.t()) ::
  {:ok, %Mongo.DeleteResult{acknowledged: term(), deleted_count: term()}}

Given a id, delete this stored file’s files collection document and associated chunks from a GridFS bucket.

Drops the files and chunks collections associated with this bucket.

Link to this function

files_collection_name(bucket) View Source
files_collection_name(Mongo.GridFs.Bucket.t()) :: String.t()

Returns the collection name for the files collection, default is fs.files.

Returns a cursor from the fs.files collection.

Finds one file document with the file_id as an ObjectID-struct

Creates a new Bucket with a existing connection using the default values. It just contains the name of the collections (fs) and the chunk size (255KB).

The bucket checks the index for both collections as well. In case of multiple upload or downloads just create only one bucket and reuse it.

Renames the stored file with the specified file_id.