YEAR_FLOOR

Описание

Функция year_floor округляет входное значение даты и времени вниз до начала ближайшего интервала заданной длительности в годах. Если указан origin, он используется как точка отсчёта; в противном случае по умолчанию используется 0000-01-01 00:00:00.

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

$$\begin{aligned} &\text{year\_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{year} \mid \\ &k \in \mathbb{Z} \land \langle\text{origin}\rangle + k \times \langle\text{period}\rangle \times \text{year} \leq \langle\text{date\_or\_time\_expr}\rangle\} \end{aligned}$$

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

Синтаксис

YEAR_FLOOR(<date_or_time_expr>)
YEAR_FLOOR(<date_or_time_expr>, origin)
YEAR_FLOOR(<date_or_time_expr>, <period>)
YEAR_FLOOR(<date_or_time_expr>, <period>, <origin>)

Параметры

Параметр	Описание
<date_or_time_expr>	Значение даты и времени для округления вниз; поддерживаются типы date/datetime/timestamptz. Значение типа date преобразуется во время начала соответствующей даты, 00:00:00. Подробнее о форматах см. в разделах преобразование timestamptz, преобразование datetime и преобразование date
<period>	Необязательный параметр, задающий количество лет в каждом интервале; поддерживаются положительные целые числа типа INT. По умолчанию: 1 год.
<origin_datetime>	Начальная точка интервала; поддерживаются типы date/datetime; по умолчанию используется 0000-01-01 00:00:00.

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

Возвращает результат того же типа, что и входное значение (TIMESTAMPTZ, DATETIME или DATE), представляющий время начала годового интервала после округления вниз:

• Если входное значение имеет тип DATE, возвращается тип DATE (содержащий только дату); если входное значение имеет тип DATETIME или является строкой в корректном формате, возвращается тип DATETIME (временная часть соответствует origin; если origin не указан, по умолчанию используется 00:00:00).
• Если <period> является неположительным целым числом (≤0), функция возвращает ошибку.
• Если любой из параметров равен NULL, возвращается NULL.
• Если <date_or_time_expr> точно совпадает с началом интервала (определяемого по <period> и <origin>), возвращается эта начальная точка.
• Если результат вычисления превышает максимальное значение даты и времени 9999-12-31 23:59:59, возвращается ошибка.
• Если дата и время <origin> находятся позже <period>, вычисление всё равно выполняется по приведённой выше формуле, но значение k будет отрицательным.
• Если для date_or_time_expr задан масштаб, возвращаемый результат также будет иметь масштаб, а дробная часть будет нулевой.
• Если входное значение имеет тип 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.

Примеры

-- Default 1-year interval (start point is January 1st each year), 2023-07-13 rounds down to 2023-01-01
SELECT YEAR_FLOOR('2023-07-13 22:28:18') AS result;
+---------------------+
| result              |
+---------------------+
| 2023-01-01 00:00:00 |
+---------------------+

-- Specify 5-year interval, 2023-07-13 rounds down to nearest 5-year interval start (calculated with default origin)
SELECT YEAR_FLOOR('2023-07-13 22:28:18', 5) AS result;
+---------------------+
| result              |
+---------------------+
| 2020-01-01 00:00:00 |  
+---------------------+

-- input with scale
mysql> SELECT YEAR_FLOOR('2023-07-13 22:28:18.123', 5) AS result;
+-------------------------+
| result                  |
+-------------------------+
| 2021-01-01 00:00:00.000 |
+-------------------------+

-- Input is DATE type, returns DATE type interval start
SELECT YEAR_FLOOR(cast('2023-07-13' as date)) AS result;
+------------+
| result     |
+------------+
| 2023-01-01 |
+------------+

-- Only with origin date and specified date
select year_floor("2023-07-13 22:28:18", "2021-03-13 22:13:00");
+----------------------------------------------------------+
| year_floor("2023-07-13 22:28:18", "2021-03-13 22:13:00") |
+----------------------------------------------------------+
| 2023-03-13 22:13:00                                      |
+----------------------------------------------------------+

-- Specify origin reference point='2020-01-01', 1-year interval, 2023-07-13 rounds to 2023-01-01
SELECT YEAR_FLOOR('2023-07-13', 1, '2020-01-01') AS result;
+---------------------+
| result              |
+---------------------+
| 2023-01-01 00:00:00 |
+---------------------+

-- Specify origin with time part, returned result's time part matches origin
SELECT YEAR_FLOOR('2023-07-13', 1, '2020-01-01 08:30:00') AS result;
+---------------------+
| result              |
+---------------------+
| 2023-01-01 08:30:00 |
+---------------------+

-- Input exactly at interval start point (origin='2023-01-01', period=1), returns itself
SELECT YEAR_FLOOR('2023-01-01', 1, '2023-01-01') AS result;
+---------------------+
| result              |
+---------------------+
| 2023-01-01 00:00:00 |
+---------------------+

-- Input time earlier than origin start time, rounds down to earlier interval point
SELECT YEAR_FLOOR('2019-07-13', 1, '2020-01-01') AS result;
+---------------------+
| result              |
+---------------------+
| 2019-01-01 00:00:00 |
+---------------------+

-- Cross-multiple periods rounding down, period=3, origin='2020-01-01'
SELECT YEAR_FLOOR('2025-07-13', 3, '2020-01-01') AS result;
+---------------------+
| result              |
+---------------------+
| 2023-01-01 00:00:00 |
+---------------------+

-- 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 YEAR_FLOOR('2023-07-13 22:22:56', 1, '2028-01-01 08:30:00') AS result;
+---------------------+
| result              |
+---------------------+
| 2023-01-01 08:30:00 |
+---------------------+

-- Input time part earlier than origin time part, rounds down within same year
SELECT YEAR_FLOOR('2023-07-13 06:00:00', 1, '2020-01-01 08:30:00') AS result;
+---------------------+
| result              |
+---------------------+
| 2022-01-01 08:30:00 |
+---------------------+

-- Input time part later than origin time part, normal rounding down
SELECT YEAR_FLOOR('2023-07-13 10:00:00', 1, '2020-01-01 08:30:00') AS result;
+---------------------+
| result              |
+---------------------+
| 2023-01-01 08:30:00 |
+---------------------+

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

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

-- Invalid period (non-positive integer)
SELECT YEAR_FLOOR('2023-07-13', 0) AS result;
ERROR 1105 (HY000): errCode = 2, detailMessage = (10.16.10.3)[E-218]Operation year_floor of 2023-07-13 00:00:00, 0 out of range

-- Any parameter is NULL, returns NULL
SELECT YEAR_FLOOR(NULL, 1) AS result;
+--------+
| result |
+--------+
| NULL   |
+--------+