Class MongoGridFSFileInfo

Namespace

MongoDB.Driver.GridFS

Assembly

MongoDB.Driver.Legacy.dll

Represents information about a GridFS file (patterned after .NET's FileInfo class).

public class MongoGridFSFileInfo : IEquatable<MongoGridFSFileInfo>

Inheritance

object

MongoGridFSFileInfo

Implements

IEquatable<MongoGridFSFileInfo>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

LinqToMongo.In<TSource>(TSource, IEnumerable<TSource>)

Constructors

MongoGridFSFileInfo(MongoGridFS, string)

Initializes a new instance of the GridFSFileInfo class.

[Obsolete("Use a different constructor instead.")]
public MongoGridFSFileInfo(MongoGridFS gridFS, string remoteFileName)

Parameters

gridFS MongoGridFS

The GridFS file system that contains the GridFS file.

remoteFileName string

The remote file name.

MongoGridFSFileInfo(MongoGridFS, string, MongoGridFSCreateOptions)

Initializes a new instance of the GridFSFileInfo class.

[Obsolete("Use a different constructor instead.")]
public MongoGridFSFileInfo(MongoGridFS gridFS, string remoteFileName, MongoGridFSCreateOptions createOptions)

Parameters

gridFS MongoGridFS

The GridFS file system that contains the GridFS file.

remoteFileName string

The remote file name.

createOptions MongoGridFSCreateOptions

The create options.

MongoGridFSFileInfo(MongoGridFS, string, int)

Initializes a new instance of the GridFSFileInfo class.

[Obsolete("Use a different constructor instead.")]
public MongoGridFSFileInfo(MongoGridFS gridFS, string remoteFileName, int chunkSize)

Parameters

gridFS MongoGridFS

The GridFS file system that contains the GridFS file.

remoteFileName string

The remote file name.

chunkSize int

The chunk size.

MongoGridFSFileInfo(MongoServer, MongoServerInstance, string, MongoGridFSSettings, BsonDocument)

Initializes a new instance of the MongoGridFSFileInfo class.

public MongoGridFSFileInfo(MongoServer server, MongoServerInstance serverInstance, string databaseName, MongoGridFSSettings gridFSSettings, BsonDocument fileInfo)

Parameters

server MongoServer

The server.

serverInstance MongoServerInstance

The server instance.

databaseName string

Name of the database.

gridFSSettings MongoGridFSSettings

The GridFS settings.

fileInfo BsonDocument

The fileInfo.

MongoGridFSFileInfo(MongoServer, MongoServerInstance, string, MongoGridFSSettings, string)

Initializes a new instance of the MongoGridFSFileInfo class.

public MongoGridFSFileInfo(MongoServer server, MongoServerInstance serverInstance, string databaseName, MongoGridFSSettings gridFSSettings, string remoteFileName)

Parameters

server MongoServer

The server.

serverInstance MongoServerInstance

The server instance.

databaseName string

Name of the database.

gridFSSettings MongoGridFSSettings

The GridFS settings.

remoteFileName string

The remote file name.

MongoGridFSFileInfo(MongoServer, MongoServerInstance, string, MongoGridFSSettings, string, MongoGridFSCreateOptions)

Initializes a new instance of the MongoGridFSFileInfo class.

public MongoGridFSFileInfo(MongoServer server, MongoServerInstance serverInstance, string databaseName, MongoGridFSSettings gridFSSettings, string remoteFileName, MongoGridFSCreateOptions createOptions)

Parameters

server MongoServer

The server.

serverInstance MongoServerInstance

The server instance.

databaseName string

Name of the database.

gridFSSettings MongoGridFSSettings

The GridFS settings.

remoteFileName string

The remote file name.

createOptions MongoGridFSCreateOptions

The create options.

Properties

Aliases

Gets the aliases.

public string[] Aliases { get; }

Property Value

string[]

ChunkSize

Gets the chunk size.

public int ChunkSize { get; }

Property Value

int

ContentType

Gets the content type.

public string ContentType { get; }

Property Value

string

DatabaseName

Gets the database name.

public string DatabaseName { get; }

Property Value

string

Exists

Gets a value indicating whether the GridFS file exists.

public bool Exists { get; }

Property Value

bool

GridFS

Gets the GridFS file system that contains this GridFS file.

public MongoGridFS GridFS { get; }

Property Value

MongoGridFS

GridFSSettings

Gets the GridFS settings.

public MongoGridFSSettings GridFSSettings { get; }

Property Value

MongoGridFSSettings

Id

Gets the GridFS file Id.

public BsonValue Id { get; }

Property Value

BsonValue

Length

Gets the file lenth.

public long Length { get; }

Property Value

long

MD5

Gets the MD5 hash of the file contents.

public string MD5 { get; }

Property Value

string

Metadata

Gets the metadata.

public BsonDocument Metadata { get; }

Property Value

BsonDocument

Name

Gets the remote file name.

public string Name { get; }

Property Value

string

Server

Gets the server.

public MongoServer Server { get; }

Property Value

MongoServer

ServerInstance

Gets the server instance;

public MongoServerInstance ServerInstance { get; }

Property Value

MongoServerInstance

UploadDate

Gets the upload date.

public DateTime UploadDate { get; }

Property Value

DateTime

Methods

AppendText()

Appends UTF-8 encoded text to an existing GridFS file.

public StreamWriter AppendText()

Returns

StreamWriter

A StreamWriter.

CopyTo(string)

Copies a GridFS file.

public MongoGridFSFileInfo CopyTo(string destFileName)

Parameters

destFileName string

The destination file name.

Returns

MongoGridFSFileInfo

The file info of the new GridFS file.

CopyTo(string, MongoGridFSCreateOptions)

Copies a GridFS file.

public MongoGridFSFileInfo CopyTo(string destFileName, MongoGridFSCreateOptions createOptions)

Parameters

destFileName string

The destination file name.

createOptions MongoGridFSCreateOptions

The create options.

Returns

MongoGridFSFileInfo

The file info of the new GridFS file.

Create()

Creates or overwrites a GridFS file.

public MongoGridFSStream Create()

Returns

MongoGridFSStream

A stream.

CreateText()

Creates or opens a GridFS file for writing UTF-8 encoded text.

public StreamWriter CreateText()

Returns

StreamWriter

A stream.

Delete()

Deletes a GridFS file.

public void Delete()

Equals(MongoGridFSFileInfo)

Determines whether this instance and another specified MongoGridFSFileInfo object have the same value.

public bool Equals(MongoGridFSFileInfo rhs)

Parameters

rhs MongoGridFSFileInfo

The MongoGridFSFileInfo object to compare to this instance.

Returns

bool

True if the value of the rhs parameter is the same as this instance; otherwise, false.

Equals(MongoGridFSFileInfo, MongoGridFSFileInfo)

Determines whether two specified MongoGridFSFileInfo objects have the same value.

public static bool Equals(MongoGridFSFileInfo lhs, MongoGridFSFileInfo rhs)

Parameters

lhs MongoGridFSFileInfo

The first value to compare, or null.

rhs MongoGridFSFileInfo

The second value to compare, or null.

Returns

bool

True if the value of lhs is the same as the value of rhs; otherwise, false.

Equals(object)

Determines whether this instance and a specified object, which must also be a MongoGridFSFileInfo object, have the same value.

public override bool Equals(object obj)

Parameters

obj object

The MongoGridFSFileInfo object to compare to this instance.

Returns

bool

True if obj is a MongoGridFSFileInfo object and its value is the same as this instance; otherwise, false.

GetHashCode()

Returns the hash code for this MongoGridFSFileInfo object.

public override int GetHashCode()

Returns

int

A 32-bit signed integer hash code.

MoveTo(string)

Moves the most recent version of a GridFS file.

public void MoveTo(string destFileName)

Parameters

destFileName string

The destination file name.

Open(FileMode)

Opens a GridFS file with the specified mode.

public MongoGridFSStream Open(FileMode mode)

Parameters

mode FileMode

The mode.

Returns

MongoGridFSStream

A stream.

Open(FileMode, FileAccess)

Opens a GridFS file with the specified mode and access.

public MongoGridFSStream Open(FileMode mode, FileAccess access)

Parameters

mode FileMode

The mode.

access FileAccess

The access.

Returns

MongoGridFSStream

A stream.

OpenRead()

Opens an existing GridFS file for reading.

public MongoGridFSStream OpenRead()

Returns

MongoGridFSStream

A stream.

OpenText()

Opens an existing UTF-8 encoded text GridFS file for reading.

public StreamReader OpenText()

Returns

StreamReader

A stream reader.

OpenWrite()

Opens an existing GridFS file for writing.

public MongoGridFSStream OpenWrite()

Returns

MongoGridFSStream

A stream.

Refresh()

Refreshes the GridFS file info from the server.

public void Refresh()

Operators

operator ==(MongoGridFSFileInfo, MongoGridFSFileInfo)

Determines whether two specified MongoGridFSFileInfo objects have the same value.

public static bool operator ==(MongoGridFSFileInfo lhs, MongoGridFSFileInfo rhs)

Parameters

lhs MongoGridFSFileInfo

The first value to compare, or null.

rhs MongoGridFSFileInfo

The second value to compare, or null.

Returns

bool

True if the value of lhs is the same as the value of rhs; otherwise, false.

operator !=(MongoGridFSFileInfo, MongoGridFSFileInfo)

Determines whether two specified MongoGridFSFileInfo objects have different values.

public static bool operator !=(MongoGridFSFileInfo lhs, MongoGridFSFileInfo rhs)

Parameters

lhs MongoGridFSFileInfo

The first value to compare, or null.

rhs MongoGridFSFileInfo

The second value to compare, or null.

Returns

bool

True if the value of lhs is different from the value of rhs; otherwise, false.