Updated functions documentation #4232

matthewryanwells · 2023-06-05T15:04:51Z

Description

There were a few mistakes in the function documentation that I have fixed.

Added missing arithmetic operators
Added missing data types
Added missing functions
Fixed incorrect function usage

I also made a few general improvements to the readability of the code.

Issues Resolved

This PR is not associated with any issues

Checklist

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

… added missing functions Signed-off-by: Matthew Wells <[email protected]>

Signed-off-by: Matthew Wells <[email protected]>

Updated documentation of arithmetic functions

acarbonetto

thanks!

_search-plugins/sql/functions.md

Signed-off-by: Matthew Wells <[email protected]>

kolchfa-aws · 2023-06-08T17:06:37Z

Thank you, @matthewryanwells, @acarbonetto, and @Yury-Fridlyand! This needs to be backported to all versions 1.3 and up, correct?

Signed-off-by: Matthew Wells <[email protected]>

acarbonetto

Looks good, please test the boolean functions and make sure that they are supported in V2

_search-plugins/sql/functions.md

Signed-off-by: Matthew Wells <[email protected]>

matthewryanwells · 2023-06-12T18:39:52Z

@kolchfa-aws the documentation changes made by me, @acarbonetto, and @Yury-Fridlyand are for version 2.8 and above.

kolchfa-aws · 2023-06-12T19:55:24Z

Thank you, @matthewryanwells! Do you mind surrounding all the function names in the first column with tic marks to make the PR pass the linter?

Signed-off-by: Matthew Wells <[email protected]>

matthewryanwells · 2023-06-12T21:59:50Z

@kolchfa-aws I have added the tics to the function names, and also went through each and every query example works as written

kolchfa-aws

Thanks so much for your contribution, @matthewryanwells!

kolchfa-aws · 2023-06-12T19:53:04Z

_search-plugins/sql/functions.md

-% | `number [op] number -> number` | `SELECT 1 % 100 FROM my-index LIMIT 1`
+| Function | Specification                                                    | Example                                                                             |
+|:---------|:-----------------------------------------------------------------|:------------------------------------------------------------------------------------|
+| abs      | `abs(number T) -> T`                                             | `SELECT abs(0.5)`                                                                   |


* Updated documentation of arithmetic functions, correct some mistakes, added missing functions Signed-off-by: Matthew Wells <[email protected]> * Added a few missing variable definitions Signed-off-by: Matthew Wells <[email protected]> * Updated arithmetic operators documentation to include symbol Signed-off-by: Matthew Wells <[email protected]> * removed unneeded SELECT and LIMIT Signed-off-by: Matthew Wells <[email protected]> * reformated table Signed-off-by: Matthew Wells <[email protected]> * updated data types of functions and made some corrections Signed-off-by: Matthew Wells <[email protected]> * removed missing brackets, fixed incorrect ifnull documentation Signed-off-by: Matthew Wells <[email protected]> * fixed more minor mistakes and confirmed all function examples work Signed-off-by: Matthew Wells <[email protected]> * added ticks to all function names to get it to pass the linter Signed-off-by: Matthew Wells <[email protected]> --------- Signed-off-by: Matthew Wells <[email protected]> (cherry picked from commit 2e6016c) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Updated documentation of arithmetic functions, correct some mistakes, added missing functions * Added a few missing variable definitions * Updated arithmetic operators documentation to include symbol * removed unneeded SELECT and LIMIT * reformated table * updated data types of functions and made some corrections * removed missing brackets, fixed incorrect ifnull documentation * fixed more minor mistakes and confirmed all function examples work * added ticks to all function names to get it to pass the linter --------- (cherry picked from commit 2e6016c) Signed-off-by: Matthew Wells <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Updated documentation of arithmetic functions, correct some mistakes, added missing functions Signed-off-by: Matthew Wells <[email protected]> * Added a few missing variable definitions Signed-off-by: Matthew Wells <[email protected]> * Updated arithmetic operators documentation to include symbol Signed-off-by: Matthew Wells <[email protected]> * removed unneeded SELECT and LIMIT Signed-off-by: Matthew Wells <[email protected]> * reformated table Signed-off-by: Matthew Wells <[email protected]> * updated data types of functions and made some corrections Signed-off-by: Matthew Wells <[email protected]> * removed missing brackets, fixed incorrect ifnull documentation Signed-off-by: Matthew Wells <[email protected]> * fixed more minor mistakes and confirmed all function examples work Signed-off-by: Matthew Wells <[email protected]> * added ticks to all function names to get it to pass the linter Signed-off-by: Matthew Wells <[email protected]> --------- Signed-off-by: Matthew Wells <[email protected]>

This reverts commit 4b2fd6c.

* Updated documentation of arithmetic functions, correct some mistakes, added missing functions Signed-off-by: Matthew Wells <[email protected]> * Added a few missing variable definitions Signed-off-by: Matthew Wells <[email protected]> * Updated arithmetic operators documentation to include symbol Signed-off-by: Matthew Wells <[email protected]> * removed unneeded SELECT and LIMIT Signed-off-by: Matthew Wells <[email protected]> * reformated table Signed-off-by: Matthew Wells <[email protected]> * updated data types of functions and made some corrections Signed-off-by: Matthew Wells <[email protected]> * removed missing brackets, fixed incorrect ifnull documentation Signed-off-by: Matthew Wells <[email protected]> * fixed more minor mistakes and confirmed all function examples work Signed-off-by: Matthew Wells <[email protected]> * added ticks to all function names to get it to pass the linter Signed-off-by: Matthew Wells <[email protected]> --------- Signed-off-by: Matthew Wells <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>

