case class SQLFunction(name: FunctionIdentifier, inputParam: Option[StructType], returnType: Either[DataType, StructType], exprText: Option[String], queryText: Option[String], comment: Option[String], deterministic: Option[Boolean], containsSQL: Option[Boolean], isTableFunc: Boolean, properties: Map[String, String], owner: Option[String] = None, createTimeMs: Long = System.currentTimeMillis) extends UserDefinedFunction with Product with Serializable
Represent a SQL function.
- name
qualified name of the SQL function
- inputParam
function input parameters
- returnType
function return type
- exprText
function body as an expression
- queryText
function body as a query
- comment
function comment
- deterministic
whether the function is deterministic
- containsSQL
whether the function has data access routine to be CONTAINS SQL
- isTableFunc
whether the function is a table function
- properties
additional properties to be serialized for the SQL function
- owner
owner of the function
- createTimeMs
function creation time in milliseconds
- Alphabetic
- By Inheritance
- SQLFunction
- Serializable
- Product
- Equals
- UserDefinedFunction
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SQLFunction(name: FunctionIdentifier, inputParam: Option[StructType], returnType: Either[DataType, StructType], exprText: Option[String], queryText: Option[String], comment: Option[String], deterministic: Option[Boolean], containsSQL: Option[Boolean], isTableFunc: Boolean, properties: Map[String, String], owner: Option[String] = None, createTimeMs: Long = System.currentTimeMillis)
- name
qualified name of the SQL function
- inputParam
function input parameters
- returnType
function return type
- exprText
function body as an expression
- queryText
function body as a query
- comment
function comment
- deterministic
whether the function is deterministic
- containsSQL
whether the function has data access routine to be CONTAINS SQL
- isTableFunc
whether the function is a table function
- properties
additional properties to be serialized for the SQL function
- owner
owner of the function
- createTimeMs
function creation time in milliseconds
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val comment: Option[String]
- val containsSQL: Option[Boolean]
- val createTimeMs: Long
Function creation time in milliseconds since the linux epoch
Function creation time in milliseconds since the linux epoch
- Definition Classes
- SQLFunction → UserDefinedFunction
- val deterministic: Option[Boolean]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val exprText: Option[String]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getExpressionAndQuery(parser: ParserInterface, isTableFunc: Boolean): (Option[Expression], Option[LogicalPlan])
Optionally get the function body as an expression or query using the given parser.
- def getSQLConfigs: Map[String, String]
Get SQL configs from the function properties.
Get SQL configs from the function properties. Use this to restore the SQL configs that should be used for this function.
- Definition Classes
- UserDefinedFunction
- def getScalarFuncReturnType: DataType
Get scalar function return data type.
- def getTableFuncReturnCols: StructType
Get table function return columns.
- val inputParam: Option[StructType]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val isTableFunc: Boolean
- val language: RoutineLanguage
The language of the user defined function.
The language of the user defined function.
- Definition Classes
- SQLFunction → UserDefinedFunction
- val name: FunctionIdentifier
Qualified name of the function
Qualified name of the function
- Definition Classes
- SQLFunction → UserDefinedFunction
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val owner: Option[String]
Owner of the function
Owner of the function
- Definition Classes
- SQLFunction → UserDefinedFunction
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val properties: Map[String, String]
Additional properties to be serialized for the function.
Additional properties to be serialized for the function. Use this to preserve the runtime configuration that should be used during the function execution, such as SQL configs etc. See SQLConf for more info.
- Definition Classes
- SQLFunction → UserDefinedFunction
- val queryText: Option[String]
- val returnType: Either[DataType, StructType]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toCatalogFunction: CatalogFunction
Convert the SQL function to a CatalogFunction.
Convert the SQL function to a CatalogFunction.
- Definition Classes
- SQLFunction → UserDefinedFunction
- def toExpressionInfo: ExpressionInfo
Convert the SQL function to an ExpressionInfo.
Convert the SQL function to an ExpressionInfo.
- Definition Classes
- SQLFunction → UserDefinedFunction
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)