Class PhraseQuery

The phrase query allows to query for exact term phrases in the index. The provided terms must exist in the correct order, at the correct index offsets, in the specified field (as no analyzer are applied to the terms). Queried field must have been indexed with includeTermVectors set to true. It is generally more useful in debugging scenarios, and the Match Phrase Query should usually be preferred for real-world use cases.

Inheritance
object
SearchQueryBase
PhraseQuery
Implements
Inherited Members
Namespace: Couchbase.Search.Queries.Simple
Assembly: Couchbase.NetClient.dll
Syntax
public sealed class PhraseQuery : SearchQueryBase, ISearchQuery

Constructors

View Source

PhraseQuery(params string[])

Declaration
public PhraseQuery(params string[] terms)
Parameters
Type Name Description
string[] terms

Methods

View Source

AsReadOnly()

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

Deconstruct(out IReadOnlyList<string>, out string)

Declaration
public void Deconstruct(out IReadOnlyList<string> terms, out string field)
Parameters
Type Name Description
IReadOnlyList<string> terms
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
View Source

Field(string)

The field to search against.

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

The field.
Returns
Type Description
PhraseQuery

Implements

See Also