Class FilterDefinition<TDocument>

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Base class for filters.

public abstract class FilterDefinition<TDocument>

Type Parameters

TDocument

The type of the document.

Inheritance

object

FilterDefinition<TDocument>

Derived

BsonDocumentFilterDefinition<TDocument>

ExpressionFilterDefinition<TDocument>

JsonFilterDefinition<TDocument>

ObjectFilterDefinition<TDocument>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

LinqExtensions.Inject<TDocument>(FilterDefinition<TDocument>)

Properties

Empty

Gets an empty filter. An empty filter matches everything.

public static FilterDefinition<TDocument> Empty { get; }

Property Value

FilterDefinition<TDocument>

Methods

Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry)

Renders the filter to a BsonDocument.

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

Parameters

documentSerializer IBsonSerializer<TDocument>

The document serializer.

serializerRegistry IBsonSerializerRegistry

The serializer registry.

Returns

BsonDocument

A BsonDocument.

Render(IBsonSerializer<TDocument>, IBsonSerializerRegistry, LinqProvider)

Renders the filter to a BsonDocument.

public abstract BsonDocument 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

BsonDocument

A BsonDocument.

Operators

operator &(FilterDefinition<TDocument>, FilterDefinition<TDocument>)

Implements the operator &.

public static FilterDefinition<TDocument> operator &(FilterDefinition<TDocument> lhs, FilterDefinition<TDocument> rhs)

Parameters

lhs FilterDefinition<TDocument>

The LHS.

rhs FilterDefinition<TDocument>

The RHS.

Returns

FilterDefinition<TDocument>

The result of the operator.

operator |(FilterDefinition<TDocument>, FilterDefinition<TDocument>)

Implements the operator |.

public static FilterDefinition<TDocument> operator |(FilterDefinition<TDocument> lhs, FilterDefinition<TDocument> rhs)

Parameters

lhs FilterDefinition<TDocument>

The LHS.

rhs FilterDefinition<TDocument>

The RHS.

Returns

FilterDefinition<TDocument>

The result of the operator.

implicit operator FilterDefinition<TDocument>(BsonDocument)

Performs an implicit conversion from BsonDocument to FilterDefinition<TDocument>.

public static implicit operator FilterDefinition<TDocument>(BsonDocument document)

Parameters

document BsonDocument

The document.

Returns

FilterDefinition<TDocument>

The result of the conversion.

implicit operator FilterDefinition<TDocument>(Expression<Func<TDocument, bool>>)

Performs an implicit conversion from a predicate expression to FilterDefinition<TDocument>.

public static implicit operator FilterDefinition<TDocument>(Expression<Func<TDocument, bool>> predicate)

Parameters

predicate Expression<Func<TDocument, bool>>

The predicate.

Returns

FilterDefinition<TDocument>

The result of the conversion.

implicit operator FilterDefinition<TDocument>(string)

Performs an implicit conversion from string to FilterDefinition<TDocument>.

public static implicit operator FilterDefinition<TDocument>(string json)

Parameters

json string

The JSON string.

Returns

FilterDefinition<TDocument>

The result of the conversion.

operator !(FilterDefinition<TDocument>)

Implements the operator !.

public static FilterDefinition<TDocument> operator !(FilterDefinition<TDocument> op)

Parameters

op FilterDefinition<TDocument>

The op.

Returns

FilterDefinition<TDocument>

The result of the operator.