Class SortByBuilder

Namespace

MongoDB.Driver.Builders

Assembly

MongoDB.Driver.Legacy.dll

A builder for specifying a sort order.

[Serializable]
[BsonSerializer(typeof(SortByBuilder.Serializer))]
public class SortByBuilder : BuilderBase, IConvertibleToBsonDocument, IMongoSortBy

Inheritance

object

BuilderBase

SortByBuilder

Implements

IConvertibleToBsonDocument

IMongoSortBy

Inherited Members

BuilderBase.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

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

Constructors

SortByBuilder()

Initializes a new instance of the SortByBuider class.

public SortByBuilder()

Methods

Ascending(params string[])

Adds keys to be sorted by in ascending order.

public SortByBuilder Ascending(params string[] keys)

Parameters

keys string[]

One or more key names.

Returns

SortByBuilder

The builder (so method calls can be chained).

Descending(params string[])

Adds keys to be sorted by in descending order.

public SortByBuilder Descending(params string[] keys)

Parameters

keys string[]

One or more key names.

Returns

SortByBuilder

The builder (so method calls can be chained).

MetaTextScore(string)

Adds a key to sort by the computed relevance score when using text search. The name of the key should be the name of the projected relevance score field.

public SortByBuilder MetaTextScore(string key)

Parameters

key string

The name of the computed relevance score field.

Returns

SortByBuilder

The builder (so method calls can be chained).

ToBsonDocument()

Returns the result of the builder as a BsonDocument.

public override BsonDocument ToBsonDocument()

Returns

BsonDocument

A BsonDocument.