Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add functions PERIOD_ADD and PERIOD_DIFF. #933

Merged
merged 2 commits into from
Oct 28, 2022
Merged

Add functions PERIOD_ADD and PERIOD_DIFF. #933

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93b229d
Add functions `PERIOD_ADD` and `PERIOD_DIFF`.
Yury-Fridlyand Oct 7, 2022
957c00f
Update signature - use `INT` instead of `LONG`.
Yury-Fridlyand Oct 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
235 changes: 157 additions & 78 deletions core/src/main/java/org/opensearch/sql/expression/datetime/DateTimeFunction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

package org.opensearch.sql.expression.datetime;

import static java.time.temporal.ChronoUnit.MONTHS;
import static org.opensearch.sql.data.type.ExprCoreType.DATE;
import static org.opensearch.sql.data.type.ExprCoreType.DATETIME;
import static org.opensearch.sql.data.type.ExprCoreType.DOUBLE;
Expand Down Expand Up @@ -68,6 +69,7 @@
* 2) the implementation should rely on ExprValue.
*/
@UtilityClass
@SuppressWarnings("unchecked")
public class DateTimeFunction {
// The number of days from year zero to year 1970.
private static final Long DAYS_0000_TO_1970 = (146097 * 5L) - (30L * 365L + 7L);
Expand All @@ -84,6 +86,11 @@ public class DateTimeFunction {
public void register(BuiltinFunctionRepository repository) {
repository.register(adddate());
repository.register(convert_tz());
repository.register(curtime());
repository.register(curdate());
repository.register(current_date());
repository.register(current_time());
repository.register(current_timestamp());
repository.register(date());
repository.register(datetime());
repository.register(date_add());
Expand All @@ -96,15 +103,21 @@ public void register(BuiltinFunctionRepository repository) {
repository.register(from_days());
repository.register(from_unixtime());
repository.register(hour());
repository.register(localtime());
repository.register(localtimestamp());
repository.register(makedate());
repository.register(maketime());
repository.register(microsecond());
repository.register(minute());
repository.register(month());
repository.register(monthName());
repository.register(now());
repository.register(period_add());
repository.register(period_diff());
repository.register(quarter());
repository.register(second());
repository.register(subdate());
repository.register(sysdate());
repository.register(time());
repository.register(time_to_sec());
repository.register(timestamp());
Expand All @@ -113,84 +126,6 @@ public void register(BuiltinFunctionRepository repository) {
repository.register(unix_timestamp());
repository.register(week());
repository.register(year());

repository.register(now());
repository.register(current_timestamp());
repository.register(localtimestamp());
repository.register(localtime());
repository.register(sysdate());
repository.register(curtime());
repository.register(current_time());
repository.register(curdate());
repository.register(current_date());
}

/**
* NOW() returns a constant time that indicates the time at which the statement began to execute.
* `fsp` argument support is removed until refactoring to avoid bug where `now()`, `now(x)` and
* `now(y) return different values.
*/
private FunctionResolver now(FunctionName functionName) {
return define(functionName,
impl(() -> new ExprDatetimeValue(formatNow(null)), DATETIME)
);
}

private FunctionResolver now() {
return now(BuiltinFunctionName.NOW.getName());
}

private FunctionResolver current_timestamp() {
return now(BuiltinFunctionName.CURRENT_TIMESTAMP.getName());
}

private FunctionResolver localtimestamp() {
return now(BuiltinFunctionName.LOCALTIMESTAMP.getName());
}

private FunctionResolver localtime() {
return now(BuiltinFunctionName.LOCALTIME.getName());
}

/**
* SYSDATE() returns the time at which it executes.
*/
private FunctionResolver sysdate() {
return define(BuiltinFunctionName.SYSDATE.getName(),
impl(() -> new ExprDatetimeValue(formatNow(null)), DATETIME),
impl((v) -> new ExprDatetimeValue(formatNow(v.integerValue())), DATETIME, INTEGER)
);
}

/**
* Synonym for @see `now`.
*/
private FunctionResolver curtime(FunctionName functionName) {
return define(functionName,
impl(() -> new ExprTimeValue(formatNow(null).toLocalTime()), TIME)
);
}

private FunctionResolver curtime() {
return curtime(BuiltinFunctionName.CURTIME.getName());
}

private FunctionResolver current_time() {
return curtime(BuiltinFunctionName.CURRENT_TIME.getName());
}

private FunctionResolver curdate(FunctionName functionName) {
return define(functionName,
impl(() -> new ExprDateValue(formatNow(null).toLocalDate()), DATE)
);
}

private FunctionResolver curdate() {
return curdate(BuiltinFunctionName.CURDATE.getName());
}

private FunctionResolver current_date() {
return curdate(BuiltinFunctionName.CURRENT_DATE.getName());
}

/**
Expand Down Expand Up @@ -236,6 +171,41 @@ private DefaultFunctionResolver convert_tz() {
);
}

private FunctionResolver curdate(FunctionName functionName) {
return define(functionName,
impl(() -> new ExprDateValue(formatNow(null).toLocalDate()), DATE)
);
}

private FunctionResolver curdate() {
return curdate(BuiltinFunctionName.CURDATE.getName());
}

/**
* Synonym for @see `now`.
*/
private FunctionResolver curtime(FunctionName functionName) {
return define(functionName,
impl(() -> new ExprTimeValue(formatNow(null).toLocalTime()), TIME)
);
}

private FunctionResolver curtime() {
return curtime(BuiltinFunctionName.CURTIME.getName());
}

private FunctionResolver current_date() {
return curdate(BuiltinFunctionName.CURRENT_DATE.getName());
}

private FunctionResolver current_time() {
return curtime(BuiltinFunctionName.CURRENT_TIME.getName());
}

private FunctionResolver current_timestamp() {
return now(BuiltinFunctionName.CURRENT_TIMESTAMP.getName());
}

/**
* Extracts the date part of a date and time value.
* Also to construct a date type. The supported signatures:
Expand Down Expand Up @@ -386,6 +356,29 @@ private DefaultFunctionResolver hour() {
);
}

private FunctionResolver localtime() {
return now(BuiltinFunctionName.LOCALTIME.getName());
}

private FunctionResolver localtimestamp() {
return now(BuiltinFunctionName.LOCALTIMESTAMP.getName());
}

/**
* NOW() returns a constant time that indicates the time at which the statement began to execute.
* `fsp` argument support is removed until refactoring to avoid bug where `now()`, `now(x)` and
* `now(y) return different values.
*/
private FunctionResolver now(FunctionName functionName) {
return define(functionName,
impl(() -> new ExprDatetimeValue(formatNow(null)), DATETIME)
);
}

private FunctionResolver now() {
return now(BuiltinFunctionName.NOW.getName());
}

private FunctionResolver makedate() {
return define(BuiltinFunctionName.MAKEDATE.getName(),
impl(nullMissingHandling(DateTimeFunction::exprMakeDate), DATE, DOUBLE, DOUBLE));
Expand Down Expand Up @@ -444,6 +437,27 @@ private DefaultFunctionResolver monthName() {
);
}

/**
* Add N months to period P (in the format YYMM or YYYYMM). Returns a value in the format YYYYMM.
* (LONG, LONG) -> LONG
*/
private DefaultFunctionResolver period_add() {
return define(BuiltinFunctionName.PERIOD_ADD.getName(),
impl(nullMissingHandling(DateTimeFunction::exprPeriodAdd), LONG, LONG, LONG)
);
}

/**
* Returns the number of months between periods P1 and P2.
* P1 and P2 should be in the format YYMM or YYYYMM.
* (LONG, LONG) -> LONG
*/
private DefaultFunctionResolver period_diff() {
return define(BuiltinFunctionName.PERIOD_DIFF.getName(),
impl(nullMissingHandling(DateTimeFunction::exprPeriodDiff), LONG, LONG, LONG)
);
}

/**
* QUARTER(STRING/DATE/DATETIME/TIMESTAMP). return the month for date (1-4).
*/
Expand Down Expand Up @@ -889,6 +903,61 @@ private ExprValue exprMonthName(ExprValue date) {
date.dateValue().getMonth().getDisplayName(TextStyle.FULL, Locale.getDefault()));
}

private LocalDate parseDatePeriod(Long period) {
var input = period.toString();
// MySQL undocumented: if year is not specified or has 1 digit - 2000/200x is assumed
if (input.length() <= 5) {
input = String.format("200%05d", period);
}
try {
return LocalDate.parse(input, DATE_FORMATTER_SHORT_YEAR);
} catch (DateTimeParseException ignored) {
// nothing to do, try another format
}
try {
return LocalDate.parse(input, DATE_FORMATTER_LONG_YEAR);
} catch (DateTimeParseException ignored) {
return null;
}
}

/**
* Adds N months to period P (in the format YYMM or YYYYMM).
* Returns a value in the format YYYYMM.
*
* @param period Period in the format YYMM or YYYYMM.
* @param months Amount of months to add.
* @return ExprLongValue.
*/
private ExprValue exprPeriodAdd(ExprValue period, ExprValue months) {
// We should add a day to make string parsable and remove it afterwards
var input = period.longValue() * 100 + 1; // adds 01 to end of the string
var parsedDate = parseDatePeriod(input);
if (parsedDate == null) {
return ExprNullValue.of();
}
var res = DATE_FORMATTER_LONG_YEAR.format(parsedDate.plusMonths(months.longValue()));
return new ExprLongValue(Long.parseLong(
res.substring(0, res.length() - 2))); // Remove the day part, .eg. 20070101 -> 200701
}

/**
* Returns the number of months between periods P1 and P2.
* P1 and P2 should be in the format YYMM or YYYYMM.
*
* @param period1 Period in the format YYMM or YYYYMM.
* @param period2 Period in the format YYMM or YYYYMM.
* @return ExprLongValue.
*/
private ExprValue exprPeriodDiff(ExprValue period1, ExprValue period2) {
var parsedDate1 = parseDatePeriod(period1.longValue() * 100 + 1);
var parsedDate2 = parseDatePeriod(period2.longValue() * 100 + 1);
if (parsedDate1 == null || parsedDate2 == null) {
return ExprNullValue.of();
}
return new ExprLongValue(MONTHS.between(parsedDate2, parsedDate1));
}

/**
* Quarter for date implementation for ExprValue.
*
Expand Down Expand Up @@ -936,6 +1005,16 @@ private ExprValue exprSubDateInterval(ExprValue date, ExprValue expr) {
: exprValue);
}

/**
* SYSDATE() returns the time at which it executes.
*/
private FunctionResolver sysdate() {
return define(BuiltinFunctionName.SYSDATE.getName(),
impl(() -> new ExprDatetimeValue(formatNow(null)), DATETIME),
impl((v) -> new ExprDatetimeValue(formatNow(v.integerValue())), DATETIME, INTEGER)
);
}

/**
* Time implementation for ExprValue.
*
Expand Down
2 changes: 2 additions & 0 deletions core/src/main/java/org/opensearch/sql/expression/function/BuiltinFunctionName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ public enum BuiltinFunctionName {
MINUTE(FunctionName.of("minute")),
MONTH(FunctionName.of("month")),
MONTHNAME(FunctionName.of("monthname")),
PERIOD_ADD(FunctionName.of("period_add")),
PERIOD_DIFF(FunctionName.of("period_diff")),
QUARTER(FunctionName.of("quarter")),
SECOND(FunctionName.of("second")),
SUBDATE(FunctionName.of("subdate")),
Expand Down
Loading