Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package apache
    Definition Classes
    org
  • package spark

    Core Spark functionality.

    Core Spark functionality. org.apache.spark.SparkContext serves as the main entry point to Spark, while org.apache.spark.rdd.RDD is the data type representing a distributed collection, and provides most parallel operations.

    In addition, org.apache.spark.rdd.PairRDDFunctions contains operations available only on RDDs of key-value pairs, such as groupByKey and join; org.apache.spark.rdd.DoubleRDDFunctions contains operations available only on RDDs of Doubles; and org.apache.spark.rdd.SequenceFileRDDFunctions contains operations available on RDDs that can be saved as SequenceFiles. These operations are automatically available on any RDD of the right type (e.g. RDD[(Int, Int)] through implicit conversions.

    Java programmers should reference the org.apache.spark.api.java package for Spark programming APIs in Java.

    Classes and methods marked with Experimental are user-facing features which have not been officially adopted by the Spark project. These are subject to change or removal in minor releases.

    Classes and methods marked with Developer API are intended for advanced users want to extend Spark through lower level interfaces. These are subject to changes or removal in minor releases.

    Definition Classes
    apache
  • package sql

    Allows the execution of relational queries, including those expressed in SQL using Spark.

    Allows the execution of relational queries, including those expressed in SQL using Spark.

    Definition Classes
    spark
  • package types

    Contains a type system for attributes produced by relations, including complex types like structs, arrays and maps.

    Contains a type system for attributes produced by relations, including complex types like structs, arrays and maps.

    Definition Classes
    sql
  • package ops
    Definition Classes
    types
  • TimeTypeApiOps
  • TypeApiOps

trait TypeApiOps extends Serializable

Client-side (spark-api) type operations for the Types Framework.

This trait consolidates all client-side operations that a data type must implement to be usable in the Spark SQL API layer. Mandatory methods (format, toSQLValue, getEncoder) must be implemented by every type. Optional methods (Arrow, Python, Hive, Thrift) return Option and default to None - types implement them as they expand their integration coverage.

RELATIONSHIP TO TypeOps:

  • TypeOps (catalyst): Server-side operations - physical types, literals, conversions
  • TypeApiOps (spark-api): Client-side operations - formatting, encoding

The split exists because sql/api cannot depend on sql/catalyst. For TimeType, TimeTypeOps (catalyst) extends TimeTypeApiOps (sql-api) to inherit both sets of operations.

Source
TypeApiOps.scala
Since

4.2.0

See also

TimeTypeApiOps for reference implementation

Linear Supertypes
Serializable, AnyRef, Any
Known Subclasses
TimeTypeApiOps
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TypeApiOps
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def dataType: DataType

    The DataType this Ops instance handles.

  2. abstract def format(v: Any): String

    Formats an internal value as a display string.

    Formats an internal value as a display string.

    Used by CAST to STRING, EXPLAIN output, SHOW commands.

    v

    the internal value (e.g., Long nanoseconds for TimeType)

    returns

    formatted string (e.g., "10:30:45.123456")

  3. abstract def getEncoder: AgnosticEncoder[_]

    Returns the AgnosticEncoder for this type.

    Returns the AgnosticEncoder for this type.

    Used by RowEncoder for Dataset[T] operations.

    returns

    AgnosticEncoder instance (e.g., LocalTimeEncoder for TimeType)

  4. abstract def toSQLValue(v: Any): String

    Formats an internal value as a SQL literal string.

    Formats an internal value as a SQL literal string.

    v

    the internal value

    returns

    SQL literal string (e.g., "TIME '10:30:00'")

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def formatExternal(value: Any, nested: Boolean): Option[String]

    Formats with nesting context.

    Formats with nesting context. Default delegates to the simple version.

  9. def formatExternal(value: Any): Option[String]

    Formats an external-type value for Hive output.

    Formats an external-type value for Hive output. Most types override this simple version. Types that need different formatting when nested should override the 2-param overload.

  10. def formatUTF8(v: Any): UTF8String

    Formats an internal value as a UTF8String.

    Formats an internal value as a UTF8String.

    Default implementation wraps format(). Override for performance if needed.

  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def makeFromJava: Option[(Any) => Any]

    Creates a converter function for Python/Py4J interop.

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def needConversionInPython: Option[Boolean]

    Returns true if values of this type need conversion when passed to/from Python.

  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. def nullSafeConvert(input: Any)(f: PartialFunction[Any, Any]): Any

    Null-safe conversion helper.

    Null-safe conversion helper. Returns null for null input, applies the partial function for non-null input, and returns null for unmatched values.

    Attributes
    protected
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def thriftTypeName: Option[String]

    Returns the Thrift TTypeId name for this type (e.g., "STRING_TYPE").

  22. def toArrowType(timeZoneId: String): Option[ArrowType]

    Converts this DataType to its Arrow representation.

    Converts this DataType to its Arrow representation. Returns None if not supported.

  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped