Added new datetime functions and aliases to PPL [Part 2] #283

matthewryanwells · 2023-07-06T20:21:03Z

Description

This PR adds multiple datetime functions that are in SQL to PPL.

The following functions are added:

get_format
last_day
sec_to_time
yearweek
weekday
to_seconds
str_to_date
timestampadd
timestampdiff
extract

Issues Resolved

No related issue

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.

codecov · 2023-07-06T21:52:32Z

Codecov Report

Merging #283 (62ebbc0) into integ-ppl-function-support-part2 (f5031a7) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@                         Coverage Diff                         @@
##             integ-ppl-function-support-part2     #283   +/-   ##
===================================================================
  Coverage                               97.39%   97.39%           
- Complexity                               4600     4606    +6     
===================================================================
  Files                                     401      401           
  Lines                                   11381    11403   +22     
  Branches                                  843      843           
===================================================================
+ Hits                                    11084    11106   +22     
  Misses                                    290      290           
  Partials                                    7        7

Flag	Coverage Δ
sql-engine	`97.39% <100.00%> (+<0.01%)`	⬆️

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

Impacted Files	Coverage Δ
...pensearch/sql/ppl/parser/AstExpressionBuilder.java	`100.00% <100.00%> (ø)`

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

Yury-Fridlyand

<3

GumpacG

Check all descriptions of Argument Type in the RST files have new lines.

docs/user/ppl/functions/datetime.rst

Yury-Fridlyand · 2023-07-07T00:49:40Z

Hint: try RST validation tools - online or offline (e.g. VS code plugin).

ppl/src/main/antlr/OpenSearchPPLParser.g4

integ-test/src/test/java/org/opensearch/sql/ppl/DateTimeFunctionIT.java

ppl/src/test/java/org/opensearch/sql/ppl/antlr/PPLSyntaxParserTest.java

Yury-Fridlyand · 2023-07-10T16:50:44Z

You missed co copy a UT from SQL to PPL, jacoco fails on PPL

matthewryanwells · 2023-07-10T18:29:30Z

You missed co copy a UT from SQL to PPL, jacoco fails on PPL

Just noticed that and pushed a fix

docs/user/ppl/functions/datetime.rst

ppl/src/test/java/org/opensearch/sql/ppl/antlr/PPLSyntaxParserTest.java

Yury-Fridlyand

CI fails due to log4j update on upstream. We can ignore that for now.

Yury-Fridlyand · 2023-07-11T19:44:59Z

@matthewryanwells you need one more rebase now to get CI working.

* Added new functions, and alias' to PPL Signed-off-by: Matthew Wells <matthew.wells@improving.com>

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

… line with sql, as well as updated tests and documentation Signed-off-by: Matthew Wells <matthew.wells@improving.com>

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

…stent Signed-off-by: Matthew Wells <matthew.wells@improving.com>

…search-project#1852) * Added new datetime functions, documentation, and tests Signed-off-by: Matthew Wells <matthew.wells@improving.com>

…search-project#1852) * Added new datetime functions, documentation, and tests Signed-off-by: Matthew Wells <matthew.wells@improving.com> Signed-off-by: Mitchell Gale <Mitchell.Gale@improving.com>

…search-project#1852) * Added new datetime functions, documentation, and tests Signed-off-by: Matthew Wells <matthew.wells@improving.com> (cherry picked from commit 8c8e08c)

…search-project#1852) * Added new datetime functions, documentation, and tests Signed-off-by: Matthew Wells <matthew.wells@improving.com> Signed-off-by: Mitchell Gale <Mitchell.Gale@improving.com>

