Package org.apache.gravitino.dto.function

Class FunctionDefinitionDTO

java.lang.Object
org.apache.gravitino.dto.function.FunctionDefinitionDTO
All Implemented Interfaces:
FunctionDefinition
public class FunctionDefinitionDTO extends Object implements FunctionDefinition
DTO for function definition.

  • Constructor Details

    • FunctionDefinitionDTO

      public FunctionDefinitionDTO()

  • Method Details

    • parameters

      public FunctionParam[] parameters()
      Specified by:
      parameters in interface FunctionDefinition
      Returns:
      The parameters for this definition. Maybe an empty array for a no-arg definition.

    • returnType

      public Type returnType()
      Description copied from interface: FunctionDefinition
      The return type for scalar or aggregate function definitions.
      Specified by:
      returnType in interface FunctionDefinition
      Returns:
      The return type, or null if this is a table-valued function definition.

    • returnColumns

      public FunctionColumn[] returnColumns()
      Description copied from interface: FunctionDefinition
      The output columns for a table-valued function definition.

      A table-valued function is a function that returns a table instead of a scalar value or an aggregate result. The returned table has a fixed schema defined by the columns returned from this method.

      Specified by:
      returnColumns in interface FunctionDefinition
      Returns:
      The output columns that define the schema of the table returned by this definition, or an empty array if this is a scalar or aggregate function definition.

    • impls

      public FunctionImpl[] impls()
      Specified by:
      impls in interface FunctionDefinition
      Returns:
      The implementations associated with this definition.

    • toFunctionDefinition

      public FunctionDefinition toFunctionDefinition()
      Convert this DTO to a FunctionDefinition instance.
      Returns:
      The function definition.

    • fromFunctionDefinition

      public static FunctionDefinitionDTO fromFunctionDefinition(FunctionDefinition definition)
      Create a FunctionDefinitionDTO from a FunctionDefinition instance.
      Parameters:
      definition - The function definition.
      Returns:
      The function definition DTO.

    • toString

      public String toString()
      Overrides:
      toString in class Object