HOUR_FLOOR

Описание

Функция HOUR_FLOOR округляет входное значение даты и времени вниз до ближайшей границы заданного периода в часах. Она поддерживает входные значения типов DATE, DATETIME, TIMESTAMP_NS и TIMESTAMPTZ. Например, если период составляет 5 часов, функция приводит входное время к началу соответствующего периода.

Формула расчёта даты:

$$\begin{aligned} &\text{hour\_floor}(\langle\text{date\_or\_time\_expr}\rangle, \langle\text{period}\rangle, \langle\text{origin}\rangle) = \\ &\max\{\langle\text{origin}\rangle + k \times \langle\text{period}\rangle \times \text{hour} \mid \\ &k \in \mathbb{Z} \land \langle\text{origin}\rangle + k \times \langle\text{period}\rangle \times \text{hour} \leq \langle\text{date\_or\_time\_expr}\rangle\} \end{aligned}$$

$k$ обозначает количество периодов от исходного до целевого момента времени.

Синтаксис

HOUR_FLOOR(`<date_or_time_expr>`)
HOUR_FLOOR(`<date_or_time_expr>`, `<origin>`)
HOUR_FLOOR(`<date_or_time_expr>`, `<period>`)
HOUR_FLOOR(`<date_or_time_expr>`, `<period>`, `<origin>`)

Параметры

Параметр	Описание
<date_or_time_expr>	Корректное выражение даты, поддерживающее типы DATE, DATETIME, TIMESTAMP_NS и TIMESTAMPTZ. Входное значение типа DATE интерпретируется как начало дня в 00:00:00. Подробнее о форматах см. преобразование timestamptz, преобразование datetime и преобразование date.
<period>	Необязательный параметр, задающий длительность периода в часах. Должен быть положительным целым числом (например, 2, 6, 12). Значение по умолчанию — 1, что соответствует одному периоду длительностью 1 час
<origin>	Исходный момент времени для отсчёта периодов. Поддерживает типы DATE, DATETIME, TIMESTAMP_NS и TIMESTAMPTZ. Если не указан, по умолчанию используется 0001-01-01T00:00:00.

Возвращаемое значение

Для входного значения типа TIMESTAMP_NS возвращается значение типа TIMESTAMP_NS с фиксированными девятью знаками в дробной части секунды. Результаты проверяются на соответствие диапазону возвращаемого типа; для TIMESTAMP_NS используется диапазон [1677-09-21 00:12:43.145224192, 2262-04-11 23:47:16.854775807].

Если <origin> не указан для входного значения типа TIMESTAMP_NS, описанный в документации исходный момент времени по умолчанию используется только как внутренняя точка отсчёта для выравнивания; он не обязан входить в диапазон значений, которые можно хранить в TIMESTAMP_NS.

Возвращает значение типа TIMESTAMPTZ, TIMESTAMP_NS, DATETIME или DATE, представляющее ближайшую нижнюю границу периода после округления.

• Если входное значение имеет тип TIMESTAMPTZ, оно сначала преобразуется в local_time (например, 2025-12-31 23:59:59+05:00 соответствует local_time 2026-01-01 02:59:59, когда переменная сеанса имеет значение +08:00), а затем выполняется расчёт FLOOR.
• Если среди входных значений времени (<date_or_time_expr> и <period>) присутствуют как TIMESTAMPTZ, так и DATETIME, результат имеет тип DATETIME.
• Если заданный период является неположительным целым числом, возвращается ошибка.
• Если любой из параметров равен NULL, результат равен NULL.
• Если origin или datetime имеет дробную часть секунды, результат также имеет дробную часть секунды.
• Если дата и время <origin> позже <period>, расчёт всё равно выполняется по приведённой выше формуле, но число периодов k будет отрицательным.

Примеры

-- Round down by 5-hour period, default origin is 0001-01-01 00:00:00
mysql> select hour_floor("2023-07-13 22:28:18", 5);
+--------------------------------------+
| hour_floor("2023-07-13 22:28:18", 5) |
+--------------------------------------+
| 2023-07-13 18:00:00                  |
+--------------------------------------+

