Packages

c

org.apache.spark.sql.connector.catalog

ColumnDefaultValue

class ColumnDefaultValue extends DefaultValue

A class representing the default value of a column. It contains both the SQL string and literal value of the user-specified default value expression. The SQL string should be re-evaluated for each table writing command, which may produce different values if the default value expression is something like CURRENT_DATE(). The literal value is used to back-fill existing data if new columns with default value are added. Note: the back-fill can be lazy. The data sources can remember the column default value and let the reader fill the column value when reading existing data that do not have these new columns.

Annotations
@Evolving()
Source
ColumnDefaultValue.java
Linear Supertypes
DefaultValue, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ColumnDefaultValue
  2. DefaultValue
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ColumnDefaultValue(sql: String, expr: Expression, value: Literal[_ <: AnyRef])
  2. new ColumnDefaultValue(expr: Expression, value: Literal[_ <: AnyRef])
  3. new ColumnDefaultValue(sql: String, value: Literal[_ <: AnyRef])

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(o: AnyRef): Boolean
    Definition Classes
    ColumnDefaultValue → DefaultValue → AnyRef → Any
    Annotations
    @Override()
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def getExpression(): Expression

    Returns the expression representing the default value, if provided.

    Returns the expression representing the default value, if provided.

    Definition Classes
    DefaultValue
    Annotations
    @Nullable()
  10. def getSql(): String

    Returns the SQL representation of the default value (Spark SQL dialect), if provided.

    Returns the SQL representation of the default value (Spark SQL dialect), if provided.

    Definition Classes
    DefaultValue
    Annotations
    @Nullable()
  11. def getValue(): Literal[_ <: AnyRef]

    Returns the default value literal.

    Returns the default value literal. This is the literal value corresponding to #getSql(). For example if the SQL is "current_date()", this literal value will be the evaluated current_date() at the time the column was added/altered. Spark always sets this value when passing ColumnDefaultValue to createTable/alterTable, but Table#columns() may not do so as some data sources have its own system to do column default value back-fill.

    Annotations
    @Nullable()
  12. def hashCode(): Int
    Definition Classes
    ColumnDefaultValue → DefaultValue → AnyRef → Any
    Annotations
    @Override()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    ColumnDefaultValue → DefaultValue → AnyRef → Any
    Annotations
    @Override()
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. 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 DefaultValue

Inherited from AnyRef

Inherited from Any

Ungrouped