Packages

class Extract extends ExpressionWithToString

Represent an extract function, which extracts and returns the value of a specified datetime field from a datetime or interval value expression.

The currently supported fields names following the ISO standard:

  • SECOND Since 3.4.0
  • MINUTE Since 3.4.0
  • HOUR Since 3.4.0
  • MONTH Since 3.4.0
  • QUARTER Since 3.4.0
  • YEAR Since 3.4.0
  • DAY_OF_WEEK Since 3.4.0
  • DAY Since 3.4.0
  • DAY_OF_YEAR Since 3.4.0
  • WEEK Since 3.4.0
  • YEAR_OF_WEEK Since 3.4.0
Annotations
@Evolving()
Source
Extract.java
Since

3.4.0

Linear Supertypes
ExpressionWithToString, Serializable, Expression, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Extract
  2. ExpressionWithToString
  3. Serializable
  4. Expression
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Extract(field: String, source: Expression)

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
    Extract → 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 field(): String
  4. 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
  5. def source(): Expression
  6. def toString(): String
    Definition Classes
    ExpressionWithToString → AnyRef → Any