GridFSBucket Class

Represents a GridFS bucket.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.GridFSGridFSBucketObjectId
MongoDB.Driver.GridFSGridFSBucket

Namespace: MongoDB.Driver.GridFS
Assembly: MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4

Syntax

Copy

public class GridFSBucket : GridFSBucket<ObjectId>, 
	IGridFSBucket, IGridFSBucket<ObjectId>

Public Class GridFSBucket
	Inherits GridFSBucket(Of ObjectId)
	Implements IGridFSBucket, IGridFSBucket(Of ObjectId)

type GridFSBucket =  
    class
        inherit GridFSBucket<ObjectId>
        interface IGridFSBucket
        interface IGridFSBucket<ObjectId>
    end

The GridFSBucket type exposes the following members.

Constructors

	Name	Description
	GridFSBucket	Initializes a new instance of the GridFSBucket class.

Top

Properties

	Name	Description
	Database	Gets the database where the GridFS files are stored. (Inherited from GridFSBucketTFileId.)
	Options	Gets the options. (Inherited from GridFSBucketTFileId.)

Top

Methods

	Name	Description
	Delete(BsonValue, CancellationToken)	Deletes a file from GridFS.
	Delete(TFileId, CancellationToken)	Deletes a file from GridFS. (Inherited from GridFSBucketTFileId.)
	DeleteAsync(BsonValue, CancellationToken)	Deletes a file from GridFS.
	DeleteAsync(TFileId, CancellationToken)	Deletes a file from GridFS. (Inherited from GridFSBucketTFileId.)
	DownloadAsBytes(BsonValue, GridFSDownloadOptions, CancellationToken)	Downloads a file stored in GridFS and returns it as a byte array.
	DownloadAsBytes(TFileId, GridFSDownloadOptions, CancellationToken)	Downloads a file stored in GridFS and returns it as a byte array. (Inherited from GridFSBucketTFileId.)
	DownloadAsBytesAsync(BsonValue, GridFSDownloadOptions, CancellationToken)	Downloads a file stored in GridFS and returns it as a byte array.
	DownloadAsBytesAsync(TFileId, GridFSDownloadOptions, CancellationToken)	Downloads a file stored in GridFS and returns it as a byte array. (Inherited from GridFSBucketTFileId.)
	DownloadAsBytesByName	Downloads a file stored in GridFS and returns it as a byte array. (Inherited from GridFSBucketTFileId.)
	DownloadAsBytesByNameAsync	Downloads a file stored in GridFS and returns it as a byte array. (Inherited from GridFSBucketTFileId.)
	DownloadToStream(BsonValue, Stream, GridFSDownloadOptions, CancellationToken)	Downloads a file stored in GridFS and writes the contents to a stream.
	DownloadToStream(TFileId, Stream, GridFSDownloadOptions, CancellationToken)	Downloads a file stored in GridFS and writes the contents to a stream. (Inherited from GridFSBucketTFileId.)
	DownloadToStreamAsync(BsonValue, Stream, GridFSDownloadOptions, CancellationToken)	Downloads a file stored in GridFS and writes the contents to a stream.
	DownloadToStreamAsync(TFileId, Stream, GridFSDownloadOptions, CancellationToken)	Downloads a file stored in GridFS and writes the contents to a stream. (Inherited from GridFSBucketTFileId.)
	DownloadToStreamByName	Downloads a file stored in GridFS and writes the contents to a stream. (Inherited from GridFSBucketTFileId.)
	DownloadToStreamByNameAsync	Downloads a file stored in GridFS and writes the contents to a stream. (Inherited from GridFSBucketTFileId.)
	Drop	Drops the files and chunks collections associated with this GridFS bucket. (Inherited from GridFSBucketTFileId.)
	DropAsync	Drops the files and chunks collections associated with this GridFS bucket. (Inherited from GridFSBucketTFileId.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Find(FilterDefinitionGridFSFileInfo, GridFSFindOptions, CancellationToken)	Finds matching entries from the files collection.
	Find(FilterDefinitionGridFSFileInfoTFileId, GridFSFindOptionsTFileId, CancellationToken)	Finds matching entries from the files collection. (Inherited from GridFSBucketTFileId.)
	FindAsync(FilterDefinitionGridFSFileInfo, GridFSFindOptions, CancellationToken)	Finds matching entries from the files collection.
	FindAsync(FilterDefinitionGridFSFileInfoTFileId, GridFSFindOptionsTFileId, CancellationToken)	Finds matching entries from the files collection. (Inherited from GridFSBucketTFileId.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OpenDownloadStream(BsonValue, GridFSDownloadOptions, CancellationToken)	Opens a Stream that can be used by the application to read data from a GridFS file.
	OpenDownloadStream(TFileId, GridFSDownloadOptions, CancellationToken)	Opens a Stream that can be used by the application to read data from a GridFS file. (Inherited from GridFSBucketTFileId.)
	OpenDownloadStreamAsync(BsonValue, GridFSDownloadOptions, CancellationToken)	Opens a Stream that can be used by the application to read data from a GridFS file.
	OpenDownloadStreamAsync(TFileId, GridFSDownloadOptions, CancellationToken)	Opens a Stream that can be used by the application to read data from a GridFS file. (Inherited from GridFSBucketTFileId.)
	OpenDownloadStreamByName	Opens a Stream that can be used by the application to read data from a GridFS file. (Inherited from GridFSBucketTFileId.)
	OpenDownloadStreamByNameAsync	Opens a Stream that can be used by the application to read data from a GridFS file. (Inherited from GridFSBucketTFileId.)
	OpenUploadStream(String, GridFSUploadOptions, CancellationToken)	Opens a Stream that can be used by the application to write data to a GridFS file.
	OpenUploadStream(TFileId, String, GridFSUploadOptions, CancellationToken)	Opens a Stream that can be used by the application to write data to a GridFS file. (Inherited from GridFSBucketTFileId.)
	OpenUploadStreamAsync(String, GridFSUploadOptions, CancellationToken)	Opens a Stream that can be used by the application to write data to a GridFS file.
	OpenUploadStreamAsync(TFileId, String, GridFSUploadOptions, CancellationToken)	Opens a Stream that can be used by the application to write data to a GridFS file. (Inherited from GridFSBucketTFileId.)
	Rename(BsonValue, String, CancellationToken)	Renames a GridFS file.
	Rename(TFileId, String, CancellationToken)	Renames a GridFS file. (Inherited from GridFSBucketTFileId.)
	RenameAsync(BsonValue, String, CancellationToken)	Renames a GridFS file.
	RenameAsync(TFileId, String, CancellationToken)	Renames a GridFS file. (Inherited from GridFSBucketTFileId.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UploadFromBytes(String, Byte, GridFSUploadOptions, CancellationToken)	Uploads a file (or a new revision of a file) to GridFS.
	UploadFromBytes(TFileId, String, Byte, GridFSUploadOptions, CancellationToken)	Uploads a file (or a new revision of a file) to GridFS. (Inherited from GridFSBucketTFileId.)
	UploadFromBytesAsync(String, Byte, GridFSUploadOptions, CancellationToken)	Uploads a file (or a new revision of a file) to GridFS.
	UploadFromBytesAsync(TFileId, String, Byte, GridFSUploadOptions, CancellationToken)	Uploads a file (or a new revision of a file) to GridFS. (Inherited from GridFSBucketTFileId.)
	UploadFromStream(String, Stream, GridFSUploadOptions, CancellationToken)	Uploads a file (or a new revision of a file) to GridFS.
	UploadFromStream(TFileId, String, Stream, GridFSUploadOptions, CancellationToken)	Uploads a file (or a new revision of a file) to GridFS. (Inherited from GridFSBucketTFileId.)
	UploadFromStreamAsync(String, Stream, GridFSUploadOptions, CancellationToken)	Uploads a file (or a new revision of a file) to GridFS.
	UploadFromStreamAsync(TFileId, String, Stream, GridFSUploadOptions, CancellationToken)	Uploads a file (or a new revision of a file) to GridFS. (Inherited from GridFSBucketTFileId.)

Top

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver.GridFS Namespace