Class SortBy

Namespace

MongoDB.Driver.Builders

Assembly

MongoDB.Driver.Legacy.dll

A builder for specifying a sort order.

public static class SortBy

Inheritance

object

SortBy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Null

Gets a null value with a type of IMongoSortBy.

public static IMongoSortBy Null { get; }

Property Value

IMongoSortBy

Methods

Ascending(params string[])

Adds keys to be sorted by in ascending order.

public static 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 static 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 static 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).