Add `TIMESTAMPADD` Function To OpenSearch SQL Plugin #246

GabeFernandez310 · 2023-03-15T21:54:17Z

Description

Adds the timestampadd() function to the OpenSearch SQL Plugin. Based off of the MySQL Implementation, but some changes were made due to the limitations of the plugin. Specifically, the return of this function is always a DATETIME. If an argument of type TIME is provided for the third argument, the DATE portion of the returned DATETIME will be filled in with values using the current date.

Examples:

opensearchsql> SELECT TIMESTAMPADD(MINUTE, 1, '2003-01-02 00:00:00');
fetched rows / total rows = 1/1
+--------------------------------------------------+
| TIMESTAMPADD(MINUTE, 1, '2003-01-02 00:00:00')   |
|--------------------------------------------------|
| 2003-01-02 00:01:00                              |
+--------------------------------------------------+

opensearchsql> SELECT TIMESTAMPADD(WEEK, 1, '2003-01-02 00:00:00');
fetched rows / total rows = 1/1
+------------------------------------------------+
| TIMESTAMPADD(WEEK, 1, '2003-01-02 00:00:00')   |
|------------------------------------------------|
| 2003-01-09 00:00:00                            |
+------------------------------------------------+

opensearchsql> SELECT TIMESTAMPADD(QUARTER, 1, '2003-01-02 00:00:00');
fetched rows / total rows = 1/1
+---------------------------------------------------+
| TIMESTAMPADD(QUARTER, 1, '2003-01-02 00:00:00')   |
|---------------------------------------------------|
| 2003-04-02 00:00:00                               |
+---------------------------------------------------+

Issues Resolved

722

Check List

New functionality includes testing.
- All tests pass, including unit test, integration test and doctest
New functionality has been documented.
- New functionality has javadoc added
- New functionality has user manual doc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: GabeFernandez310 <[email protected]>

codecov · 2023-03-15T22:14:43Z

Codecov Report

❗ No coverage uploaded for pull request base (integ-add-timestampadd-function@bc39346). Click here to learn what that means.
The diff coverage is n/a.

@@                        Coverage Diff                         @@
##             integ-add-timestampadd-function     #246   +/-   ##
==================================================================
  Coverage                                   ?   98.44%           
  Complexity                                 ?     3806           
==================================================================
  Files                                      ?      343           
  Lines                                      ?     9449           
  Branches                                   ?      601           
==================================================================
  Hits                                       ?     9302           
  Misses                                     ?      142           
  Partials                                   ?        5

