FullTextFunction

public final class FullTextFunction

Full-text function factory.

  • Creates a full-text rank function with the given full-text index name. The rank function indicates how well the current query result matches the full-text query when performing the match comparison.

    Declaration

    Swift

    @available(*, deprecated, message: "Use FullTextFunction.rank(withIndex:﹚ instead.")
public static func rank(_ indexName: String) -> ExpressionProtocol

    Parameters

    indexName

    The index name.

    Return Value

    The full-text rank function.

  • Creates a full-text match expression with the given full-text index name and the query text

    Declaration

    Swift

    @available(*, deprecated, message: "Use FullTextFunction.match(withIndex:query﹚ instead.")
public static func match(indexName: String, query: String) -> ExpressionProtocol

    Parameters

    indexName

    The index name.
    query

    The query string.

    Return Value

    The full-text match function expression.

  • Creates a full-text rank() function with the given full-text index expression.

    The rank function indicates how well the current query result matches the full-text query when performing the match comparison.

    Declaration

    Swift

    public static func rank(_ index: IndexExpressionProtocol) -> ExpressionProtocol

    Parameters

    index

    The full-text index expression.

    Return Value

    The full-text rank function.

  • Creates a full-text match() function with the given full-text index expression and the query text

    Declaration

    Swift

    public static func match(_ index: IndexExpressionProtocol, query: String) -> ExpressionProtocol

    Parameters

    indexName

    TThe full-text index expression.
    query

    The query string.

    Return Value

    The full-text match() function expression.