extract

Extracts a part of the date/timestamp or interval source.

For the corresponding Databricks SQL function, see extract function.

Syntax

from pyspark.databricks.sql import functions as dbf

dbf.extract(field=<field>, source=<source>)

Parameters

Parameter	Type	Description
field	pyspark.sql.Column	selects which part of the source should be extracted.
source	pyspark.sql.Column or str	a date/timestamp or interval column from where field should be extracted.

Returns

pyspark.sql.Column: a part of the date/timestamp or interval source.

Examples

import datetime
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(datetime.datetime(2015, 4, 8, 13, 8, 15),)], ['ts'])
df.select(
'*',
dbf.extract(dbf.lit('YEAR'), 'ts').alias('year'),
dbf.extract(dbf.lit('month'), 'ts').alias('month'),
dbf.extract(dbf.lit('WEEK'), 'ts').alias('week'),
dbf.extract(dbf.lit('D'), df.ts).alias('day'),
dbf.extract(dbf.lit('M'), df.ts).alias('minute'),
dbf.extract(dbf.lit('S'), df.ts).alias('second')
).show()