AddMonths (PQL)
Returns a new date-time with the number of months added
- Returned Output: Date-Time
- Library: PQL \ Granular \ Date-Time
- Version: 2023.00.000
- Compatibility: Pyramid Query Language (PQL) data sources
Syntax
AddMonths( <Column DateTime> , <Integer> )
* Click on the function's arguments above for more details on the input values.
Comments
- The column needs to be an attribute with date-time values in the model. (The data type needs to be 'date-time')
- Use a positive integer to count months forward from each date in the column, in order to return a dates after the original date.
- Use negative integers to return a specified month prior to each date in the column.
- For details on how to employ and use this function see the custom column overview.
Different Function types
- This function is similar to the PQL semantic and common functions of the same name. However, it operates on a column directly at the grain.
- As a granular function, it is used in the base SQL query itself.
Examples
This example adds 3 months to each date in the Order Date column.
AddMonths( [Data].[OrderDate], 3 )
If the figure had been set to "-3" the result would reduce 3 months from each date in the column.
You can see the effect from this example snippet in column #5, based on the original date column in position #1.
