KysoqlReferenceAPI referenceFunctions
soqlRelativeDate
Generated API reference for soqlRelativeDate in @kysoql/core.
@kysoql/core / soqlRelativeDate
Call Signature
function soqlRelativeDate(value): SoqlRelativeDateLiteral;Creates a validated fixed or parameterized Salesforce relative-date literal.
Parameters
| Parameter | Type |
|---|---|
value | | "TODAY" | "YESTERDAY" | "TOMORROW" | "LAST_WEEK" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_MONTH" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_90_DAYS" | "NEXT_90_DAYS" | "LAST_QUARTER" | "THIS_QUARTER" | "NEXT_QUARTER" | "LAST_YEAR" | "THIS_YEAR" | "NEXT_YEAR" | "LAST_FISCAL_YEAR" | "THIS_FISCAL_YEAR" | "NEXT_FISCAL_YEAR" | "LAST_FISCAL_QUARTER" | "THIS_FISCAL_QUARTER" | "NEXT_FISCAL_QUARTER" |
Returns
Call Signature
function soqlRelativeDate(family, count): SoqlRelativeDateLiteral;Creates a validated fixed or parameterized Salesforce relative-date literal.
Parameters
| Parameter | Type |
|---|---|
family | | "LAST_N_DAYS" | "NEXT_N_DAYS" | "N_DAYS_AGO" | "LAST_N_WEEKS" | "NEXT_N_WEEKS" | "N_WEEKS_AGO" | "LAST_N_MONTHS" | "NEXT_N_MONTHS" | "N_MONTHS_AGO" | "LAST_N_QUARTERS" | "NEXT_N_QUARTERS" | "N_QUARTERS_AGO" | "LAST_N_YEARS" | "NEXT_N_YEARS" | "N_YEARS_AGO" | "LAST_N_FISCAL_QUARTERS" | "NEXT_N_FISCAL_QUARTERS" | "N_FISCAL_QUARTERS_AGO" | "LAST_N_FISCAL_YEARS" | "NEXT_N_FISCAL_YEARS" | "N_FISCAL_YEARS_AGO" |
count | number |