Class CollectionSortBuilder<T>

Namespace

DataStax.AstraDB.DataApi.Core.Query

Assembly

DataStax.AstraDB.DataApi.dll

A sort builder specifically for document operations.

public class CollectionSortBuilder<T> : SortBuilder<T>

Type Parameters

T

The type of the document

Inheritance

object

SortBuilder<T>

CollectionSortBuilder<T>

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

Ascending(string)

public CollectionSortBuilder<T> Ascending(string fieldName)

Parameters

fieldName string

Returns

CollectionSortBuilder<T>

Ascending<TField>(Expression<Func<T, TField>>)

public CollectionSortBuilder<T> Ascending<TField>(Expression<Func<T, TField>> expression)

Parameters

expression Expression<Func<T, TField>>

Returns

CollectionSortBuilder<T>

Type Parameters

TField

Descending(string)

public CollectionSortBuilder<T> Descending(string fieldName)

Parameters

fieldName string

Returns

CollectionSortBuilder<T>

Descending<TField>(Expression<Func<T, TField>>)

public CollectionSortBuilder<T> Descending<TField>(Expression<Func<T, TField>> expression)

Parameters

expression Expression<Func<T, TField>>

Returns

CollectionSortBuilder<T>

Type Parameters

TField

Lexical(string)

Adds a sort by lexical relevance score using the specified search string.

public CollectionSortBuilder<T> Lexical(string value)

Parameters

value string

The search string for lexical (BM25) scoring.

Returns

CollectionSortBuilder<T>

The sort builder.

Vector(float[])

Adds a vector sort.

public CollectionSortBuilder<T> Vector(float[] vector)

Parameters

vector float[]

The vector to sort by.

Returns

CollectionSortBuilder<T>

The document sort builder.

Vectorize(string)

Adds a vector sort by specifying a string value to be vectorized using the collection's vectorizer.

public CollectionSortBuilder<T> Vectorize(string valueToVectorize)

Parameters

valueToVectorize string

The string value to be vectorized.

Returns

CollectionSortBuilder<T>

The document sort builder.