Class MongoCollectionSettings

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

The settings used to access a collection.

public class MongoCollectionSettings

Inheritance

object

MongoCollectionSettings

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

MongoCollectionSettings()

Initializes a new instance of the MongoCollectionSettings class.

public MongoCollectionSettings()

Properties

AssignIdOnInsert

Gets or sets a value indicating whether the driver should assign Id values when missing.

public bool AssignIdOnInsert { get; set; }

Property Value

bool

GuidRepresentation

Gets or sets the representation used for Guids.

[Obsolete("Configure serializers instead.")]
public GuidRepresentation GuidRepresentation { get; set; }

Property Value

GuidRepresentation

IsFrozen

Gets a value indicating whether the settings have been frozen to prevent further changes.

public bool IsFrozen { get; }

Property Value

bool

ReadConcern

Gets or sets the read concern.

public ReadConcern ReadConcern { get; set; }

Property Value

ReadConcern

ReadEncoding

Gets or sets the Read Encoding.

public UTF8Encoding ReadEncoding { get; set; }

Property Value

UTF8Encoding

ReadPreference

Gets or sets the read preference to use.

public ReadPreference ReadPreference { get; set; }

Property Value

ReadPreference

SerializerRegistry

Gets the serializer registry.

public IBsonSerializerRegistry SerializerRegistry { get; }

Property Value

IBsonSerializerRegistry

WriteConcern

Gets or sets the WriteConcern to use.

public WriteConcern WriteConcern { get; set; }

Property Value

WriteConcern

WriteEncoding

Gets or sets the Write Encoding.

public UTF8Encoding WriteEncoding { get; set; }

Property Value

UTF8Encoding

Methods

Clone()

Creates a clone of the settings.

public virtual MongoCollectionSettings Clone()

Returns

MongoCollectionSettings

A clone of the settings.

Equals(object)

Compares two MongoCollectionSettings instances.

public override bool Equals(object obj)

Parameters

obj object

The other instance.

Returns

bool

True if the two instances are equal.

Freeze()

Freezes the settings.

public MongoCollectionSettings Freeze()

Returns

MongoCollectionSettings

The frozen settings.

FrozenCopy()

Returns a frozen copy of the settings.

public MongoCollectionSettings FrozenCopy()

Returns

MongoCollectionSettings

A frozen copy of the settings.

GetHashCode()

Gets the hash code.

public override int GetHashCode()

Returns

int

The hash code.

ToString()

Returns a string representation of the settings.

public override string ToString()

Returns

string

A string representation of the settings.