Adds or subtracts years, months and days to or from date values.
DATEOFFSET(date, years, months, days)
date |
- |
A date series. |
years |
- |
A scalar or series, the year values. Defaults to 0. |
months |
- |
A scalar or series, the month values. Defaults to 0. |
days |
- |
A scalar or series, the day values. Defaults to 0. |
A date series.
W1: ymd2date(2030, 1, 1)
W2: dateoffset(w1, 1, 1, 1)
W1 contains the date time series:
1/01/2030
W2 adds 1 year, 1 month and 1 day to the date in W1. The resulting date is:
2/02/2031
W1: ymd2date(2030, 1, 1)
W2: dateoffset(w1, 1, 1, 1)
W3: dateoffset(w2, -1, -1, -1)
Same as above, except W3 removes the offset in W2 to return the same date as in W1:
1/01/2030
W1: grand(3, 100000);setdate(w0, "1/1/2030")
W2: col(getdt(w1), 1)
W3: dateoffset(w2, months:1..3, days:-3)
W1 generates a 3 point random series with a spacing between samples of 100000 seconds. The start date is set to 1/01/2030.
W2 obtains the date values for each sample of W1. W2 contains the date values:
1/01/2030
1/02/2030
1/03/2030
W3 adds 1 month to the first value, 2 months to the second value and 3 months to the last date value and then subtracts 3 days from each resulting date value. The date offset values are specified using the Parameter:Value syntax. The resulting date values are:
1/29/2030
2/27/2030
3/21/2030
W1: grand(3, 100000);setdate(w0, "1/1/2030")
W2: col(getdt(w1), 1)
W3: dateoffset(w2, months:-3, days:1..3)
W4: dateperiod(w2, w3)
W5: dateoffset(w3, w4)
W6: w2 == w5
Same as above except, W4 computes the period in years, months, and days between the date values in W2 and the date values in W3. The difference is 2 month and 30 days for the first value, 2 months and 29 days for the second value and 2 months 28 days for the last value.
W5 adds the offset values in W4 to the date values in W3. The resulting date values are the same as the original values in W2. In this case, subtracting 3 months and adding 1, 2 and 3 days to the date values in W2 is the same as subtracting 2 months and subtracting 30, 29, and 28 days to the date values in W2.
W6 compares the date values of W2 and W5, verifying the values are identical.
DATEOFFSET adds or subtracts years, months and days from a date series.
The offset values can be specified using the Parameter:Value syntax. For example:
dateoffset(date, months:3, days:5)
adds 3 months and 5 days to the date series date.
The offset values are always added in years, months and days.