Date.*

Power Query Date.* column expressions.

class fabrictools.powerquery.date.Date[source]

Bases: object

Namespace for Power Query Date.* functions.

All methods return Spark Column expressions for use in fabrictools.powerquery.table.Table.AddColumn().

static AddDays(expr: pyspark.sql.Column | str, days: int) → pyspark.sql.Column[source]

Add calendar days to a date (Power Query Date.AddDays).

Parameters:

expr (Column | str) – Date column or string literal.
days (int) – Number of days to add (may be negative).

Returns:

Shifted date column expression.

Return type:

Column

Example

>>> from fabrictools import Date
>>> from pyspark.sql import functions as F
>>> df.withColumn("due_date", Date.AddDays(F.col("order_date"), 30))

static Day(expr: pyspark.sql.Column | str) → pyspark.sql.Column[source]

Extract the day of month from a date or timestamp (Power Query Date.Day).

Parameters:: expr (Column | str) – Date or timestamp column, or string literal.
Returns:: Integer day column expression.
Return type:: Column

Example

>>> from fabrictools import Date
>>> from pyspark.sql import functions as F
>>> df.withColumn("day", Date.Day(F.col("order_date")))

static From(expr: pyspark.sql.Column | str) → pyspark.sql.Column[source]

Parse or cast a value to date (Power Query Date.From).

Parameters:: expr (Column | str) – Column or string literal parseable as a date.
Returns:: Date column expression.
Return type:: Column

Example

>>> from fabrictools import Date
>>> from pyspark.sql import functions as F
>>> df.withColumn("order_date", Date.From(F.col("order_date_str")))

static Month(expr: pyspark.sql.Column | str) → pyspark.sql.Column[source]

Extract the month (1–12) from a date or timestamp (Power Query Date.Month).

Parameters:: expr (Column | str) – Date or timestamp column, or string literal.
Returns:: Integer month column expression.
Return type:: Column

Example

>>> from fabrictools import Date
>>> from pyspark.sql import functions as F
>>> df.withColumn("month", Date.Month(F.col("order_date")))

static Year(expr: pyspark.sql.Column | str) → pyspark.sql.Column[source]

Extract the year from a date or timestamp (Power Query Date.Year).

Parameters:: expr (Column | str) – Date or timestamp column, or string literal.
Returns:: Integer year column expression.
Return type:: Column

Example

>>> from fabrictools import Table, Date
>>> from pyspark.sql import functions as F
>>> df = Table.AddColumn(df, "Year", Date.Year(F.col("Date of Revenue recognition")))