Package dev.frostlake.functions.scalar.semistructured

Class ToXml

java.lang.Object
dev.frostlake.functions.BuiltInFunction
dev.frostlake.functions.StructuredArgumentFunction
dev.frostlake.functions.scalar.semistructured.ToXml
public class ToXml extends StructuredArgumentFunction
TO_XML(variant) — the XML text of a semi-structured value. An XML-shaped variant (see XmlVariants) renders back to compact XML; every other variant renders in Snowflake's generic scheme (live-verified): a <SnowflakeData type="..."> wrapper whose object members become elements named by their key, array elements become <e>, each carrying a type attribute with the value's TYPEOF name, and a JSON null renders self-closing with xsi:nil="true". A VARCHAR argument is rejected at compile time, as in Snowflake.

  • Constructor Details

    • ToXml

      public ToXml()

  • 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