c

org.apache.spark.sql.connector.catalog

ColumnDefaultValue

class ColumnDefaultValue extends AnyRef

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()
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ColumnDefaultValue
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ColumnDefaultValue(sql: String, value: Literal[_])

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(o: Any): Boolean
    Definition Classes
    ColumnDefaultValue → AnyRef → Any
    Annotations
    @Override()
  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 getSql(): String

    Returns the SQL string (Spark SQL dialect) of the default value expression.

    Returns the SQL string (Spark SQL dialect) of the default value expression. This is the original string contents of the SQL expression specified at the time the column was created in a CREATE TABLE, REPLACE TABLE, or ADD COLUMN command. For example, for "CREATE TABLE t (col INT DEFAULT 40 + 2)", this returns the string literal "40 + 2" (without quotation marks).

    Annotations
    @Nonnull()
  11. def getValue(): Literal[_]

    Returns the default value literal.

    Returns the default value literal. This is the literal value corresponding to #getSql(). For the example in the doc of #getSql(), this returns a literal integer with a value of 42.

    Annotations
    @Nonnull()
  12. def hashCode(): Int
    Definition Classes
    ColumnDefaultValue → 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
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    ColumnDefaultValue → AnyRef → Any
    Annotations
    @Override()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped