Packages

trait Literal[T] extends Expression

Represents a constant literal value in the public expression API.

The JVM type of the value held by a literal must be the type used by Spark's InternalRow API for the literal's SQL data type.

Annotations
@Evolving()
Source
Literal.java
Since

3.0.0

Linear Supertypes
Expression, AnyRef, Any
Known Subclasses
AlwaysFalse, AlwaysTrue
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Literal
  2. Expression
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def dataType(): DataType

    Returns the SQL data type of the literal.

  2. abstract def value(): T

    Returns the literal value.

Concrete Value Members

  1. def children(): Array[Expression]

    Returns an array of the children of this node.

    Returns an array of the children of this node. Children should not change.

    Definition Classes
    Literal → Expression
    Annotations
    @Override()
  2. def describe(): String

    Format the expression as a human readable SQL-like string.

    Format the expression as a human readable SQL-like string.

    Definition Classes
    Expression
  3. def references(): Array[NamedReference]

    List of fields or columns that are referenced by this expression.

    List of fields or columns that are referenced by this expression.

    Definition Classes
    Expression