Package org.pgcodekeeper.core.schema.ch

Class ChFunction

java.lang.Object
org.pgcodekeeper.core.schema.PgStatement
org.pgcodekeeper.core.schema.ch.ChFunction
All Implemented Interfaces:
IHashable, IFunction, ISearchPath, IStatement
public final class ChFunction extends PgStatement implements IFunction
Represents a ClickHouse user-defined function. ClickHouse functions are lambda expressions with parameters and a body.

  • Constructor Details

    • ChFunction

      public ChFunction(String name)
      Creates a new ClickHouse function with the specified name.
      Parameters:
      name - the name of the function

  • Method Details

    • getBody

      public String getBody()
      Returns the function body expression.
      Returns:
      the function body

    • setBody

      public void setBody(String body)

    • getArguments

      public List<Argument> getArguments()
      Description copied from interface: IFunction
      Gets the list of function arguments.
      Specified by:
      getArguments in interface IFunction
      Returns:
      the list of arguments

    • addArgument

      public void addArgument(Argument argument)
      Adds an argument to this function.
      Parameters:
      argument - the argument to add

    • getStatementType

      public DbObjType getStatementType()
      Description copied from interface: IStatement
      Gets the type of this database object.
      Specified by:
      getStatementType in interface IStatement
      Returns:
      the database object type

    • getCreationSQL

      public void getCreationSQL(SQLScript script)
      Description copied from class: PgStatement
      Generates the SQL statements needed to create this database object. This is an abstract method that must be implemented by subclasses to provide the specific CREATE SQL for each object type.
      Specified by:
      getCreationSQL in class PgStatement
      Parameters:
      script - the SQL script to append creation statements to

    • appendAlterSQL

      public ObjectState appendAlterSQL(PgStatement newCondition, SQLScript script)
      Description copied from class: PgStatement
      Fill script with object changes and return change type
      Specified by:
      appendAlterSQL in class PgStatement
      Parameters:
      newCondition - new object state
      script - script to collect changes
      Returns:
      object change type

    • getDbType

      public DatabaseType getDbType()
      Overrides:
      getDbType in class PgStatement

    • getDatabase

      public ChDatabase getDatabase()
      Description copied from interface: ISearchPath
      Gets the database that contains this object.
      Specified by:
      getDatabase in interface ISearchPath
      Specified by:
      getDatabase in interface IStatement
      Returns:
      the containing database

    • computeHash

      public void computeHash(Hasher hasher)
      Description copied from interface: IHashable
      Computes the hash of the implementing object using the provided hasher. The implementation should call appropriate put methods on the hasher for all fields that should contribute to the hash value.
      Specified by:
      computeHash in interface IHashable
      Parameters:
      hasher - the hasher instance to use for hash computation

    • compare

      public boolean compare(PgStatement obj)
      Description copied from class: PgStatement
      This method does not account for nested child PgStatements. Shallow version of PgStatement.equals(Object)
      Overrides:
      compare in class PgStatement

    • shallowCopy

      public PgStatement shallowCopy()
      Description copied from class: PgStatement
      Copies all object properties into a new object and leaves all its children empty.
      Specified by:
      shallowCopy in class PgStatement
      Returns:
      shallow copy of a DB object.

    • getReturns

      public String getReturns()
      Description copied from interface: IFunction
      Gets the return type of this function.
      Specified by:
      getReturns in interface IFunction
      Returns:
      the return type, or null if not applicable

    • getReturnsColumns

      public Map<String,String> getReturnsColumns()
      Description copied from interface: IFunction
      Gets the return columns for table-valued functions.
      Specified by:
      getReturnsColumns in interface IFunction
      Returns:
      a map of column names to their types

    • setReturns

      public void setReturns(String returns)
      Description copied from interface: IFunction
      Sets the return type of this function.
      Specified by:
      setReturns in interface IFunction
      Parameters:
      returns - the return type to set

    • getContainingSchema

      public ISchema getContainingSchema()
      Description copied from interface: ISearchPath
      Gets the schema that contains this object.
      Specified by:
      getContainingSchema in interface ISearchPath
      Returns:
      the containing schema