Help Center/ Data Lake Insight/ Spark SQL Syntax Reference/ Built-In Functions/ Date Functions/ year
Updated on 2023-10-25 GMT+08:00
View PDF

year

This function is used to return the year of a specified date.

Syntax

year(string date)

Parameters

Table 1 Parameter

Parameter

Mandatory

Type

Description

date

Yes

DATE or STRING

Date that needs to be processed

The following formats are supported:
  • yyyy-mm-dd
  • yyyy-mm-dd hh:mi:ss
  • yyyy-mm-dd hh:mi:ss.ff3

Return Values

The return value is of the INT type.

  • If the value of date is not of the DATE or STRING type, the error message "data type mismatch" is displayed.
  • If the value of date is of the DATE or STRING type but is not in one of the supported formats, NULL is returned.
  • If the value of date is NULL, NULL is returned.

Example Code

The value 2023 is returned.

 select year('2023-08-16 10:54:36');

The value NULL is returned.

 select year('23-01-01');

The value NULL is returned.

 select year('2023/08/16');

The value NULL is returned.

 select year(null);
Parent topic: Date Functions