DateColumnLikeSyntax

Instance Constructors

new DateColumnLikeSyntax(column: DoricColumn[T])(implicit arg0: DateType[T], arg1: SparkType[T])

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from DateColumnLikeSyntax[T] to any2stringadd[DateColumnLikeSyntax[T]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (DateColumnLikeSyntax[T], B)

Implicit information
This member is added by an implicit conversion from DateColumnLikeSyntax[T] to ArrowAssoc[DateColumnLikeSyntax[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def <(other: DoricColumn[T]): BooleanColumn
def <=(other: DoricColumn[T]): BooleanColumn
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def >(other: DoricColumn[T]): BooleanColumn
def >=(other: DoricColumn[T]): BooleanColumn
def addDays(days: IntegerColumn): DateColumn

Returns the date that is days days after date column
Returns the date that is days days after date column
days
A column of the number of days to add to date column, can be negative to subtract days

Note
Timestamp columns will be truncated to Date column
def addMonths(nMonths: IntegerColumn): DateColumn

Adds to the Date or Timestamp column the number of months
Adds to the Date or Timestamp column the number of months
nMonths
the number of months to add, can be negative to subtract.
returns
Date column after adding months

Note
Timestamp columns will be truncated to Date column
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def dayOfMonth: IntegerColumn

Extracts the day of the month as an integer from a given date.
Extracts the day of the month as an integer from a given date.

See also
org.apache.spark.sql.functions.dayofmonth
def dayOfWeek: IntegerColumn

Extracts the day of the week as an integer from a given date.
Extracts the day of the week as an integer from a given date. Ranges from 1 for a Sunday through to 7 for a Saturday

See also
org.apache.spark.sql.functions.dayofweek
def dayOfYear: IntegerColumn

Extracts the day of the year as an integer from a given date.
Extracts the day of the year as an integer from a given date.

See also
org.apache.spark.sql.functions.dayofyear
def diff(dateCol: DoricColumn[T]): IntegerColumn

Returns the number of days from date column to dateCol.
Returns the number of days from date column to dateCol.
dateCol
A Date or Timestamp column

See also
org.apache.spark.sql.functions.datediff
def endOfMonth: DateColumn

Sets the moment to the last day of the same month.
Sets the moment to the last day of the same month.

See also
org.apache.spark.sql.functions.last_day
def ensuring(cond: (DateColumnLikeSyntax[T]) ⇒ Boolean, msg: ⇒ Any): DateColumnLikeSyntax[T]

Implicit information
This member is added by an implicit conversion from DateColumnLikeSyntax[T] to Ensuring[DateColumnLikeSyntax[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (DateColumnLikeSyntax[T]) ⇒ Boolean): DateColumnLikeSyntax[T]

Implicit information
This member is added by an implicit conversion from DateColumnLikeSyntax[T] to Ensuring[DateColumnLikeSyntax[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): DateColumnLikeSyntax[T]

Implicit information
This member is added by an implicit conversion from DateColumnLikeSyntax[T] to Ensuring[DateColumnLikeSyntax[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): DateColumnLikeSyntax[T]

Implicit information
This member is added by an implicit conversion from DateColumnLikeSyntax[T] to Ensuring[DateColumnLikeSyntax[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def format(format: StringColumn): StringColumn

Converts a date to a value of string in the format specified by the date format given by the second argument.
Converts a date to a value of string in the format specified by the date format given by the second argument.
format
A pattern dd.MM.yyyy would return a string like 18.03.1993

Exceptions thrown
java.lang.IllegalArgumentException if malformed format
Note
Use specialized functions like 'year' whenever possible as they benefit from a specialized implementation.
See also
org.apache.spark.sql.functions.date_format
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from DateColumnLikeSyntax[T] to StringFormat[DateColumnLikeSyntax[T]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lastDayOfMonth: DateColumn

Returns the last day of the month which the given date belongs to.
Returns the last day of the month which the given date belongs to. For example, input "2015-07-27" returns "2015-07-31" since July 31 is the last day of the month in July 2015.

See also
org.apache.spark.sql.functions.last_day
def lit(implicit l: Location): LiteralDoricColumn[DateColumnLikeSyntax[T]]

Transforms the original value to a literal.
Transforms the original value to a literal.
returns
a literal with the same type.

Implicit information
This member is added by an implicit conversion from DateColumnLikeSyntax[T] to doric.LiteralOps[DateColumnLikeSyntax[T]] performed by method LiteralOps in doric.syntax.LiteralConversions. This conversion will take place only if an implicit value of type SparkType[DateColumnLikeSyntax[T]] is in scope and at the same time an implicit value of type LiteralSparkType[DateColumnLikeSyntax[T]] is in scope.
Definition Classes
LiteralOps
Annotations
@inline()
def month: IntegerColumn

Extracts the month as an integer from a given date.
Extracts the month as an integer from a given date.

See also
org.apache.spark.sql.functions.month
def monthsBetween(dateCol: DoricColumn[T], roundOff: BooleanColumn): DoubleColumn

Returns number of months between dates dateCol and date column.
Returns number of months between dates dateCol and date column.
dateCol
Date or Timestamp column
roundOff
If roundOff is set to true, the result is rounded off to 8 digits; it is not rounded otherwise.

See also
org.apache.spark.sql.functions.months_between
def monthsBetween(dateCol: DoricColumn[T]): DoubleColumn

Returns number of months between dates date column and dateCol.
Returns number of months between dates date column and dateCol.
A whole number is returned if both inputs have the same day of month or both are the last day of their respective months. Otherwise, the difference is calculated assuming 31 days per month.
For example:
dateCol
Date or Timestamp column
Example:
1. Date("2017-11-14").monthsBetween(Date("2017-07-14")) // returns 4.0 Date("2017-01-01").monthsBetween(Date("2017-01-10")) // returns 0.29032258 Timestamp("2017-06-01 00:00:00").monthsBetween(Timestamp("2017-06-16 12:00:00")) // returns -0.5
See also
org.apache.spark.sql.functions.months_between
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def nextDay(dayOfWeek: StringColumn): DateColumn

Returns the first date which is later than the value of the date column that is on the specified day of the week.
Returns the first date which is later than the value of the date column that is on the specified day of the week.
dayOfWeek
Case insensitive, and accepts: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"
Example:
1. For example, Date("2015-07-27").nextDay("Sunday") returns Date("2015-08-02") because that is the first Sunday after 2015-07-27.
To do
scaladoc link (issue #135)
Note
Timestamp columns will be truncated to Date column
See also
org.apache.spark.sql.functions.next_day
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def quarter: IntegerColumn

Extracts the quarter as an integer from a given date.
Extracts the quarter as an integer from a given date.

See also
org.apache.spark.sql.functions.quarter
def subDays(days: IntegerColumn): DateColumn

Returns the date that is days days before date column
Returns the date that is days days before date column
days
A column of the number of days to subtract from date column, can be negative to add days

Note
Timestamp columns will be truncated to Date column
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toInstant: InstantColumn

Transform date to Instant
Transform date to Instant

See also
org.apache.spark.sql.functions.to_timestamp
def toString(): String

Definition Classes
AnyRef → Any
def toTimestamp: TimestampColumn

Transform date to timestamp
Transform date to timestamp

See also
org.apache.spark.sql.functions.to_timestamp
def truncate(format: StringColumn): DoricColumn[T]

Returns date truncated to the unit specified by the format.
Returns date truncated to the unit specified by the format.
format
- if date:
  'year', 'yyyy', 'yy' to truncate by year,
  'month', 'mon', 'mm' to truncate by month
  Other options are: 'week', 'quarter'
- if timestamp:
  'year', 'yyyy', 'yy' to truncate by year,
  'month', 'mon', 'mm' to truncate by month,
  'day', 'dd' to truncate by day,
  Other options are: 'microsecond', 'millisecond', 'second', 'minute', 'hour', 'week', 'quarter'
Example:
1. For example, Timestamp("2018-11-19 12:01:19").trunc("year") returns Date("2018-01-01")
Note
Timestamp columns will be truncated to Date column
See also
org.apache.spark.sql.functions.date_trunc
org.apache.spark.sql.functions.trunc
def unixTimestamp: LongColumn

Converts date/timestamp to Unix timestamp (in seconds), using the default timezone and the default locale.
Converts date/timestamp to Unix timestamp (in seconds), using the default timezone and the default locale.
returns
A long

See also
org.apache.spark.sql.functions.unix_timestamp
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def weekOfYear: IntegerColumn

Extracts the week number as an integer from a given date.
Extracts the week number as an integer from a given date.
A week is considered to start on a Monday and week 1 is the first week with more than 3 days, as defined by ISO 8601

See also
org.apache.spark.sql.functions.weekofyear
def year: IntegerColumn

Extracts the year as an integer from a given date.
Extracts the year as an integer from a given date.

See also
org.apache.spark.sql.functions.year
def →[B](y: B): (DateColumnLikeSyntax[T], B)

Implicit information
This member is added by an implicit conversion from DateColumnLikeSyntax[T] to ArrowAssoc[DateColumnLikeSyntax[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion LiteralOps from DateColumnLikeSyntax[T] to doric.LiteralOps[DateColumnLikeSyntax[T]]

Inherited by implicit conversion any2stringadd from DateColumnLikeSyntax[T] to any2stringadd[DateColumnLikeSyntax[T]]

Inherited by implicit conversion StringFormat from DateColumnLikeSyntax[T] to StringFormat[DateColumnLikeSyntax[T]]

Inherited by implicit conversion Ensuring from DateColumnLikeSyntax[T] to Ensuring[DateColumnLikeSyntax[T]]

Inherited by implicit conversion ArrowAssoc from DateColumnLikeSyntax[T] to ArrowAssoc[DateColumnLikeSyntax[T]]

Comparable Type

Date & Timestamp Type

Date Type

Ungrouped

Related Doc: package DateColumns

implicit class DateColumnLikeSyntax[T] extends AnyRef

Instance Constructors

new DateColumnLikeSyntax(column: DoricColumn[T])(implicit arg0: DateType[T], arg1: SparkType[T])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (DateColumnLikeSyntax[T], B)

def <(other: DoricColumn[T]): BooleanColumn

def <=(other: DoricColumn[T]): BooleanColumn

final def ==(arg0: Any): Boolean

def >(other: DoricColumn[T]): BooleanColumn

def >=(other: DoricColumn[T]): BooleanColumn

def addDays(days: IntegerColumn): DateColumn

def addMonths(nMonths: IntegerColumn): DateColumn

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def dayOfMonth: IntegerColumn

def dayOfWeek: IntegerColumn

def dayOfYear: IntegerColumn

def diff(dateCol: DoricColumn[T]): IntegerColumn

def endOfMonth: DateColumn

def ensuring(cond: (DateColumnLikeSyntax[T]) ⇒ Boolean, msg: ⇒ Any): DateColumnLikeSyntax[T]

def ensuring(cond: (DateColumnLikeSyntax[T]) ⇒ Boolean): DateColumnLikeSyntax[T]

def ensuring(cond: Boolean, msg: ⇒ Any): DateColumnLikeSyntax[T]

def ensuring(cond: Boolean): DateColumnLikeSyntax[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def format(format: StringColumn): StringColumn

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def lastDayOfMonth: DateColumn

def lit(implicit l: Location): LiteralDoricColumn[DateColumnLikeSyntax[T]]

def month: IntegerColumn

def monthsBetween(dateCol: DoricColumn[T], roundOff: BooleanColumn): DoubleColumn

def monthsBetween(dateCol: DoricColumn[T]): DoubleColumn

final def ne(arg0: AnyRef): Boolean

def nextDay(dayOfWeek: StringColumn): DateColumn

final def notify(): Unit

final def notifyAll(): Unit

def quarter: IntegerColumn

def subDays(days: IntegerColumn): DateColumn

final def synchronized[T0](arg0: ⇒ T0): T0

def toInstant: InstantColumn

def toString(): String

def toTimestamp: TimestampColumn

def truncate(format: StringColumn): DoricColumn[T]

def unixTimestamp: LongColumn

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def weekOfYear: IntegerColumn

def year: IntegerColumn

def →[B](y: B): (DateColumnLikeSyntax[T], B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion LiteralOps from DateColumnLikeSyntax[T] to doric.LiteralOps[DateColumnLikeSyntax[T]]

Inherited by implicit conversion any2stringadd from DateColumnLikeSyntax[T] to any2stringadd[DateColumnLikeSyntax[T]]

Inherited by implicit conversion StringFormat from DateColumnLikeSyntax[T] to StringFormat[DateColumnLikeSyntax[T]]

Inherited by implicit conversion Ensuring from DateColumnLikeSyntax[T] to Ensuring[DateColumnLikeSyntax[T]]

Inherited by implicit conversion ArrowAssoc from DateColumnLikeSyntax[T] to ArrowAssoc[DateColumnLikeSyntax[T]]

Comparable Type

Date & Timestamp Type

Date Type

Ungrouped