case class PythonUDTFAnalyzeResult(schema: StructType, withSinglePartition: Boolean, partitionByExpressions: Seq[Expression], orderByExpressions: Seq[SortOrder]) extends Product with Serializable
Represents the result of invoking the polymorphic 'analyze' method on a Python user-defined table function. This returns the table function's output schema in addition to other optional metadata.
- schema
result schema of this particular function call in response to the particular arguments provided, including the types of any provided scalar arguments (and their values, in the case of literals) as well as the names and types of columns of the provided TABLE argument (if any)
- withSinglePartition
true if the 'analyze' method explicitly indicated that the UDTF call should consume all rows of the input TABLE argument in a single instance of the UDTF class, in which case Catalyst will invoke a repartitioning to a separate stage with a single worker for this purpose
- partitionByExpressions
if non-empty, this contains the list of column names that the 'analyze' method explicitly indicated that the UDTF call should partition the input table by, wherein all rows corresponding to each unique combination of values of the partitioning columns are consumed by exactly one unique instance of the UDTF class
- orderByExpressions
if non-empty, this contains the list of ordering items that the 'analyze' method explicitly indicated that the UDTF call should consume the input table rows by
- Alphabetic
- By Inheritance
- PythonUDTFAnalyzeResult
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
PythonUDTFAnalyzeResult(schema: StructType, withSinglePartition: Boolean, partitionByExpressions: Seq[Expression], orderByExpressions: Seq[SortOrder])
- schema
result schema of this particular function call in response to the particular arguments provided, including the types of any provided scalar arguments (and their values, in the case of literals) as well as the names and types of columns of the provided TABLE argument (if any)
- withSinglePartition
true if the 'analyze' method explicitly indicated that the UDTF call should consume all rows of the input TABLE argument in a single instance of the UDTF class, in which case Catalyst will invoke a repartitioning to a separate stage with a single worker for this purpose
- partitionByExpressions
if non-empty, this contains the list of column names that the 'analyze' method explicitly indicated that the UDTF call should partition the input table by, wherein all rows corresponding to each unique combination of values of the partitioning columns are consumed by exactly one unique instance of the UDTF class
- orderByExpressions
if non-empty, this contains the list of ordering items that the 'analyze' method explicitly indicated that the UDTF call should consume the input table rows by
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
-
def
applyToTableArgument(pythonUDTFName: String, t: FunctionTableSubqueryArgumentExpression): FunctionTableSubqueryArgumentExpression
Applies the requested properties from this analysis result to the target TABLE argument expression of a UDTF call, throwing an error if any properties of the UDTF call are incompatible.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val orderByExpressions: Seq[SortOrder]
- val partitionByExpressions: Seq[Expression]
- val schema: StructType
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val withSinglePartition: Boolean