Package dev.frostlake.functions.scalar.string

Class RegexpReplace

java.lang.Object
dev.frostlake.functions.BuiltInFunction
dev.frostlake.functions.TextArgumentFunction
dev.frostlake.functions.scalar.string.RegexpReplace
public class RegexpReplace extends TextArgumentFunction
REGEXP_REPLACE(subject, pattern [, replacement [, position [, occurrence [, parameters]]]]) — replace matches of pattern with replacement. The replacement uses Snowflake backreferences (\1, \2, …). position (1-based, default 1) is where matching starts; occurrence (default 0) replaces ALL matches, or only the Nth when > 0. An invalid pattern is an error (no longer silently returned unchanged).

  • Constructor Details

    • RegexpReplace

      public RegexpReplace()

  • Method Details

    • 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

    • 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

    • binaryRejection

      public SemiStructuredRejection binaryRejection(int position)
      A BINARY is no text here: the account refuses it by the argument types (live-verified).
      Overrides:
      binaryRejection in class BuiltInFunction
      Parameters:
      position - the zero-based argument position being asked about
      Returns:
      the refusal this position gives a BINARY value; by default none