Add function name as identifier in antlr (#1015) (#1018)

Signed-off-by: Peng Huo <penghuo@gmail.com> (cherry picked from commit 2938890) Co-authored-by: Peng Huo <penghuo@gmail.com>
opensearch-project · Nov 3, 2022 · 7a6f71c · 7a6f71c
1 parent 3e17e23
commit 7a6f71c
Show file tree

Hide file tree

Showing 13 changed files with 175 additions and 138 deletions.
diff --git a/docs/user/dql/functions.rst b/docs/user/dql/functions.rst
@@ -987,17 +987,17 @@ CURRENT_DATE
 Description
 >>>>>>>>>>>
 
-`CURRENT_DATE` and `CURRENT_DATE()` are synonyms for `CURDATE() <#curdate>`_.
+`CURRENT_DATE()` are synonyms for `CURDATE() <#curdate>`_.
 
 Example::
 
-    > SELECT CURRENT_DATE(), CURRENT_DATE;
+    > SELECT CURRENT_DATE();
     fetched rows / total rows = 1/1
-    +------------------+----------------+
-    | CURRENT_DATE()   | CURRENT_DATE   |
-    |------------------+----------------|
-    | 2022-08-02       | 2022-08-02     |
-    +------------------+----------------+
+    +------------------+
+    | CURRENT_DATE()   |
+    |------------------+
+    | 2022-08-02       |
+    +------------------+
 
 
 CURRENT_TIME
@@ -1006,17 +1006,17 @@ CURRENT_TIME
 Description
 >>>>>>>>>>>
 
-`CURRENT_TIME` and `CURRENT_TIME()` are synonyms for `CURTIME() <#curtime>`_.
+`CURRENT_TIME()` are synonyms for `CURTIME() <#curtime>`_.
 
 Example::
 
-    > SELECT CURRENT_TIME(), CURRENT_TIME;
+    > SELECT CURRENT_TIME();
     fetched rows / total rows = 1/1
-    +-----------------+----------------+
-    | CURRENT_TIME()  | CURRENT_TIME   |
-    |-----------------+----------------|
-    | 15:39:05        | 15:39:05       |
-    +-----------------+----------------+
+    +-----------------+
+    | CURRENT_TIME()  |
+    |-----------------+
+    | 15:39:05        |
+    +-----------------+
 
 
 CURRENT_TIMESTAMP
@@ -1025,17 +1025,17 @@ CURRENT_TIMESTAMP
 Description
 >>>>>>>>>>>
 
-`CURRENT_TIMESTAMP` and `CURRENT_TIMESTAMP()` are synonyms for `NOW() <#now>`_.
+`CURRENT_TIMESTAMP()` are synonyms for `NOW() <#now>`_.
 
 Example::
 
-    > SELECT CURRENT_TIMESTAMP(), CURRENT_TIMESTAMP;
+    > SELECT CURRENT_TIMESTAMP();
     fetched rows / total rows = 1/1
-    +-----------------------+---------------------+
-    | CURRENT_TIMESTAMP()   | CURRENT_TIMESTAMP   |
-    |-----------------------+---------------------|
-    | 2022-08-02 15:54:19   | 2022-08-02 15:54:19 |
-    +-----------------------+---------------------+
+    +-----------------------+
+    | CURRENT_TIMESTAMP()   |
+    |-----------------------+
+    | 2022-08-02 15:54:19   |
+    +-----------------------+
 
 
 CURTIME
@@ -1548,17 +1548,17 @@ LOCALTIMESTAMP
 Description
 >>>>>>>>>>>
 
-`LOCALTIMESTAMP` and `LOCALTIMESTAMP()` are synonyms for `NOW() <#now>`_.
+`LOCALTIMESTAMP()` are synonyms for `NOW() <#now>`_.
 
 Example::
 
-    > SELECT LOCALTIMESTAMP(), LOCALTIMESTAMP;
+    > SELECT LOCALTIMESTAMP();
     fetched rows / total rows = 1/1
-    +---------------------+---------------------+
-    | LOCALTIMESTAMP()    | LOCALTIMESTAMP      |
-    |---------------------+---------------------|
-    | 2022-08-02 15:54:19 | 2022-08-02 15:54:19 |
-    +---------------------+---------------------+
+    +---------------------+
+    | LOCALTIMESTAMP()    |
+    |---------------------+
+    | 2022-08-02 15:54:19 |
+    +---------------------+
 
 
 LOCALTIME
@@ -1567,17 +1567,17 @@ LOCALTIME
 Description
 >>>>>>>>>>>
 
-`LOCALTIME` and `LOCALTIME()` are synonyms for `NOW() <#now>`_.
+`LOCALTIME()` are synonyms for `NOW() <#now>`_.
 
 Example::
 
     > SELECT LOCALTIME(), LOCALTIME;
     fetched rows / total rows = 1/1
-    +---------------------+---------------------+
-    | LOCALTIME()         | LOCALTIME           |
-    |---------------------+---------------------|
-    | 2022-08-02 15:54:19 | 2022-08-02 15:54:19 |
-    +---------------------+---------------------+
+    +---------------------+
+    | LOCALTIME()         |
+    |---------------------+
+    | 2022-08-02 15:54:19 |
+    +---------------------+
 
 
 MAKEDATE

diff --git a/docs/user/ppl/functions/datetime.rst b/docs/user/ppl/functions/datetime.rst
@@ -202,17 +202,17 @@ CURRENT_DATE
 Description
 >>>>>>>>>>>
 
-`CURRENT_DATE` and `CURRENT_DATE()` are synonyms for `CURDATE() <#curdate>`_.
+`CURRENT_DATE()` are synonyms for `CURDATE() <#curdate>`_.
 
 Example::
 
-    > source=people | eval `CURRENT_DATE()` = CURRENT_DATE(), `CURRENT_DATE` = CURRENT_DATE | fields `CURRENT_DATE()`, `CURRENT_DATE`
+    > source=people | eval `CURRENT_DATE()` = CURRENT_DATE() | fields `CURRENT_DATE()`
     fetched rows / total rows = 1/1
-    +------------------+----------------+
-    | CURRENT_DATE()   | CURRENT_DATE   |
-    |------------------+----------------|
-    | 2022-08-02       | 2022-08-02     |
-    +------------------+----------------+
+    +------------------+
+    | CURRENT_DATE()   |
+    |------------------+
+    | 2022-08-02       |
+    +------------------+
 
 
 CURRENT_TIME
@@ -221,17 +221,17 @@ CURRENT_TIME
 Description
 >>>>>>>>>>>
 
-`CURRENT_TIME` and `CURRENT_TIME()` are synonyms for `CURTIME() <#curtime>`_.
+`CURRENT_TIME()` are synonyms for `CURTIME() <#curtime>`_.
 
 Example::
 
-    > source=people | eval `CURRENT_TIME()` = CURRENT_TIME(), `CURRENT_TIME` = CURRENT_TIME | fields `CURRENT_TIME()`, `CURRENT_TIME`
+    > source=people | eval `CURRENT_TIME()` = CURRENT_TIME() | fields `CURRENT_TIME()`
     fetched rows / total rows = 1/1
-    +------------------+----------------+
-    | CURRENT_TIME()   | CURRENT_TIME   |
-    |------------------+----------------|
-    | 15:39:05         | 15:39:05       |
-    +------------------+----------------+
+    +------------------+
+    | CURRENT_TIME()   |
+    |------------------+
+    | 15:39:05         |
+    +------------------+
 
 
 CURRENT_TIMESTAMP
@@ -240,17 +240,17 @@ CURRENT_TIMESTAMP
 Description
 >>>>>>>>>>>
 
-`CURRENT_TIMESTAMP` and `CURRENT_TIMESTAMP()` are synonyms for `NOW() <#now>`_.
+`CURRENT_TIMESTAMP()` are synonyms for `NOW() <#now>`_.
 
 Example::
 
-    > source=people | eval `CURRENT_TIMESTAMP()` = CURRENT_TIMESTAMP(), `CURRENT_TIMESTAMP` = CURRENT_TIMESTAMP | fields `CURRENT_TIMESTAMP()`, `CURRENT_TIMESTAMP`
+    > source=people | eval `CURRENT_TIMESTAMP()` = CURRENT_TIMESTAMP() | fields `CURRENT_TIMESTAMP()`
     fetched rows / total rows = 1/1
-    +-----------------------+---------------------+
-    | CURRENT_TIMESTAMP()   | CURRENT_TIMESTAMP   |
-    |-----------------------+---------------------|
-    | 2022-08-02 15:54:19   | 2022-08-02 15:54:19 |
-    +-----------------------+---------------------+
+    +-----------------------+
+    | CURRENT_TIMESTAMP()   |
+    |-----------------------+
+    | 2022-08-02 15:54:19   |
+    +-----------------------+
 
 
 CURTIME
@@ -720,17 +720,17 @@ LOCALTIMESTAMP
 Description
 >>>>>>>>>>>
 
-`LOCALTIMESTAMP` and `LOCALTIMESTAMP()` are synonyms for `NOW() <#now>`_.
+`LOCALTIMESTAMP()` are synonyms for `NOW() <#now>`_.
 
 Example::
 
-    > source=people | eval `LOCALTIMESTAMP()` = LOCALTIMESTAMP(), `LOCALTIMESTAMP` = LOCALTIMESTAMP | fields `LOCALTIMESTAMP()`, `LOCALTIMESTAMP`
+    > source=people | eval `LOCALTIMESTAMP()` = LOCALTIMESTAMP() | fields `LOCALTIMESTAMP()`
     fetched rows / total rows = 1/1
-    +---------------------+---------------------+
-    | LOCALTIMESTAMP()    | LOCALTIMESTAMP      |
-    |---------------------+---------------------|
-    | 2022-08-02 15:54:19 | 2022-08-02 15:54:19 |
-    +---------------------+---------------------+
+    +---------------------+
+    | LOCALTIMESTAMP()    |
+    |---------------------+
+    | 2022-08-02 15:54:19 |
+    +---------------------+
 
 
 LOCALTIME
@@ -739,17 +739,17 @@ LOCALTIME
 Description
 >>>>>>>>>>>
 
-`LOCALTIME` and `LOCALTIME()` are synonyms for `NOW() <#now>`_.
+`LOCALTIME()` are synonyms for `NOW() <#now>`_.
 
 Example::
 
-    > source=people | eval `LOCALTIME()` = LOCALTIME(), `LOCALTIME` = LOCALTIME | fields `LOCALTIME()`, `LOCALTIME`
+    > source=people | eval `LOCALTIME()` = LOCALTIME() | fields `LOCALTIME()`
     fetched rows / total rows = 1/1
-    +---------------------+---------------------+
-    | LOCALTIME()         | LOCALTIME           |
-    |---------------------+---------------------|
-    | 2022-08-02 15:54:19 | 2022-08-02 15:54:19 |
-    +---------------------+---------------------+
+    +---------------------+
+    | LOCALTIME()         |
+    |---------------------+
+    | 2022-08-02 15:54:19 |
+    +---------------------+
 
 
 MAKEDATE

diff --git a/integ-test/src/test/java/org/opensearch/sql/ppl/DateTimeFunctionIT.java b/integ-test/src/test/java/org/opensearch/sql/ppl/DateTimeFunctionIT.java
@@ -686,7 +686,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "current_timestamp")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", true)
               .put("referenceGetter", (Supplier<Temporal>) LocalDateTime::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalDateTime::parse)
@@ -695,7 +695,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "localtimestamp")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", true)
               .put("referenceGetter", (Supplier<Temporal>) LocalDateTime::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalDateTime::parse)
@@ -704,7 +704,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "localtime")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", true)
               .put("referenceGetter", (Supplier<Temporal>) LocalDateTime::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalDateTime::parse)
@@ -731,7 +731,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "current_time")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", false)
               .put("referenceGetter", (Supplier<Temporal>) LocalTime::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalTime::parse)
@@ -749,7 +749,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "current_date")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", false)
               .put("referenceGetter", (Supplier<Temporal>) LocalDate::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalDate::parse)

diff --git a/integ-test/src/test/java/org/opensearch/sql/sql/DateTimeFunctionIT.java b/integ-test/src/test/java/org/opensearch/sql/sql/DateTimeFunctionIT.java
@@ -505,7 +505,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "current_timestamp")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", true)
               .put("referenceGetter", (Supplier<Temporal>) LocalDateTime::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalDateTime::parse)
@@ -514,7 +514,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "localtimestamp")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", true)
               .put("referenceGetter", (Supplier<Temporal>) LocalDateTime::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalDateTime::parse)
@@ -523,7 +523,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "localtime")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", true)
               .put("referenceGetter", (Supplier<Temporal>) LocalDateTime::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalDateTime::parse)
