trait Column extends AnyRef

An interface representing a column of a Table. It defines basic properties of a column, such as name and data type, as well as some advanced ones like default column value.

Data Sources do not need to implement it. They should consume it in APIs like Column[], Transform[], Map), and report it in Table#columns() by calling the static create functions of this interface to create it.

A column cannot have both a default value and a generation expression.

Annotations
@Evolving()
Linear Supertypes
AnyRef, Any
Known Subclasses
ColumnImpl
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Column
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def comment(): String

    Returns the comment of this table column.

    Returns the comment of this table column. Null means no comment.

    Annotations
    @Nullable()
  2. abstract def dataType(): DataType

    Returns the data type of this table column.

  3. abstract def defaultValue(): ColumnDefaultValue

    Returns the default value of this table column.

    Returns the default value of this table column. Null means no default value.

    Annotations
    @Nullable()
  4. abstract def generationExpression(): String

    Returns the generation expression of this table column.

    Returns the generation expression of this table column. Null means no generation expression.

    The generation expression is stored as spark SQL dialect. It is up to the data source to verify expression compatibility and reject writes as necessary.

    Annotations
    @Nullable()
  5. abstract def metadataInJSON(): String

    Returns the column metadata in JSON format.

    Returns the column metadata in JSON format.

    Annotations
    @Nullable()
  6. abstract def name(): String

    Returns the name of this table column.

  7. abstract def nullable(): Boolean

    Returns true if this column may produce null values.

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( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped