Add cbrt function to the PPL #171

margarit-h · 2022-11-18T21:03:44Z

Signed-off-by: Margarit Hakobyan margarith@bitquilltech.com

Description

Calculates the cube root of a number

Argument type: INTEGER/LONG/FLOAT/DOUBLE

Return type DOUBLE:

(Non-negative) INTEGER/LONG/FLOAT/DOUBLE -> DOUBLE
(Negative) INTEGER/LONG/FLOAT/DOUBLE -> DOUBLE

Example::

opensearchsql> source=location | eval `CBRT(8)` = CBRT(8), `CBRT(9.261)` = CBRT(9.261), `CBRT(-27)` = CBRT(-27) | fields `CBRT(8)`, `CBRT(9.261)`,`CBRT(-27)`;
fetched rows / total rows = 2/2
+-----------+---------------+-------------+
| CBRT(8)   | CBRT(9.261)   | CBRT(-27)   |
|-----------+---------------+-------------|
| 2.0       | 2.1           | -3.0        |
| 2.0       | 2.1           | -3.0        |
+-----------+---------------+-------------+

Issues Resolved

[List any issues this PR will resolve]

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 · 2022-11-18T21:19:07Z

Codecov Report

Merging #171 (a709fa9) into integ-add-cbrt-to-ppl (d4d289c) will decrease coverage by 2.52%.
The diff coverage is n/a.

@@                     Coverage Diff                     @@
##             integ-add-cbrt-to-ppl     #171      +/-   ##
===========================================================
- Coverage                    98.28%   95.76%   -2.53%     
  Complexity                    3454     3454              
===========================================================
  Files                          345      355      +10     
  Lines                         8588     9246     +658     
  Branches                       547      666     +119     
===========================================================
+ Hits                          8441     8854     +413     
- Misses                         142      334     +192     
- Partials                         5       58      +53

Flag	Coverage Δ
query-workbench	`62.76% <ø> (?)`
sql-engine	`98.28% <ø> (ø)`

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

Impacted Files	Coverage Δ
...ch/public/components/QueryResults/QueryResults.tsx	`61.60% <0.00%> (ø)`
workbench/public/components/PPLPage/PPLPage.tsx	`56.52% <0.00%> (ø)`
workbench/public/components/Header/Header.tsx	`100.00% <0.00%> (ø)`
...ublic/components/QueryResults/QueryResultsBody.tsx	`68.32% <0.00%> (ø)`
...h/public/components/QueryLanguageSwitch/Switch.tsx	`85.71% <0.00%> (ø)`
workbench/public/components/app.tsx	`0.00% <0.00%> (ø)`
workbench/public/components/SQLPage/SQLPage.tsx	`100.00% <0.00%> (ø)`
workbench/public/application.tsx	`0.00% <0.00%> (ø)`
workbench/public/utils/PanelWrapper.tsx	`100.00% <0.00%> (ø)`
workbench/public/components/Main/main.tsx	`53.00% <0.00%> (ø)`

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

Signed-off-by: Margarit Hakobyan <margarith@bitquilltech.com>

acarbonetto · 2022-11-22T00:02:45Z

docs/user/ppl/functions/math.rst

+
+Example::
+
+    opensearchsql> source=location | eval `CBRT(8)` = CBRT(8), `CBRT(9.261)` = CBRT(9.261), `CBRT(-27)` = CBRT(-27) | fields `CBRT(8)`, `CBRT(9.261)`, `CBRT(-27)`;


If we use source=people, do we just get a single row of results?

No, we get 12 rows, locations seems to be the shortest.
Here is the people:
opensearchsql> source=people | eval CBRT(8) = CBRT(8), CBRT(9.261) = CBRT(9.261), CBRT(-27) = CBRT(-27) | fields CBRT(8), CBRT(9.261),CBRT(-27);
fetched rows / total rows = 12/12
+-----------+---------------+-------------+
| CBRT(8) | CBRT(9.261) | CBRT(-27) |
|-----------+---------------+-------------|
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
| 2.0 | 2.1 | -3.0 |
+-----------+---------------+-------------+

GumpacG · 2022-11-23T02:06:49Z

If it makes sense, can there be more tests to test field types float, long, double, null, negative. Currently only integer is being tested in IT. calcs may be nice to use for this. It has a good variety of data types and values.

GabeFernandez310 · 2022-11-23T15:31:18Z

docs/user/ppl/functions/math.rst

@@ -662,3 +662,27 @@ Example::
    | 2.0       | 2.1          |
    +-----------+--------------+