@@ -550,7 +550,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "current_time")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", false)
               .put("referenceGetter", (Supplier<Temporal>) LocalTime::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalTime::parse)
@@ -568,7 +568,7 @@ private List<ImmutableMap<Object, Object>> nowLikeFunctionsData() {
       ImmutableMap.builder()
               .put("name", "current_date")
               .put("hasFsp", false)
-              .put("hasShortcut", true)
+              .put("hasShortcut", false)
               .put("constValue", false)
               .put("referenceGetter", (Supplier<Temporal>) LocalDate::now)
               .put("parser", (BiFunction<CharSequence, DateTimeFormatter, Temporal>) LocalDate::parse)

diff --git a/ppl/src/main/antlr/OpenSearchPPLParser.g4 b/ppl/src/main/antlr/OpenSearchPPLParser.g4
@@ -430,7 +430,7 @@ dateAndTimeFunctionBase
 
 // Functions which value could be cached in scope of a single query
 constantFunctionName
-    : datetimeConstantLiteral
+    : CURRENT_DATE | CURRENT_TIME | CURRENT_TIMESTAMP | LOCALTIME | LOCALTIMESTAMP | UTC_TIMESTAMP | UTC_DATE | UTC_TIME
     | CURDATE | CURTIME | NOW
     ;
 
@@ -507,7 +507,6 @@ datetimeLiteral
     : dateLiteral
     | timeLiteral
     | timestampLiteral
-    | datetimeConstantLiteral
     ;
 
 dateLiteral
@@ -522,11 +521,6 @@ timestampLiteral
     : TIMESTAMP timestamp=stringLiteral
     ;
 
-// Actually, these constants are shortcuts to the corresponding functions
-datetimeConstantLiteral
-    : CURRENT_DATE | CURRENT_TIME | CURRENT_TIMESTAMP | LOCALTIME | LOCALTIMESTAMP | UTC_TIMESTAMP | UTC_DATE | UTC_TIME
-    ;
-
 intervalUnit
     : MICROSECOND | SECOND | MINUTE | HOUR | DAY | WEEK | MONTH | QUARTER | YEAR | SECOND_MICROSECOND
     | MINUTE_MICROSECOND | MINUTE_SECOND | HOUR_MICROSECOND | HOUR_SECOND | HOUR_MINUTE | DAY_MICROSECOND
@@ -571,4 +565,8 @@ keywordsCanBeId
     | TIMESTAMP | DATE | TIME
     | FIRST | LAST
     | timespanUnit | SPAN
+    | constantFunctionName
+    | dateAndTimeFunctionBase
+    | textFunctionBase
+    | mathematicalFunctionBase
     ;