This reverts commit 4b2fd6c. Signed-off-by: Melissa Vagi <[email protected]>

* Updated documentation of arithmetic functions, correct some mistakes, added missing functions Signed-off-by: Matthew Wells <[email protected]> * Added a few missing variable definitions Signed-off-by: Matthew Wells <[email protected]> * Updated arithmetic operators documentation to include symbol Signed-off-by: Matthew Wells <[email protected]> * removed unneeded SELECT and LIMIT Signed-off-by: Matthew Wells <[email protected]> * reformated table Signed-off-by: Matthew Wells <[email protected]> * updated data types of functions and made some corrections Signed-off-by: Matthew Wells <[email protected]> * removed missing brackets, fixed incorrect ifnull documentation Signed-off-by: Matthew Wells <[email protected]> * fixed more minor mistakes and confirmed all function examples work Signed-off-by: Matthew Wells <[email protected]> * added ticks to all function names to get it to pass the linter Signed-off-by: Matthew Wells <[email protected]> --------- Signed-off-by: Matthew Wells <[email protected]>

matthewryanwells added 4 commits June 1, 2023 14:44

Updated documentation of arithmetic functions, correct some mistakes,…

86aacae

… added missing functions Signed-off-by: Matthew Wells <[email protected]>

Added a few missing variable definitions

b0ab2b6

Signed-off-by: Matthew Wells <[email protected]>

Updated arithmetic operators documentation to include symbol

5508549

Signed-off-by: Matthew Wells <[email protected]>

Merge pull request #3 from Bit-Quill/dev-arithmetic-documentation-update

da7f19e

Updated documentation of arithmetic functions

matthewryanwells requested review from cwillum, hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, ananzh, seanneumann, AMoo-Miki and natebower as code owners June 5, 2023 15:04

acarbonetto approved these changes Jun 6, 2023

View reviewed changes

_search-plugins/sql/functions.md Outdated Show resolved Hide resolved

matthewryanwells added 2 commits June 8, 2023 09:37

removed unneeded SELECT and LIMIT

3aadc63

Signed-off-by: Matthew Wells <[email protected]>

merged upstream changes

3ba966d

Signed-off-by: Matthew Wells <[email protected]>

Yury-Fridlyand approved these changes Jun 8, 2023

View reviewed changes

reformated table

fb40c93

Signed-off-by: Matthew Wells <[email protected]>

matthewryanwells changed the title ~~Updated documentation of arithmetic functions~~ Updated functions documentation Jun 8, 2023

updated data types of functions and made some corrections

5dd1582

Signed-off-by: Matthew Wells <[email protected]>

acarbonetto approved these changes Jun 12, 2023

View reviewed changes

removed missing brackets, fixed incorrect ifnull documentation

9442d3b

Signed-off-by: Matthew Wells <[email protected]>

kolchfa-aws self-assigned this Jun 12, 2023

kolchfa-aws added the backport 2.8 PR: Backport label for 2.8 label Jun 12, 2023

matthewryanwells added 2 commits June 12, 2023 14:52

fixed more minor mistakes and confirmed all function examples work

66167c7

Signed-off-by: Matthew Wells <[email protected]>

added ticks to all function names to get it to pass the linter

b0deab1

Signed-off-by: Matthew Wells <[email protected]>

kolchfa-aws approved these changes Jun 13, 2023

View reviewed changes

kolchfa-aws merged commit 2e6016c into opensearch-project:main Jun 13, 2023

opensearch-trigger-bot bot mentioned this pull request Jun 13, 2023

[Backport 2.8] Updated functions documentation #4306

Merged

vagimeli added a commit that referenced this pull request Jun 15, 2023

Revert "Updated functions documentation (#4232)"

8f4436c

This reverts commit 4b2fd6c.

vagimeli added a commit that referenced this pull request Aug 24, 2023

Revert "Updated functions documentation (#4232)"

968f1cd

This reverts commit 4b2fd6c. Signed-off-by: Melissa Vagi <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated functions documentation #4232

Updated functions documentation #4232

matthewryanwells commented Jun 5, 2023 •

edited

Loading

acarbonetto left a comment

kolchfa-aws commented Jun 8, 2023

acarbonetto left a comment

matthewryanwells commented Jun 12, 2023

kolchfa-aws commented Jun 12, 2023

matthewryanwells commented Jun 12, 2023

kolchfa-aws left a comment

kolchfa-aws Jun 12, 2023

	\| abs \| `abs(number T) -> T` \| `SELECT abs(0.5)` \|
	\| `abs` \| `abs(number T) -> T` \| `SELECT abs(0.5)` \|

Updated functions documentation #4232

Updated functions documentation #4232

Conversation

matthewryanwells commented Jun 5, 2023 • edited Loading

Description

Issues Resolved

Checklist

acarbonetto left a comment

Choose a reason for hiding this comment

kolchfa-aws commented Jun 8, 2023

acarbonetto left a comment

Choose a reason for hiding this comment

matthewryanwells commented Jun 12, 2023

kolchfa-aws commented Jun 12, 2023

matthewryanwells commented Jun 12, 2023

kolchfa-aws left a comment

Choose a reason for hiding this comment

kolchfa-aws Jun 12, 2023

Choose a reason for hiding this comment

matthewryanwells commented Jun 5, 2023 •

edited

Loading