Class FieldDefinition<TDocument, TField>

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Base class for field names.

public abstract class FieldDefinition<TDocument, TField>

Type Parameters

TDocument

The type of the document.

TField

The type of the field.

Inheritance

object

FieldDefinition<TDocument, TField>

Derived

ExpressionFieldDefinition<TDocument, TField>

StringFieldDefinition<TDocument, TField>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry)

Renders the field to a RenderedFieldDefinition<TField>.

public virtual RenderedFieldDefinition<TField> Render(IBsonSerializer<TDocument> documentSerializer, IBsonSerializerRegistry serializerRegistry)

Parameters

documentSerializer IBsonSerializer<TDocument>

The document serializer.

serializerRegistry IBsonSerializerRegistry

The serializer registry.

Returns

RenderedFieldDefinition<TField>

A RenderedFieldDefinition<TField>.

Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, LinqProvider)

Renders the field to a RenderedFieldDefinition<TField>.

public abstract RenderedFieldDefinition<TField> Render(IBsonSerializer<TDocument> documentSerializer, IBsonSerializerRegistry serializerRegistry, LinqProvider linqProvider)

Parameters

documentSerializer IBsonSerializer<TDocument>

The document serializer.

serializerRegistry IBsonSerializerRegistry

The serializer registry.

linqProvider LinqProvider

The LINQ provider.

Returns

RenderedFieldDefinition<TField>

A RenderedFieldDefinition<TField>.

Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, LinqProvider, bool)

Renders the field to a RenderedFieldDefinition<TField>.

public virtual RenderedFieldDefinition<TField> Render(IBsonSerializer<TDocument> documentSerializer, IBsonSerializerRegistry serializerRegistry, LinqProvider linqProvider, bool allowScalarValueForArrayField)

Parameters

documentSerializer IBsonSerializer<TDocument>

The document serializer.

serializerRegistry IBsonSerializerRegistry

The serializer registry.

linqProvider LinqProvider

The LINQ provider.

allowScalarValueForArrayField bool

Whether a scalar value is allowed for an array field.

Returns

RenderedFieldDefinition<TField>

A RenderedFieldDefinition<TField>.

Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, bool)

Renders the field to a RenderedFieldDefinition<TField>.

public virtual RenderedFieldDefinition<TField> Render(IBsonSerializer<TDocument> documentSerializer, IBsonSerializerRegistry serializerRegistry, bool allowScalarValueForArrayField)

Parameters

documentSerializer IBsonSerializer<TDocument>

The document serializer.

serializerRegistry IBsonSerializerRegistry

The serializer registry.

allowScalarValueForArrayField bool

Whether a scalar value is allowed for an array field.

Returns

RenderedFieldDefinition<TField>

A RenderedFieldDefinition<TField>.

Operators

implicit operator FieldDefinition<TDocument>(FieldDefinition<TDocument, TField>)

Performs an implicit conversion from FieldDefinition<TDocument, TField> to FieldDefinition<TDocument>.

public static implicit operator FieldDefinition<TDocument>(FieldDefinition<TDocument, TField> field)

Parameters

field FieldDefinition<TDocument, TField>

The field.

Returns

FieldDefinition<TDocument>

The result of the conversion.

implicit operator FieldDefinition<TDocument, TField>(string)

Performs an implicit conversion from string to FieldDefinition<TDocument, TField>.

public static implicit operator FieldDefinition<TDocument, TField>(string fieldName)

Parameters

fieldName string

Name of the field.

Returns

FieldDefinition<TDocument, TField>

The result of the conversion.