datetime_add()

Learn how to use the datetime_add() function to calculate a new datetime.

Calculates a new datetime from a specified period multiplied by a specified amount, added to, or subtracted from a specified datetime.

Syntax

datetime_add(period,amount,datetime)

Parameters

NameTypeRequiredDescription
periodstring✔️The length of time by which to increment.
amountint✔️The number of periods to add to or subtract from datetime.
datetimedatetime✔️The date to increment by the result of the period x amount calculation.

Possible values of period:

  • Year
  • Quarter
  • Month
  • Week
  • Day
  • Hour
  • Minute
  • Second
  • Millisecond
  • Microsecond
  • Nanosecond

Returns

A datetime after a certain time/date interval has been added.

Examples

Period

print  year = datetime_add('year',1,make_datetime(2017,1,1)),
quarter = datetime_add('quarter',1,make_datetime(2017,1,1)),
month = datetime_add('month',1,make_datetime(2017,1,1)),
week = datetime_add('week',1,make_datetime(2017,1,1)),
day = datetime_add('day',1,make_datetime(2017,1,1)),
hour = datetime_add('hour',1,make_datetime(2017,1,1)),
minute = datetime_add('minute',1,make_datetime(2017,1,1)),
second = datetime_add('second',1,make_datetime(2017,1,1))

Output

yearquartermonthweekdayhourminutesecond
2018-01-01 00:00:00.00000002017-04-01 00:00:00.00000002017-02-01 00:00:00.00000002017-01-08 00:00:00.00000002017-01-02 00:00:00.00000002017-01-01 01:00:00.00000002017-01-01 00:01:00.00000002017-01-01 00:00:01.0000000

Amount

print  year = datetime_add('year',-5,make_datetime(2017,1,1)),
quarter = datetime_add('quarter',12,make_datetime(2017,1,1)),
month = datetime_add('month',-15,make_datetime(2017,1,1)),
week = datetime_add('week',100,make_datetime(2017,1,1))

Output

yearquartermonthweek
2012-01-01T00:00:00Z2020-01-01T00:00:00Z2015-10-01T00:00:00Z2018-12-02T00:00:00Z