HOUR_CEIL

Описание

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

Формула вычисления даты:

$$\begin{aligned} &\text{hour\_ceil}(\langle\text{date\_or\_time\_expr}\rangle, \langle\text{period}\rangle, \langle\text{origin}\rangle) = \\ &\min\{\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} \geq \langle\text{date\_or\_time\_expr}\rangle\} \end{aligned}$$

$k$ обозначает количество периодов, необходимых для перехода от исходной точки отсчёта времени к целевому времени.

Синтаксис

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

Параметры

Параметр	Описание
<date_or_time_expr>	Допустимое выражение даты с поддержкой DATE, DATETIME, TIMESTAMP_NS и TIMESTAMPTZ. Входное значение DATE интерпретируется как начало дня в 00:00:00. Подробнее о форматах см. преобразование timestamptz, преобразование datetime и преобразование date.
<period>	Необязательный параметр, задающий длительность периода (единица измерения: часы); должен быть положительным целым числом (например, 1, 3, 5). Значение по умолчанию равно 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), после чего выполняется вычисление CEIL.
• Если входные значения времени (<date_or_time_expr> и <period>) одновременно содержат типы TIMESTAMPTZ и DATETIME, результат имеет тип DATETIME.
• Если период задан неположительным целым числом, возвращается ошибка.
• Если любой из параметров равен NULL, результат равен NULL.
• Если для origin или datetime задана точность дробной части секунды, возвращаемый результат также имеет такую точность.
• Если результат вычисления превышает максимальное значение даты и времени 9999-12-31 23:59:59, возвращается ошибка.
• Если дата и время находятся после , вычисление всё равно выполняется по приведённой выше формуле, но число периодов k будет отрицательным.

Примеры

-- Round up with a 5-hour period
mysql> select hour_ceil("2023-07-13 22:28:18", 5);
+-------------------------------------+
| hour_ceil("2023-07-13 22:28:18", 5) |
+-------------------------------------+
| 2023-07-13 23:00:00                 |
+-------------------------------------+

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

-- Input date type will be converted to the start time 00:00:00 of the corresponding date
mysql> select hour_ceil('2023-07-13 00:30:00', 6, '2023-07-13');
+---------------------------------------------------+
| hour_ceil('2023-07-13 00:30:00', 6, '2023-07-13') |
+---------------------------------------------------+
| 2023-07-13 06:00:00                               |
+---------------------------------------------------+

-- If exactly at the edge of a period, return the input datetime
select hour_ceil('2023-07-13 01:00:00');
+----------------------------------+
| hour_ceil('2023-07-13 01:00:00') |
+----------------------------------+
| 2023-07-13 01:00:00              |
+----------------------------------+

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

-- If origin or datetime has scale, the returned result has scale
mysql> select hour_ceil('2023-07-13 19:30:00', 4, '2023-07-13 08:00:00.123') ;
+----------------------------------------------------------------+
| hour_ceil('2023-07-13 19:30:00', 4, '2023-07-13 08:00:00.123') |
+----------------------------------------------------------------+
| 2023-07-13 20:00:00.123                                        |
+----------------------------------------------------------------+

mysql> select hour_ceil('2023-07-13 19:30:00.123', 4, '2023-07-13 08:00:00') ;
+----------------------------------------------------------------+
| hour_ceil('2023-07-13 19:30:00.123', 4, '2023-07-13 08:00:00') |
+----------------------------------------------------------------+
| 2023-07-13 20:00:00.000                                        |
+----------------------------------------------------------------+

--- 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_ceil('2023-07-13 19:30:00.123', 4, '2028-07-14 08:00:00') ;
+----------------------------------------------------------------+
| hour_ceil('2023-07-13 19:30:00.123', 4, '2028-07-14 08:00:00') |
+----------------------------------------------------------------+
| 2023-07-13 20:00:00.000                                        |
+----------------------------------------------------------------+

-- If calculation result exceeds maximum datetime range 9999-12-31 23:59:59, return error
select hour_ceil("9999-12-31 22:28:18", 6);
ERROR 1105 (HY000): errCode = 2, detailMessage = (10.16.10.3)[E-218]Operation hour_ceil of 9999-12-31 22:28:18, 6 out of range

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

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

-- If period is less than or equal to 0, return error
mysql> select hour_ceil("2023-07-13 22:28:18", 0);
ERROR 1105 (HY000): errCode = 2, detailMessage = (10.16.10.3)[E-218]Operation hour_ceil of 2023-07-13 22:28:18, 0 out of range

-- If any input parameter is NULL, return NULL
mysql> select hour_ceil(null, 3) as null_input;
+------------+
| null_input |
+------------+
| NULL       |
+------------+

mysql> select hour_ceil("2023-07-13 22:28:18", NULL);
+----------------------------------------+
| hour_ceil("2023-07-13 22:28:18", NULL) |
+----------------------------------------+
| NULL                                   |
+----------------------------------------+

mysql> select hour_ceil("2023-07-13 22:28:18", 5,NULL);
+------------------------------------------+
| hour_ceil("2023-07-13 22:28:18", 5,NULL) |
+------------------------------------------+
| NULL                                     |
+------------------------------------------+