メインコンテンツまでスキップ
バージョン: 26.x

MONTHS_SUB

説明

MONTHS_SUB関数は、入力されたdatetime値から指定された月数を減算し、結果として得られる新しいdatetime値を返します。この関数はDATEおよびDATETIME型の処理をサポートしています。負の数が入力された場合、対応する月数を加算することと等価です。

この関数は、MONTHを単位として使用する場合のdate_sub functionおよびMySQLのdate_sub functionと一致しています。

構文

MONTHS_SUB(`<date_or_time_expr>`, `<nums>`)

パラメータ

Parameterデスクリプション
<date_or_time_expr>月を減算する対象の日付値。date/datetime型をサポートします。具体的なdatetimeおよびdate形式については、datetime conversionおよびdate conversionを参照してください
<nums>減算する月数。INT型です。正の数値はdatetimeからnums月を減算することを示し、負の数値はnums月を加算することを示します。

Return Value

入力の<date_or_time_expr>と同じ型(DATEまたはDATETIME)の値を返し、基準時刻から指定された月数を減算した結果を表します。

  • <nums>が負の場合、この関数は基準時刻に対応する月数を加算するのと同じ動作をします(つまり、MONTHS_SUB(date, -n)はMONTHS_ADD(date, n)と等価です)。
  • 入力がDATE型(年、月、日のみを含む)の場合、結果はDATE型のまま保持されます。入力がDATETIME型の場合、結果は元の時刻コンポーネントを保持します(例:'2023-03-01 12:34:56'は1月減算後に'2023-02-01 12:34:56'になります)。
  • 入力日付が月の最終日で、対象月がその日付より少ない日数しかない場合、対象月の最終日に自動的に調整されます(例:3月31日から1月減算すると、うるう年かどうかに応じて2月28日または29日になります)。
  • 計算結果が日付型の有効範囲を超える場合(DATE型:0000-01-01から9999-12-31まで、DATETIME型:0000-01-01 00:00:00から9999-12-31 23:59:59まで)、エラーを返します。
  • いずれかのパラメータがNULLの場合、NULLを返します。

Examples

--- Subtract months from DATE type
SELECT MONTHS_SUB('2020-01-31', 1) AS result;
+------------+
| result |
+------------+
| 2019-12-31 |
+------------+

--- Subtract months from DATETIME type (preserves time component)
SELECT MONTHS_SUB('2020-01-31 02:02:02', 1) AS result;
+---------------------+
| result |
+---------------------+
| 2019-12-31 02:02:02 |
+---------------------+

--- Negative months (equivalent to addition)
SELECT MONTHS_SUB('2020-01-31', -1) AS result;
+------------+
| result |
+------------+
| 2020-02-29 |
+------------+

--- Non-end-of-month date subtracting months (direct decrement)
SELECT MONTHS_SUB('2023-07-13 22:28:18', 5) AS result;
+---------------------+
| result |
+---------------------+
| 2023-02-13 22:28:18 |
+---------------------+

--- DATETIME with microseconds (preserves precision)
SELECT MONTHS_SUB('2023-10-13 22:28:18.456789', 3) AS result;
+----------------------------+
| result |
+----------------------------+
| 2023-07-13 22:28:18.456789 |
+----------------------------+

--- Returns NULL when input is NULL
SELECT MONTHS_SUB(NULL, 5), MONTHS_SUB('2023-07-13', NULL) AS result;
+----------------------+--------+
| months_sub(NULL, 5) | result |
+----------------------+--------+
| NULL | NULL |
+----------------------+--------+

--- Calculation result exceeds date range
mysql> SELECT MONTHS_SUB('0000-01-01', 1) AS result;
ERROR 1105 (HY000): errCode = 2, detailMessage = (10.16.10.3)[E-218]Operation months_add of 0000-01-01, -1 out of range

mysql> SELECT MONTHS_SUB('9999-12-31', -1) AS result;
ERROR 1105 (HY000): errCode = 2, detailMessage = (10.16.10.3)[E-218]Operation months_add of 9999-12-31, 1 out of range