Class FullTextFunction

A class that generates functions for use on the results of a full-text search

Inheritance

System.Object

FullTextFunction

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Couchbase.Lite.Query

Assembly: Couchbase.Lite.dll

Syntax

public static class FullTextFunction

Methods

| Improve this Doc View Source

Match(IIndexExpression, String)

Create a full-text matching function that will check for matches between given full text index name and the given query expression

Declaration

public static IExpression Match(IIndexExpression index, string query)

Parameters

Type	Name	Description
IIndexExpression	index	The full-text index to perform the check against
System.String	query	The query expression to perform the check against

Returns

Type	Description
IExpression	A function that will perform the matching

| Improve this Doc View Source

Match(String, String)

Create a full-text matching function that will check for matches between given full text index name and the given query expression

Declaration

[Obsolete("Use Match(index, query) instead")]
public static IExpression Match(string indexName, string query)

Parameters

Type	Name	Description
System.String	indexName	The name of the full-text index to perform the check against
System.String	query	The query expression to perform the check against

Returns

Type	Description
IExpression	A function that will perform the matching

| Improve this Doc View Source

Rank(IIndexExpression)

Creates a full-text ranking value function indicating how well the current query result matches the full-text query when performing the match comparison.

Declaration

public static IExpression Rank(IIndexExpression index)

Parameters

Type	Name	Description
IIndexExpression	index	The FTS index to use when performing the calculation

Returns

Type	Description
IExpression	A function that will perform the ranking

| Improve this Doc View Source

Rank(String)

Creates a full-text ranking value function indicating how well the current query result matches the full-text query when performing the match comparison.

Declaration

[Obsolete("Use Rank(index) instead")]
public static IExpression Rank(string indexName)

Parameters

Type	Name	Description
System.String	indexName	The FTS index name to use when performing the calculation

Returns

Type	Description
IExpression	A function that will perform the ranking