Class TruncateFunction

java.lang.Object
org.apache.iceberg.spark.functions.TruncateFunction
All Implemented Interfaces:
Serializable, org.apache.spark.sql.connector.catalog.functions.Function, org.apache.spark.sql.connector.catalog.functions.UnboundFunction

public class TruncateFunction extends Object implements org.apache.spark.sql.connector.catalog.functions.UnboundFunction
A Spark function implementation for the Iceberg truncate transform.

Example usage: SELECT system.truncate(1, 'abc'), which returns the String 'a'.

Note that for performance reasons, the given input width is not validated in the implementations used in code-gen. The width must remain non-negative to give meaningful results.

See Also:
  • Constructor Details

    • TruncateFunction

      public TruncateFunction()
  • Method Details

    • bind

      public org.apache.spark.sql.connector.catalog.functions.BoundFunction bind(org.apache.spark.sql.types.StructType inputType)
      Specified by:
      bind in interface org.apache.spark.sql.connector.catalog.functions.UnboundFunction
    • description

      public String description()
      Specified by:
      description in interface org.apache.spark.sql.connector.catalog.functions.UnboundFunction
    • name

      public String name()
      Specified by:
      name in interface org.apache.spark.sql.connector.catalog.functions.Function