Class QueryStringQuery

The query string query allows humans to describe complex queries using a simple syntax.

Inheritance

object

SearchQueryBase

QueryStringQuery

Implements

ISearchQuery

Inherited Members

SearchQueryBase.IndexName

SearchQueryBase.Query

SearchQueryBase.Boost(double)

SearchQueryBase.BoostValue

object.GetType()

object.MemberwiseClone()

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 class QueryStringQuery : SearchQueryBase, ISearchQuery

Constructors

QueryStringQuery(string)

Initializes a new instance of the QueryStringQuery class.

Declaration

public QueryStringQuery(string query)

Parameters

Type	Name	Description
string	query	The query string to be analyzed and used against. The query string is required.

Exceptions

Type	Condition
ArgumentNullException	query

Methods

AsReadOnly()

Declaration

public QueryStringQuery.ReadOnly AsReadOnly()

Returns

Type	Description
QueryStringQuery.ReadOnly

Deconstruct(out string)

Declaration

public void Deconstruct(out string query)

Parameters

Type	Name	Description
string	query

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()

Implements

ISearchQuery

See Also

SearchQueryBase