Flag	Coverage Δ
sql-engine	`98.44% <0.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

core/src/main/java/org/opensearch/sql/expression/datetime/DateTimeFunction.java

Yury-Fridlyand · 2023-03-15T22:09:13Z

core/src/test/java/org/opensearch/sql/expression/datetime/TimeStampAddTest.java

+            "2021-01-07 23:59:59"),
+
+        //Test remaining interval types
+        Arguments.of("MICROSECOND", 1, new ExprStringValue("2003-01-02 00:00:00"),


Need to test adding a month (see special cases given in example on MySQL doc)
Test negative values and values > 1[00] too

Yes. -1 Microsecond from 2000-01-01 00:00:00

Added in 77226ba

core/src/main/java/org/opensearch/sql/expression/datetime/DateTimeFunction.java

docs/user/dql/functions.rst

sql/src/main/antlr/OpenSearchSQLParser.g4

acarbonetto · 2023-03-16T01:55:38Z

core/src/main/java/org/opensearch/sql/expression/function/FunctionDSL.java

+    return (functionProperties, v1, v2, v3) -> {
+      if (v1.isMissing() || v2.isMissing() || v3.isMissing()) {
+        return ExprValueUtils.missingValue();
+      } else if (v1.isNull() || v2.isNull() || v3.isNull()) {


else not needed

Changed in 77226ba

acarbonetto · 2023-03-16T01:55:44Z

core/src/main/java/org/opensearch/sql/expression/function/FunctionDSL.java

+        return ExprValueUtils.missingValue();
+      } else if (v1.isNull() || v2.isNull() || v3.isNull()) {
+        return ExprValueUtils.nullValue();
+      } else {


else not needed

Changed in 77226ba

acarbonetto · 2023-03-16T16:01:00Z

core/src/main/java/org/opensearch/sql/expression/function/FunctionDSL.java

+   * @param returnType return type.
+   * @param args1Type first argument type.
+   * @param args2Type second argument type.
+   * @param args3Type second argument type.


Suggested change

* @param args3Type second argument type.

* @param args3Type third argument type.

Changed in 77226ba

acarbonetto · 2023-03-16T16:02:23Z

core/src/test/java/org/opensearch/sql/expression/datetime/TimeStampAddTest.java

+            "2021-01-07 23:59:59"),
+
+        //Test remaining interval types
+        Arguments.of("MICROSECOND", 1, new ExprStringValue("2003-01-02 00:00:00"),


Yes. -1 Microsecond from 2000-01-01 00:00:00

acarbonetto · 2023-03-16T16:03:00Z

core/src/test/java/org/opensearch/sql/expression/datetime/TimeStampAddTest.java

+  @Test
+  public void testAddingDatePartToTime() {
+    String interval = "WEEK";
+    int addedInterval = 1;


Add tests with interval != 1.

Changed in 77226ba

Signed-off-by: GabeFernandez310 <[email protected]>

…add-function

Signed-off-by: GabeFernandez310 <[email protected]>

GabeFernandez310 · 2023-03-17T15:24:22Z

core/src/test/java/org/opensearch/sql/expression/datetime/TimeStampAddTest.java

+            "2003-01-02 00:01:00"),
+        Arguments.of("WEEK", 1, new ExprDatetimeValue("2003-01-02 00:00:00"),
+            "2003-01-09 00:00:00"),
+        //timstamp


Fix spelling. Add white space between groups of tests.

Suggested change

//timstamp

//Timestamp

GabeFernandez310 added 9 commits March 14, 2023 13:57

Added Test File And Some Unit Tests

6af03f2

Signed-off-by: GabeFernandez310 <[email protected]>

Added More Unit Tests And IT Tests

6e51647

Signed-off-by: GabeFernandez310 <[email protected]>

Added Basic Implementation

2ddb8d0

Signed-off-by: GabeFernandez310 <[email protected]>

Fixed Implementation And Tests

6a3b0f3

Signed-off-by: GabeFernandez310 <[email protected]>

Fixed Implementation To Work With Date, Datetime, Timestamp types

7f0d351

Signed-off-by: GabeFernandez310 <[email protected]>

Added support for time type

4733a04

Signed-off-by: GabeFernandez310 <[email protected]>

Added Documentation And Fixed Implementation

358db44

Signed-off-by: GabeFernandez310 <[email protected]>

Fixed Checkstyle

d04781c

Signed-off-by: GabeFernandez310 <[email protected]>

Added Tests, Fixed Tests And Implementation

264f16b

Signed-off-by: GabeFernandez310 <[email protected]>

Yury-Fridlyand reviewed Mar 15, 2023

View reviewed changes

acarbonetto reviewed Mar 16, 2023

View reviewed changes

GabeFernandez310 added 7 commits March 16, 2023 14:37

Added Tests

77226ba

Signed-off-by: GabeFernandez310 <[email protected]>

Altered Documentation

c960a1c

Signed-off-by: GabeFernandez310 <[email protected]>

Merge branch 'integ-add-timestampadd-function' into dev-add-timestamp…

5216b04

…add-function

Added Test Class

5baab54

Signed-off-by: GabeFernandez310 <[email protected]>

Reworked Parser

e2fdcd1

Signed-off-by: GabeFernandez310 <[email protected]>

Added Tests To Fix JaCoCo

fb2da46

Signed-off-by: GabeFernandez310 <[email protected]>

Fixed Checkstyle

f264113

Signed-off-by: GabeFernandez310 <[email protected]>

Yury-Fridlyand approved these changes Mar 16, 2023

View reviewed changes

GabeFernandez310 marked this pull request as ready for review March 17, 2023 14:53

GabeFernandez310 requested a review from a team March 17, 2023 14:54

GabeFernandez310 commented Mar 17, 2023

View reviewed changes

acarbonetto approved these changes Mar 17, 2023

View reviewed changes

matthewryanwells approved these changes Mar 17, 2023

View reviewed changes

GabeFernandez310 merged commit b9b1470 into integ-add-timestampadd-function Mar 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `TIMESTAMPADD` Function To OpenSearch SQL Plugin #246

Add `TIMESTAMPADD` Function To OpenSearch SQL Plugin #246

GabeFernandez310 commented Mar 15, 2023

codecov bot commented Mar 15, 2023 •

edited

Loading

Yury-Fridlyand Mar 15, 2023

acarbonetto Mar 16, 2023

GabeFernandez310 Mar 16, 2023

acarbonetto Mar 16, 2023

GabeFernandez310 Mar 16, 2023

acarbonetto Mar 16, 2023

GabeFernandez310 Mar 16, 2023

acarbonetto Mar 16, 2023

GabeFernandez310 Mar 16, 2023

acarbonetto Mar 16, 2023

acarbonetto Mar 16, 2023

GabeFernandez310 Mar 16, 2023

GabeFernandez310 Mar 17, 2023

	* @param args3Type second argument type.
	* @param args3Type third argument type.

Add TIMESTAMPADD Function To OpenSearch SQL Plugin #246

Add TIMESTAMPADD Function To OpenSearch SQL Plugin #246

Conversation

GabeFernandez310 commented Mar 15, 2023

Description

Issues Resolved

Check List

codecov bot commented Mar 15, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `TIMESTAMPADD` Function To OpenSearch SQL Plugin #246

Add `TIMESTAMPADD` Function To OpenSearch SQL Plugin #246

codecov bot commented Mar 15, 2023 •

edited

Loading