-- Using 2023-07-13 08:00 as origin, divide by 4-hour periods
mysql> select hour_floor('2023-07-13 19:30:00', 4, '2023-07-13 08:00:00') as custom_origin;
+---------------------+
| custom_origin       |
+---------------------+
| 2023-07-13 16:00:00 |
+---------------------+

-- Input datetime exactly at period edge, return input datetime value
select hour_floor("2023-07-13 18:00:00", 5);
+--------------------------------------+
| hour_floor("2023-07-13 18:00:00", 5) |
+--------------------------------------+
| 2023-07-13 18:00:00                  |
+--------------------------------------+

-- Only with origin date and specified date
select hour_floor("2023-07-13 22:28:18", "2023-07-01 12:12:00");
+----------------------------------------------------------+
| hour_floor("2023-07-13 22:28:18", "2023-07-01 12:12:00") |
+----------------------------------------------------------+
| 2023-07-13 22:12:00                                      |
+----------------------------------------------------------+

-- Input date type will be converted to start time 2023-07-13 00:00:00 of the day
mysql> select hour_floor('2023-07-13 20:30:00', 4, '2023-07-13');
+----------------------------------------------------+
| hour_floor('2023-07-13 20:30:00', 4, '2023-07-13') |
+----------------------------------------------------+
| 2023-07-13 20:00:00                                |
+----------------------------------------------------+

-- TimeStampTz sample, SET time_zone = '+08:00'
-- Convert to local_time (2026-01-01 02:59:59) and then perform HOUR_FLOOR
SELECT HOUR_FLOOR('2025-12-31 23:59:59+05:00');
+-----------------------------------------+
| HOUR_FLOOR('2025-12-31 23:59:59+05:00') |
+-----------------------------------------+
| 2026-01-01 02:00:00                     |
+-----------------------------------------+

-- If parameters contain both TimeStampTz and Datetime types, output DateTime type
SELECT HOUR_FLOOR('2025-12-31 23:59:59+05:00', '2025-12-15 00:00:00.123');
+--------------------------------------------------------------------+
| HOUR_FLOOR('2025-12-31 23:59:59+05:00', '2025-12-15 00:00:00.123') |
+--------------------------------------------------------------------+
| 2026-01-01 02:00:00.123                                            |
+--------------------------------------------------------------------+

-- If origin or datetime has scale, the returned result has scale
mysql> select hour_floor('2023-07-13 19:30:00.123', 4, '2023-07-03 08:00:00') as custom_origin;
+-------------------------+
| custom_origin           |
+-------------------------+
| 2023-07-13 16:00:00.000 |
+-------------------------+

mysql> select hour_floor('2023-07-13 19:30:00', 4, '2023-07-03 08:00:00.123') as custom_origin;
+-------------------------+
| custom_origin           |
+-------------------------+
| 2023-07-13 16:00:00.123 |
+-------------------------+

--- If the <origin> date and time is after the <period>, it will still be calculated according to the above formula, but the period k will be negative.
select hour_floor('2023-07-13 19:30:00.123', 4, '2028-07-14 08:00:00') ;
+-----------------------------------------------------------------+
| hour_floor('2023-07-13 19:30:00.123', 4, '2028-07-14 08:00:00') |
+-----------------------------------------------------------------+
| 2023-07-13 16:00:00.000                                         |
+-----------------------------------------------------------------+

-- Input any parameter as NULL (returns NULL)
mysql> select hour_floor(null, 6) as null_input;
+------------+
| null_input |
+------------+
| NULL       |
+------------+

-- Period is negative, returns erro
mysql> select hour_floor('2023-12-31 23:59:59', -3);
ERROR 1105 (HY000): errCode = 2, detailMessage = (10.16.10.3)[E-218]Operation hour_floor of 2023-12-31 23:59:59, -3 out of range