+CBRT


I think the functions in here might be organized in Alphabetical order? It might be good to move this function documentation up.

GabeFernandez310

Looks good!

* Add cbrt function to the PPL (#171) Signed-off-by: Margarit Hakobyan <margarith@bitquilltech.com>

* Import h3 library (#154) Made following changes to make it compatible: 1. Rename package from elasticsearch to opensearch.geospatial 2. Update License headers 3. Update build file 4. Update settings to include sub projects * Use Transport Request (#164) Remove usage of deprecated BaseNodeRequest * Update http client package to resolve build failure (#168) (#171) * Introduce H3 min resolution constant (#165) H3 version 1 has 16 resolutions, numbered 0 through 15. Introduced a constant to represent min value, similar to max value. * Add geohex aggregation (#160) This aggregation will use uber's h3 to group coordinates into H3 cell. Created new aggregation type geohex_grid. The precision will be between 0 and 15. This aggreation has default precision as 5, similar to geohash and geotile. Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com> * Add integration test (#176) Included integration test for geohex_grid. Signed-off-by: Vijayan Balasubramanian <balasvij@amazon.com>

margarit-h force-pushed the integ-add-cbrt-to-ppl branch from 08bef27 to d4d289c Compare November 21, 2022 20:02

margarit-h added 2 commits November 21, 2022 12:19

Add cbrt function to the PPL

3f72282

Signed-off-by: Margarit Hakobyan <margarith@bitquilltech.com>

Edit a doc

d820a1b

Signed-off-by: Margarit Hakobyan <margarith@bitquilltech.com>

margarit-h force-pushed the dev-add-cbrt-to-ppl branch from a2b928e to d820a1b Compare November 21, 2022 20:20

margarit-h added 2 commits November 21, 2022 12:25

Edit docs

771e10e

Signed-off-by: Margarit Hakobyan <margarith@bitquilltech.com>

Edit docs

a709fa9

Signed-off-by: Margarit Hakobyan <margarith@bitquilltech.com>

margarit-h changed the title ~~[WIP:] Add cbrt function to the PPL~~ Add cbrt function to the PPL Nov 21, 2022

margarit-h requested review from MaxKsyunz, acarbonetto, Yury-Fridlyand, forestmvey, GumpacG, MitchellGale and GabeFernandez310 November 21, 2022 20:43

acarbonetto approved these changes Nov 22, 2022

View reviewed changes

GabeFernandez310 reviewed Nov 23, 2022

View reviewed changes

GabeFernandez310 approved these changes Nov 23, 2022

View reviewed changes

margarit-h merged commit d363f60 into integ-add-cbrt-to-ppl Nov 23, 2022

Yury-Fridlyand pushed a commit that referenced this pull request Nov 29, 2022

Add cbrt function to the PPL (opensearch-project#1097)

e2bf254

* Add cbrt function to the PPL (#171) Signed-off-by: Margarit Hakobyan <margarith@bitquilltech.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add cbrt function to the PPL #171

Add cbrt function to the PPL #171

margarit-h commented Nov 18, 2022 •

edited

Loading

codecov bot commented Nov 18, 2022 •

edited

Loading

acarbonetto Nov 22, 2022

margarit-h Nov 22, 2022 •

edited

Loading

GumpacG commented Nov 23, 2022

GabeFernandez310 Nov 23, 2022

GabeFernandez310 left a comment


		Example::

		opensearchsql> source=location \| eval `CBRT(8)` = CBRT(8), `CBRT(9.261)` = CBRT(9.261), `CBRT(-27)` = CBRT(-27) \| fields `CBRT(8)`, `CBRT(9.261)`, `CBRT(-27)`;

Add cbrt function to the PPL #171

Add cbrt function to the PPL #171

Conversation

margarit-h commented Nov 18, 2022 • edited Loading

Description

Issues Resolved

Check List

codecov bot commented Nov 18, 2022 • edited Loading

Codecov Report

acarbonetto Nov 22, 2022

Choose a reason for hiding this comment

margarit-h Nov 22, 2022 • edited Loading

Choose a reason for hiding this comment

GumpacG commented Nov 23, 2022

GabeFernandez310 Nov 23, 2022

Choose a reason for hiding this comment

GabeFernandez310 left a comment

Choose a reason for hiding this comment

margarit-h commented Nov 18, 2022 •

edited

Loading

codecov bot commented Nov 18, 2022 •

edited

Loading

margarit-h Nov 22, 2022 •

edited

Loading