Couchbase .NET SDK __CB_SDK_VERSION__

Show / Hide Table of Contents

Class TermQuery

A term query is a query that may be "fuzzy" and matches terms within a specified edit distance (Levenshtein distance). Also, you can optionally specify that the term must have a matching prefix of the specified length.

Inheritance
object
SearchQueryBase
TermQuery
Implements
ISearchQuery
Inherited Members
SearchQueryBase.Boost(double)
SearchQueryBase.BoostValue
object.GetType()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Couchbase.Search.Queries.Simple
Assembly: Couchbase.NetClient.dll
Syntax
public sealed class TermQuery : SearchQueryBase, ISearchQuery

Constructors

View Source

TermQuery(string)

Declaration
public TermQuery(string term)
Parameters
Type Name Description
string term

Methods

View Source

AsReadOnly()

Declaration
public TermQuery.ReadOnly AsReadOnly()
Returns
Type Description
TermQuery.ReadOnly
View Source

Deconstruct(out string, out int, out int, out string)

Declaration
public void Deconstruct(out string term, out int fuzziness, out int prefixLength, out string field)
Parameters
Type Name Description
string term
int fuzziness
int prefixLength
string field
View Source

Export()

Gets a JSON object representing this query instance />

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
SearchQueryBase.Export()
View Source

Field(string)

The field to search against.

Declaration
public TermQuery Field(string field)
Parameters
Type Name Description
string field

The field.

Returns
Type Description
TermQuery
View Source

Fuzziness(int)

Declaration
public TermQuery Fuzziness(int fuzziness)
Parameters
Type Name Description
int fuzziness
Returns
Type Description
TermQuery
View Source

PrefixLength(int)

Declaration
public TermQuery PrefixLength(int prefixLength)
Parameters
Type Name Description
int prefixLength
Returns
Type Description
TermQuery

Implements

ISearchQuery

See Also

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