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()
- Source
- Column.java
- Alphabetic
- By Inheritance
- Column
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def comment(): String
Returns the comment of this table column.
Returns the comment of this table column. Null means no comment.
- Annotations
- @Nullable()
- abstract def dataType(): DataType
Returns the data type of this table column.
- 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()
- 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()
- abstract def identityColumnSpec(): IdentityColumnSpec
Returns the identity column specification of this table column.
Returns the identity column specification of this table column. Null means no identity column.
- Annotations
- @Nullable()
- abstract def metadataInJSON(): String
Returns the column metadata in JSON format.
Returns the column metadata in JSON format.
- Annotations
- @Nullable()
- abstract def name(): String
Returns the name of this table column.
- abstract def nullable(): Boolean
Returns true if this column may produce null values.
Concrete 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()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @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
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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)