Class ProjectionDefinitionExtensions

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Extension methods for projections.

public static class ProjectionDefinitionExtensions

Inheritance

object

ProjectionDefinitionExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ElemMatch<TDocument, TItem>(ProjectionDefinition<TDocument>, FieldDefinition<TDocument>, FilterDefinition<TItem>)

Combines an existing projection with a projection that filters the contents of an array.

public static ProjectionDefinition<TDocument> ElemMatch<TDocument, TItem>(this ProjectionDefinition<TDocument> projection, FieldDefinition<TDocument> field, FilterDefinition<TItem> filter)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field FieldDefinition<TDocument>

The field.

filter FilterDefinition<TItem>

The filter.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

TItem

The type of the item.

ElemMatch<TDocument, TItem>(ProjectionDefinition<TDocument>, Expression<Func<TDocument, IEnumerable<TItem>>>, FilterDefinition<TItem>)

Combines an existing projection with a projection that filters the contents of an array.

public static ProjectionDefinition<TDocument> ElemMatch<TDocument, TItem>(this ProjectionDefinition<TDocument> projection, Expression<Func<TDocument, IEnumerable<TItem>>> field, FilterDefinition<TItem> filter)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field Expression<Func<TDocument, IEnumerable<TItem>>>

The field.

filter FilterDefinition<TItem>

The filter.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

TItem

The type of the item.

ElemMatch<TDocument, TItem>(ProjectionDefinition<TDocument>, Expression<Func<TDocument, IEnumerable<TItem>>>, Expression<Func<TItem, bool>>)

Combines an existing projection with a projection that filters the contents of an array.

public static ProjectionDefinition<TDocument> ElemMatch<TDocument, TItem>(this ProjectionDefinition<TDocument> projection, Expression<Func<TDocument, IEnumerable<TItem>>> field, Expression<Func<TItem, bool>> filter)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field Expression<Func<TDocument, IEnumerable<TItem>>>

The field.

filter Expression<Func<TItem, bool>>

The filter.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

TItem

The type of the item.

Exclude<TDocument>(ProjectionDefinition<TDocument>, FieldDefinition<TDocument>)

Combines an existing projection with a projection that excludes a field.

public static ProjectionDefinition<TDocument> Exclude<TDocument>(this ProjectionDefinition<TDocument> projection, FieldDefinition<TDocument> field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field FieldDefinition<TDocument>

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

Exclude<TDocument>(ProjectionDefinition<TDocument>, Expression<Func<TDocument, object>>)

Combines an existing projection with a projection that excludes a field.

public static ProjectionDefinition<TDocument> Exclude<TDocument>(this ProjectionDefinition<TDocument> projection, Expression<Func<TDocument, object>> field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field Expression<Func<TDocument, object>>

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

Include<TDocument>(ProjectionDefinition<TDocument>, FieldDefinition<TDocument>)

Combines an existing projection with a projection that includes a field.

public static ProjectionDefinition<TDocument> Include<TDocument>(this ProjectionDefinition<TDocument> projection, FieldDefinition<TDocument> field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field FieldDefinition<TDocument>

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

Include<TDocument>(ProjectionDefinition<TDocument>, Expression<Func<TDocument, object>>)

Combines an existing projection with a projection that includes a field.

public static ProjectionDefinition<TDocument> Include<TDocument>(this ProjectionDefinition<TDocument> projection, Expression<Func<TDocument, object>> field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field Expression<Func<TDocument, object>>

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

MetaSearchHighlights<TDocument>(ProjectionDefinition<TDocument>, string)

Combines an existing projection with a search highlights projection.

public static ProjectionDefinition<TDocument> MetaSearchHighlights<TDocument>(this ProjectionDefinition<TDocument> projection, string field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field string

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

MetaSearchScoreDetails<TDocument>(ProjectionDefinition<TDocument>, string)

Combines an existing projection with a search score details projection.

public static ProjectionDefinition<TDocument> MetaSearchScoreDetails<TDocument>(this ProjectionDefinition<TDocument> projection, string field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field string

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

MetaSearchScore<TDocument>(ProjectionDefinition<TDocument>, string)

Combines an existing projection with a search score projection.

public static ProjectionDefinition<TDocument> MetaSearchScore<TDocument>(this ProjectionDefinition<TDocument> projection, string field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field string

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

MetaTextScore<TDocument>(ProjectionDefinition<TDocument>, string)

Combines an existing projection with a text score projection.

public static ProjectionDefinition<TDocument> MetaTextScore<TDocument>(this ProjectionDefinition<TDocument> projection, string field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field string

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

Meta<TDocument>(ProjectionDefinition<TDocument>, string, string)

Combines an existing projection with a meta projection.

public static ProjectionDefinition<TDocument> Meta<TDocument>(this ProjectionDefinition<TDocument> projection, string field, string metaFieldName)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field string

The field.

metaFieldName string

The meta field name.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

SearchMeta<TDocument>(ProjectionDefinition<TDocument>, FieldDefinition<TDocument>)

Combines an existing projection with a search metadata projection.

public static ProjectionDefinition<TDocument> SearchMeta<TDocument>(this ProjectionDefinition<TDocument> projection, FieldDefinition<TDocument> field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field FieldDefinition<TDocument>

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

SearchMeta<TDocument>(ProjectionDefinition<TDocument>, Expression<Func<TDocument, object>>)

Combines an existing projection with a search metadata projection.

public static ProjectionDefinition<TDocument> SearchMeta<TDocument>(this ProjectionDefinition<TDocument> projection, Expression<Func<TDocument, object>> field)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field Expression<Func<TDocument, object>>

The field.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

Slice<TDocument>(ProjectionDefinition<TDocument>, FieldDefinition<TDocument>, int)

Combines an existing projection with an array slice projection.

public static ProjectionDefinition<TDocument> Slice<TDocument>(this ProjectionDefinition<TDocument> projection, FieldDefinition<TDocument> field, int limit)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field FieldDefinition<TDocument>

The field.

limit int

The limit.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

Slice<TDocument>(ProjectionDefinition<TDocument>, FieldDefinition<TDocument>, int, int)

Combines an existing projection with an array slice projection.

public static ProjectionDefinition<TDocument> Slice<TDocument>(this ProjectionDefinition<TDocument> projection, FieldDefinition<TDocument> field, int skip, int limit)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field FieldDefinition<TDocument>

The field.

skip int

The skip.

limit int

The limit.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

Slice<TDocument>(ProjectionDefinition<TDocument>, Expression<Func<TDocument, object>>, int)

Combines an existing projection with an array slice projection.

public static ProjectionDefinition<TDocument> Slice<TDocument>(this ProjectionDefinition<TDocument> projection, Expression<Func<TDocument, object>> field, int limit)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field Expression<Func<TDocument, object>>

The field.

limit int

The limit.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.

Slice<TDocument>(ProjectionDefinition<TDocument>, Expression<Func<TDocument, object>>, int, int)

Combines an existing projection with an array slice projection.

public static ProjectionDefinition<TDocument> Slice<TDocument>(this ProjectionDefinition<TDocument> projection, Expression<Func<TDocument, object>> field, int skip, int limit)

Parameters

projection ProjectionDefinition<TDocument>

The projection.

field Expression<Func<TDocument, object>>

The field.

skip int

The skip.

limit int

The limit.

Returns

ProjectionDefinition<TDocument>

A combined projection.

Type Parameters

TDocument

The type of the document.