Help Center/ Data Lake Insight/ SQL Syntax Reference (To Be Offline)/ Spark SQL Syntax Reference (Unavailable Soon)/ Built-in Functions/ Date Functions/ datediff
Updated on 2023-10-25 GMT+08:00
View PDF

datediff

This function is used to calculate the difference between date1 and date2.

Similar function: datediff1. The datediff1 function is used to calculate the difference between date1 and date2 and return the difference in a specified datepart.

Syntax

datediff(string date1, string date2)

Parameters

Table 1 Parameters

Parameter

Mandatory

Type

Description

date1

Yes

DATE

or

STRING

Minuend of the date difference between date1 and date2.

The following formats are supported:

  • yyyy-mm-dd
  • yyyy-mm-dd hh:mi:ss
  • yyyy-mm-dd hh:mi:ss.ff3

date2

Yes

DATE

or

STRING

Subtrahend of the date difference between date1 and date2.

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 BIGINT type.

  • If the values of date1 and date2 are not of the DATE or STRING type, the error message "data type mismatch" is displayed.
  • If the values of date1 and date2 are of the DATE or STRING type but are not in one of the supported formats, NULL is returned.
  • If the value of date1 is smaller than that of date2, the return value is a negative number.
  • If the value of date1 or date2 is NULL, NULL is returned.

Example Code

The value 10 is returned.

select datediff('2023-06-30 00:00:00', '2023-06-20 00:00:00');

The value 11 is returned.

select datediff(date '2023-05-21', date '2023-05-10');

The value NULL is returned.

select datediff(date '2023-05-21', null);
Parent topic: Date Functions