Class RegexpQuery

Regexp query finds documents containing terms that match the specified regular expression.

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

Constructors

View Source

RegexpQuery(string)

Initializes a new instance of the RegexpQuery class.

Declaration
public RegexpQuery(string regex)
Parameters
Type Name Description
string regex

The regexp to be analyzed and used against. The regexp string is required.
Exceptions
Type Condition
ArgumentNullException

regex

Methods

View Source

AsReadOnly()

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

Deconstruct(out string, out string)

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

If a field is specified, only terms in that field will be matched. This can also affect the used analyzer if one isn't specified explicitly.

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

The field.
Returns
Type Description
RegexpQuery

Implements

See Also