date_trunc

Description

Truncates a time value based on the specified date part, such as year, day, hour, or minute.

StarRocks also provides the year, quarter, month, week, day, and hour functions for you to extract the specified date part.

Syntax

DATETIME|DATE date_trunc(VARCHAR fmt, DATETIME|DATE datetime)

Parameters

• datetime: the time to truncate, which can be of the DATETIME or DATE type. The date and time must exist. Otherwise, NULL will be returned. For example, 2021-02-29 11:12:13 does not exist as a date and NULL will be returned.

• fmt: the date part, that is, to which precision datetime will be truncated. The value must be a VARCHAR constant.

  fmt must be set to a value listed in the following table. If the value is incorrect, an error will be returned.

  If datetime is a DATE value, fmt can only be year, quarter, month, week, or day. If you set fmt to other date units, for example hour, an error is reported. See Example 8.

Value	Description
microsecond	Truncates to the microsecond (since 3.1.7).
millisecond	Truncates to the millisecond (since 3.1.7).
second	Truncates to the second.
minute	Truncates to the minute. The second part will be zero out.
hour	Truncates to the hour. The minute and second parts will be zero out.
day	Truncates to the day. The time part will be zero out.
week	Truncates to the first date of the week that datetime falls in. The time part will be zero out.
month	Truncates to the first date of the month that datetime falls in. The time part will be zero out.
quarter	Truncates to the first date of the quarter that datetime falls in. The time part will be zero out.
year	Truncates to the first date of the year that datetime falls in. The time part will be zero out.

Return value

Returns a value of the DATETIME or DATE type.

If datetime is of the DATE type and fmt is set to hour, minute, or second, the time part of the returned value defaults to 00:00:00.

Examples

Example 1: Truncate the input time to the microsecond.

select date_trunc('microsecond', '2023-10-31 23:59:59.001002');
+---------------------------------------------------------+
| date_trunc('microsecond', '2023-10-31 23:59:59.001002') |
+---------------------------------------------------------+
| 2023-10-31 23:59:59.001002                              |
+---------------------------------------------------------+

Example 2: Truncate the input time to the millisecond.

select date_trunc('millisecond', '2023-10-31 23:59:59.001002');
+---------------------------------------------------------+
| date_trunc('millisecond', '2023-10-31 23:59:59.001002') |
+---------------------------------------------------------+
| 2023-10-31 23:59:59.001000                              |
+---------------------------------------------------------+

select date_trunc('millisecond', '2023-10-31');
+-----------------------------------------+
| date_trunc('millisecond', '2023-10-31') |
+-----------------------------------------+
| 2023-10-31 00:00:00                     |
+-----------------------------------------+

Example 3: Truncate the input time to the minute.

select date_trunc('minute', '2023-11-04 23:59:59.001002');
+----------------------------------------------------+
| date_trunc('minute', '2023-11-04 23:59:59.001002') |
+----------------------------------------------------+
| 2023-11-04 23:59:00                                |
+----------------------------------------------------+

Example 4: Truncate the input time to the hour.

select date_trunc("hour", "2020-11-04 11:12:13");
+-------------------------------------------+
| date_trunc('hour', '2020-11-04 11:12:13') |
+-------------------------------------------+
| 2020-11-04 11:00:00                       |
+-------------------------------------------+

Example 5: Truncate the input time to the first day of a week.

select date_trunc("week", "2020-11-04 11:12:13");
+-------------------------------------------+
| date_trunc('week', '2020-11-04 11:12:13') |
+-------------------------------------------+
| 2020-11-02 00:00:00                       |
+-------------------------------------------+

Example 6: Truncate the input time to the first day of a quarter.

select date_trunc("quarter", "2020-11-04 11:12:13");
+----------------------------------------------+
| date_trunc('quarter', '2020-11-04 11:12:13') |
+----------------------------------------------+
| 2020-10-01 00:00:00                          |
+----------------------------------------------+

Example 7: Truncate the input time to the first day of a year.

select date_trunc('year', '2023-11-04 23:59:59.001002');
+--------------------------------------------------+
| date_trunc('year', '2023-11-04 23:59:59.001002') |
+--------------------------------------------------+
| 2023-01-01 00:00:00                              |
+--------------------------------------------------+

Example 8: Truncate a DATE value to the hour. An error is returned.

select date_trunc("hour", cast("2020-11-04" as date));

ERROR 1064 (HY000): Getting analyzing error from line 1, column 26 to line 1, column 51. Detail message: date_trunc function can't support argument other than year|quarter|month|week|day.

Example 9: Truncate the input date to the first day of a year.

select date_trunc("month", cast("2020-11-04" as date));
+-------------------------------------------------+
| date_trunc('month', CAST('2020-11-04' AS DATE)) |
+-------------------------------------------------+
| 2020-11-01                                      |
+-------------------------------------------------+