Package dev.frostlake.functions.scalar.string

Class Search

java.lang.Object
dev.frostlake.functions.BuiltInFunction
dev.frostlake.functions.scalar.string.Search
public class Search extends BuiltInFunction
SEARCH(data, query [, ANALYZER => '…'] [, SEARCH_MODE => 'OR'|'AND']) — full-text token search, matching Snowflake's semantics with the default analyzer: both sides tokenize on non-alphanumeric boundaries, case-insensitively; OR mode (the default) is TRUE when ANY query token occurs among the data tokens, AND mode when ALL of them do. data may be a single value or — for the SEARCH((col1, col2), …) form — a tuple, which matches across every element. A NULL data or query yields NULL; an empty token set yields FALSE.

Named arguments reach the evaluation positionally: a trailing string equal to AND/OR selects the mode, any other trailing string names an analyzer — which must be one Snowflake actually ships (tokenization is the default analyzer's either way).

  • Constructor Details

    • Search

      public Search()

  • Method Details

    • getMinArgCount

      public int getMinArgCount()
      Description copied from class: BuiltInFunction
      The fewest arguments a call to this function may pass; fewer is an argument-count error.
      Specified by:
      getMinArgCount in class BuiltInFunction
      Returns:
      the minimum accepted argument count

    • getMaxArgCount

      public int getMaxArgCount()
      Description copied from class: BuiltInFunction
      The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).
      Specified by:
      getMaxArgCount in class BuiltInFunction
      Returns:
      the maximum accepted argument count

    • evaluate

      public Object evaluate(List<Object> args)
      Description copied from class: BuiltInFunction
      Computes the function's result over its already-evaluated argument values. A SQL NULL argument arrives as Java null, and returning null makes the SQL result NULL.
      Specified by:
      evaluate in class BuiltInFunction
      Parameters:
      args - the argument values, in call order
      Returns:
      the function's value for these arguments, or null for SQL NULL