MONTHS_BETWEEN（Lakehouse v1）

返回 date1 与 date2 之间相差的月数。

Analyze 语法

func.months_between(<date1>, <date2>)

Analyze 示例

func.months_between(func.to_date('2024-03-15'), func.to_date('2024-02-15'))
┌───────────────────────────────────────────────────────────────────────────────┐
│ func.months_between(func.to_date('2024-03-15'), func.to_date('2024-02-15'))   │
├───────────────────────────────────────────────────────────────────────────────┤
│ 1                                                                             │
└───────────────────────────────────────────────────────────────────────────────┘

func.months_between(func.to_date('2024-02-15'), func.to_date('2024-03-15'))
┌───────────────────────────────────────────────────────────────────────────────┐
│ func.months_between(func.to_date('2024-02-15'), func.to_date('2024-03-15'))   │
├───────────────────────────────────────────────────────────────────────────────┤
│ -1                                                                             │
└───────────────────────────────────────────────────────────────────────────────┘

SQL 语法

MONTHS_BETWEEN( <date1>, <date2> )

参数

date1 和 date2 可以是 DATE 类型、TIMESTAMP 类型，或两者混合。

返回类型

函数返回 FLOAT 值，规则如下：

• 如果 date1 早于 date2，函数返回负值；否则返回正值。

  SELECT
      MONTHS_BETWEEN('2024-03-15'::DATE,
                  '2024-02-15'::DATE),
      MONTHS_BETWEEN('2024-02-15'::DATE,
                  '2024-03-15'::DATE);
  
  -[ RECORD 1 ]-----------------------------------
  months_between('2024-03-15'::date, '2024-02-15'::date): 1
  months_between('2024-02-15'::date, '2024-03-15'::date): -1

• 如果 date1 和 date2 在各自月份中处于同一天，或都是各自月份的最后一天，则结果为整数。否则，函数按每月 31 天计算结果的小数部分。

  SELECT
      MONTHS_BETWEEN('2024-02-29'::DATE,
                  '2024-01-29'::DATE),
      MONTHS_BETWEEN('2024-02-29'::DATE,
                  '2024-01-31'::DATE);
  
  -[ RECORD 1 ]-----------------------------------
  months_between('2024-02-29'::date, '2024-01-29'::date): 1
  months_between('2024-02-29'::date, '2024-01-31'::date): 1
  
  SELECT
      MONTHS_BETWEEN('2024-08-05'::DATE,
                  '2024-01-01'::DATE);
  
  -[ RECORD 1 ]-----------------------------------
  months_between('2024-08-05'::date, '2024-01-01'::date): 7.129032258064516

• 如果 date1 和 date2 是同一日期，函数会忽略任何时间部分并返回 0。

  SELECT
      MONTHS_BETWEEN('2024-08-05'::DATE,
                  '2024-08-05'::DATE),
      MONTHS_BETWEEN('2024-08-05 02:00:00'::TIMESTAMP,
                  '2024-08-05 01:00:00'::TIMESTAMP);
  
  -[ RECORD 1 ]-----------------------------------
                              months_between('2024-08-05'::date, '2024-08-05'::date): 0
  months_between('2024-08-05 02:00:00'::timestamp, '2024-08-05 01:00:00'::timestamp): 0