Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class FieldSearchSort

Sorts the search results by a field in the hits.

Inheritance
object
SearchSortBase
FieldSearchSort
Implements
ISearchSort
Inherited Members
SearchSortBase.Decending
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Couchbase.Search.Sort
Assembly: Couchbase.NetClient.dll
Syntax
public class FieldSearchSort : SearchSortBase, ISearchSort

Constructors

View Source

FieldSearchSort(string, FieldType, FieldMode, FieldMissing, bool)

Declaration
public FieldSearchSort(string field, FieldType type = FieldType.Auto, FieldMode mode = FieldMode.Default, FieldMissing missing = FieldMissing.Last, bool decending = false)
Parameters
Type Name Description
string field
FieldType type
FieldMode mode
FieldMissing missing
bool decending

Properties

View Source

By

Declaration
protected override string By { get; }
Property Value
Type Description
string
Overrides
SearchSortBase.By

Methods

View Source

Export()

Gets a JSON object representing this search sort.

Declaration
[RequiresUnreferencedCode("Couchbase FTS might require types that cannot be statically analyzed. Make sure all required types are preserved.")]
[RequiresDynamicCode("Couchbase FTS might require types that cannot be statically analyzed and might need runtime code generation. Do not use for native AOT applications.")]
public override JObject Export()
Returns
Type Description
JObject
Overrides
SearchSortBase.Export()
View Source

Missing(FieldMissing)

Declaration
public FieldSearchSort Missing(FieldMissing missing)
Parameters
Type Name Description
FieldMissing missing
Returns
Type Description
FieldSearchSort
View Source

Mode(FieldMode)

Declaration
public FieldSearchSort Mode(FieldMode mode)
Parameters
Type Name Description
FieldMode mode
Returns
Type Description
FieldSearchSort
View Source

Type(FieldType)

Declaration
public FieldSearchSort Type(FieldType type)
Parameters
Type Name Description
FieldType type
Returns
Type Description
FieldSearchSort

Implements

ISearchSort
  • View Source
In this article
Back to top Copyright © 2020 Couchbase, Inc. All rights reserved.