* Implement creation of ip2geo feature (#257) * Update gradle version to 7.6 (#265) Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> * Implement creation of ip2geo feature * Implementation of ip2geo datasource creation * Implementation of ip2geo processor creation Signed-off-by: Heemin Kim <heemin@amazon.com> --------- Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> Signed-off-by: Heemin Kim <heemin@amazon.com> Co-authored-by: Vijayan Balasubramanian <balasvij@amazon.com> * Added unit tests with some refactoring of codes (#271) * Add Unit tests * Set cache true for search query * Remove in memory cache implementation (Two way door decision) * Relying on search cache without custom cache * Renamed datasource state from FAILED to CREATE_FAILED * Renamed class name from *Helper to *Facade * Changed updateIntervalInDays to updateInterval * Changed value type of default update_interval from TimeValue to Long * Read setting value from cluster settings directly Signed-off-by: Heemin Kim <heemin@amazon.com> * Sync from main (#280) * Update gradle version to 7.6 (#265) Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> * Exclude lombok generated code from jacoco coverage report (#268) Signed-off-by: Heemin Kim <heemin@amazon.com> * Make jacoco report to be generated faster in local (#267) Signed-off-by: Heemin Kim <heemin@amazon.com> * Update dependency org.json:json to v20230227 (#273) Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com> * Baseline owners and maintainers (#275) Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> --------- Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> Signed-off-by: Heemin Kim <heemin@amazon.com> Co-authored-by: Vijayan Balasubramanian <balasvij@amazon.com> Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com> * Add datasource name validation (#281) Signed-off-by: Heemin Kim <heemin@amazon.com> * Refactoring of code (#282) 1. Change variable name from datasourceName to name 2. Change variable name from id to name 3. Added helper methods in test code Signed-off-by: Heemin Kim <heemin@amazon.com> * Change field name from md5 to sha256 (#285) Signed-off-by: Heemin Kim <heemin@amazon.com> * Implement get datasource api (#279) Signed-off-by: Heemin Kim <heemin@amazon.com> * Update index option (#284) 1. Make geodata index as hidden 2. Make geodata index as read only allow delete after creation is done 3. Refresh datasource index immediately after update Signed-off-by: Heemin Kim <heemin@amazon.com> * Make some fields in manifest file as mandatory (#289) Signed-off-by: Heemin Kim <heemin@amazon.com> * Create datasource index explicitly (#283) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add wrapper class of job scheduler lock service (#290) Signed-off-by: Heemin Kim <heemin@amazon.com> * Remove all unused client attributes (#293) Signed-off-by: Heemin Kim <heemin@amazon.com> * Update copyright header (#298) Signed-off-by: Heemin Kim <heemin@amazon.com> * Run system index handling code with stashed thread context (#297) Signed-off-by: Heemin Kim <heemin@amazon.com> * Reduce lock duration and renew the lock during update (#299) Signed-off-by: Heemin Kim <heemin@amazon.com> * Implements delete datasource API (#291) Signed-off-by: Heemin Kim <heemin@amazon.com> * Set User-Agent in http request (#300) Signed-off-by: Heemin Kim <heemin@amazon.com> * Implement datasource update API (#292) Signed-off-by: Heemin Kim <heemin@amazon.com> * Refactoring test code (#302) Make buildGeoJSONFeatureProcessorConfig method to be more general Signed-off-by: Heemin Kim <heemin@amazon.com> * Add ip2geo processor integ test for failure case (#303) Signed-off-by: Heemin Kim <heemin@amazon.com> * Bug fix and refactoring of code (#305) 1. Bugfix: Ingest metadata can be null if there is no processor created 2. Refactoring: Moved private method to another class for better testing support 3. Refactoring: Set some private static final variable as public so that unit test can use it 4. Refactoring: Changed string value to static variable Signed-off-by: Heemin Kim <heemin@amazon.com> * Add integration test for Ip2GeoProcessor (#306) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add ConcurrentModificationException (#308) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add integration test for UpdateDatasource API (#307) Signed-off-by: Heemin Kim <heemin@amazon.com> * Bug fix on lock management and few performance improvements (#310) * Release lock before response back to caller for update/delete API * Release lock in background task for creation API * Change index settings to improve indexing performance Signed-off-by: Heemin Kim <heemin@amazon.com> * Change index setting from read_only_allow_delete to write (#311) read_only_allow_delete does not block write to an index. The disk-based shard allocator may add and remove this block automatically. Therefore, use index.blocks.write instead. Signed-off-by: Heemin Kim <heemin@amazon.com> * Fix bug in get datasource API and improve memory usage (#313) Signed-off-by: Heemin Kim <heemin@amazon.com> * Change package for Strings.hasText (#314) (#317) Signed-off-by: Heemin Kim <heemin@amazon.com> * Remove jitter and move index setting from DatasourceFacade to DatasourceExtension (#319) Signed-off-by: Heemin Kim <heemin@amazon.com> * Do not index blank value and do not enrich null property (#320) Signed-off-by: Heemin Kim <heemin@amazon.com> * Move index setting keys to constants (#321) Signed-off-by: Heemin Kim <heemin@amazon.com> * Return null index name for expired data (#322) Return null index name for expired data so that it can be deleted by clean up process. Clean up process exclude current index from deleting. Signed-off-by: Heemin Kim <heemin@amazon.com> * Add new fields in datasource (#325) Signed-off-by: Heemin Kim <heemin@amazon.com> * Delete index once it is expired (#326) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add restoring event listener (#328) In the listener, we trigger a geoip data update Signed-off-by: Heemin Kim <heemin@amazon.com> * Reverse forcemerge and refresh order (#331) Otherwise, opensearch does not clear old segment files Signed-off-by: Heemin Kim <heemin@amazon.com> * Removed parameter and settings (#332) * Removed first_only parameter * Removed max_concurrency and batch_size setting first_only parameter was added as current geoip processor has it. However, the parameter have no benefit for ip2geo processor as we don't do a sequantial search for array data but use multi search. max_concurrency and batch_size setting is removed as these are only reveal internal implementation and could be a future blocker to improve performance later. Signed-off-by: Heemin Kim <heemin@amazon.com> * Add a field in datasource for current index name (#333) Signed-off-by: Heemin Kim <heemin@amazon.com> * Delete GeoIP data indices after restoring complete (#334) We don't want to use restored GeoIP data indices. Therefore we delete the indices once restoring process complete. When GeoIP metadata index is restored, we create a new GeoIP data index instead. Signed-off-by: Heemin Kim <heemin@amazon.com> * Use bool query for array form of IPs (#335) Signed-off-by: Heemin Kim <heemin@amazon.com> * Run update/delete request in a new thread (#337) This is not to block transport thread Signed-off-by: Heemin Kim <heemin@amazon.com> * Remove IP2Geo processor validation (#336) Cannot query index to get data to validate IP2Geo processor. Will add validation when we decide to store some of data in cluster state metadata. Signed-off-by: Heemin Kim <heemin@amazon.com> * Acquire lock sychronously (#339) By acquiring lock asychronously, the remaining part of the code is being run by transport thread which does not allow blocking code. We want only single update happen in a node using single thread. However, it cannot be acheived if I acquire lock asynchronously and pass the listener. Signed-off-by: Heemin Kim <heemin@amazon.com> * Added a cache to store datasource metadata (#338) Signed-off-by: Heemin Kim <heemin@amazon.com> * Changed class name and package (#341) Signed-off-by: Heemin Kim <heemin@amazon.com> * Refactoring of code (#342) 1. Changed class name from Ip2GeoCache to Ip2GeoCachedDao 2. Moved the Ip2GeoCachedDao from cache to dao package Signed-off-by: Heemin Kim <heemin@amazon.com> * Add geo data cache (#340) Signed-off-by: Heemin Kim <heemin@amazon.com> * Add cache layer to reduce GeoIp data retrieval latency (opensearch-project#343) Signed-off-by: Heemin Kim <heemin@amazon.com> * Use _primary in query preference and few changes (opensearch-project#347) 1. Use _primary preference to get datasource metadata so that it can read the latest data. RefreshPolicy.IMMEDIATE won't refresh replica shards immediately according to #346 2. Update datasource metadata index mapping 3. Move batch size from static value to setting Signed-off-by: Heemin Kim <heemin@amazon.com> * Wait until GeoIP data to be replicated to all data nodes (opensearch-project#348) Signed-off-by: Heemin Kim <heemin@amazon.com> * Update packages according to a change in OpenSearch core (opensearch-project#354) * Update packages according to a change in OpenSearch core Signed-off-by: Heemin Kim <heemin@amazon.com> * Update packages according to a change in OpenSearch core (opensearch-project#353) Signed-off-by: Heemin Kim <heemin@amazon.com> --------- Signed-off-by: Heemin Kim <heemin@amazon.com> --------- Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> Signed-off-by: Heemin Kim <heemin@amazon.com> Co-authored-by: Vijayan Balasubramanian <balasvij@amazon.com> Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com>

matthewryanwells requested review from MaxKsyunz, Yury-Fridlyand, forestmvey, acarbonetto and GumpacG as code owners July 6, 2023 20:21

Yury-Fridlyand approved these changes Jul 6, 2023

View reviewed changes

GumpacG reviewed Jul 7, 2023

View reviewed changes

docs/user/ppl/functions/datetime.rst Outdated Show resolved Hide resolved

docs/user/ppl/functions/datetime.rst Outdated Show resolved Hide resolved

Yury-Fridlyand reviewed Jul 7, 2023

View reviewed changes

ppl/src/main/antlr/OpenSearchPPLParser.g4 Outdated Show resolved Hide resolved

Yury-Fridlyand reviewed Jul 8, 2023

View reviewed changes

Yury-Fridlyand approved these changes Jul 10, 2023

View reviewed changes

GumpacG requested changes Jul 11, 2023

View reviewed changes

docs/user/ppl/functions/datetime.rst Show resolved Hide resolved

docs/user/ppl/functions/datetime.rst Show resolved Hide resolved

ppl/src/test/java/org/opensearch/sql/ppl/antlr/PPLSyntaxParserTest.java Outdated Show resolved Hide resolved

GumpacG approved these changes Jul 11, 2023

View reviewed changes

Yury-Fridlyand approved these changes Jul 11, 2023

View reviewed changes

matthewryanwells force-pushed the integ-ppl-function-support-part2 branch from 8912941 to 392a720 Compare July 11, 2023 18:44

matthewryanwells force-pushed the dev-ppl-function-support-part2 branch from f5767d6 to 925aa90 Compare July 11, 2023 18:57

matthewryanwells added 10 commits July 11, 2023 13:11

Added new datetime functions and aliases to PPL (#281)

ec261f4

* Added new functions, and alias' to PPL Signed-off-by: Matthew Wells <matthew.wells@improving.com>

added functions and tests

eeb0cdb

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

added documentation

494f628

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

updated doctests

5c760eb

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

fixed doctest part 2: electric boogaloo

3b82a6b

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

updated documentation to fix newlines

0660417

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

updated get_format, extract, timestampdiff, and timestampadd to be in…

858a17e

… line with sql, as well as updated tests and documentation Signed-off-by: Matthew Wells <matthew.wells@improving.com>

fixed incorrect syntax for extract in doctest

d03221f

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

Updated tests to match updated functions, fixed checkstyle test failures

69fa056

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

added test coverage and fixed checkstyle failures

13c1f5d

Signed-off-by: Matthew Wells <matthew.wells@improving.com>

added newlines to documentation and updated case in tests to be consi…

62ebbc0

…stent Signed-off-by: Matthew Wells <matthew.wells@improving.com>

matthewryanwells force-pushed the dev-ppl-function-support-part2 branch from 1b3f28d to 62ebbc0 Compare July 11, 2023 20:11

Yury-Fridlyand approved these changes Jul 11, 2023

View reviewed changes

matthewryanwells merged commit a07adc8 into integ-ppl-function-support-part2 Jul 11, 2023

matthewryanwells deleted the dev-ppl-function-support-part2 branch July 11, 2023 21:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added new datetime functions and aliases to PPL [Part 2] #283

Added new datetime functions and aliases to PPL [Part 2] #283

matthewryanwells commented Jul 6, 2023

codecov bot commented Jul 6, 2023 •

edited

Loading

Yury-Fridlyand left a comment

GumpacG left a comment

Yury-Fridlyand commented Jul 7, 2023

Yury-Fridlyand commented Jul 10, 2023

matthewryanwells commented Jul 10, 2023

Yury-Fridlyand left a comment

Yury-Fridlyand commented Jul 11, 2023

Added new datetime functions and aliases to PPL [Part 2] #283

Added new datetime functions and aliases to PPL [Part 2] #283

Conversation

matthewryanwells commented Jul 6, 2023

Description

Issues Resolved

Check List

codecov bot commented Jul 6, 2023 • edited Loading

Codecov Report

Yury-Fridlyand left a comment

Choose a reason for hiding this comment

GumpacG left a comment

Choose a reason for hiding this comment

Yury-Fridlyand commented Jul 7, 2023

Yury-Fridlyand commented Jul 10, 2023

matthewryanwells commented Jul 10, 2023

Yury-Fridlyand left a comment

Choose a reason for hiding this comment

Yury-Fridlyand commented Jul 11, 2023

codecov bot commented Jul 6, 2023 •

edited

Loading