Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs]Batch04 - Bitwise numeric functions #16805

Merged
merged 7 commits into from
Jul 30, 2024

Conversation

edgar2020
Copy link
Contributor

Description

Add examples to the sql-functions.md page.

Updates the BITWISE_AND, BITWISE_COMPLEMENT, BITWISE_CONVERT_DOUBLE_TO_LONG_BITS, BITWISE_CONVERT_LONG_BITS_TO_DOUBLE, BITWISE_OR, BITWISE_SHIFT_LEFT, BITWISE_SHIFT_RIGHT, and BITWISE_XOR.

This PR has:

  • been self-reviewed.

@edgar2020 edgar2020 marked this pull request as ready for review July 26, 2024 18:30
Copy link
Contributor

@techdocsmith techdocsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job. minor suggestions mainly about using a colon (:) notation instead of repeating "that is" every time.

@@ -336,68 +336,189 @@ Performs a bitwise XOR operation on all input values.

## BITWISE_AND

`BITWISE_AND(expr1, expr2)`
Returns the bitwise AND between two expressions, that is, `expr1 & expr2`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Returns the bitwise AND between two expressions, that is, `expr1 & expr2`.
Returns the bitwise AND between two expressions: `expr1 & expr2`.

I don't think we need the "that is" in these descriptions. Just the code following a colon is fine.

Copy link
Contributor Author

@edgar2020 edgar2020 Jul 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

applied it manually, as well as to all other instances

docs/querying/sql-functions.md Show resolved Hide resolved
docs/querying/sql-functions.md Show resolved Hide resolved
Copy link
Contributor

@techdocsmith techdocsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@techdocsmith techdocsmith merged commit 85a8a1d into apache:master Jul 30, 2024
8 checks passed
sreemanamala pushed a commit to sreemanamala/druid that referenced this pull request Aug 6, 2024
* Batch04 - Bitwise numeric functions

* Batch04 - Bitwise numeric functions

* minor fixes

* rewording bitwise_shift functions

* rewording bitwise_shift functions

* Update docs/querying/sql-functions.md

* applying suggestions

---------

Co-authored-by: Benedict Jin <[email protected]>
@kfaraz kfaraz added this to the 31.0.0 milestone Oct 4, 2024
vtlim pushed a commit to vtlim/druid that referenced this pull request Oct 8, 2024
* Batch04 - Bitwise numeric functions

* Batch04 - Bitwise numeric functions

* minor fixes

* rewording bitwise_shift functions

* rewording bitwise_shift functions

* Update docs/querying/sql-functions.md

* applying suggestions

---------

Co-authored-by: Benedict Jin <[email protected]>
(cherry picked from commit 85a8a1d)
techdocsmith added a commit that referenced this pull request Jan 24, 2025
* docs: add examples for SQL functions (#16745)

* updating first batch of numeric functions

* First batch of functions

* addressing first few comments

* alphabetize list

* draft with suggestions applied

* minor discrepency expr -> <NUMERIC>

* changed raises to calculates

* Update docs/querying/sql-functions.md

* switch to underscore

* changed to exp(1) to match slack message

* adding html text for trademark symbol to .spelling

* fixed discrepancy between description and example

---------

Co-authored-by: Benedict Jin <[email protected]>
(cherry picked from commit 721a650)

* [docs] batch02 of updating functions (#16761)

* applying changes

* ensuring batch is updated

* Update docs/querying/sql-functions.md

* raise -> raises

* addressing review

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit ca78788)

* [Docs] batch 03 - trig functions (#16795)

* batch 03 - trig functions

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

* applying suggestions and corrections

---------

Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit 028ee23)

* [Docs]Batch04 - Bitwise numeric functions (#16805)

* Batch04 - Bitwise numeric functions

* Batch04 - Bitwise numeric functions

* minor fixes

* rewording bitwise_shift functions

* rewording bitwise_shift functions

* Update docs/querying/sql-functions.md

* applying suggestions

---------

Co-authored-by: Benedict Jin <[email protected]>
(cherry picked from commit 85a8a1d)

* [docs] batch 5 updating functions (#16812)

* batch 5

* Update docs/querying/sql-functions.md

* applying suggestions

---------

Co-authored-by: Benedict Jin <[email protected]>
(cherry picked from commit 3bb6d40)

* [Docs] Batch06: starting string functions (#16838)

* batch06, starting string functions

* addind space after Syntax

* quick change

* correcting spelling

* Update docs/querying/sql-functions.md

* Update sql-functions.md

* applying suggestions

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-functions.md

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit ebea34a)

* [Docs] Batch08: adding examples to string functions (#16871)

* batch08 completed

* reviewing batch08

* apply corrections suggestions by @FrankChen021

(cherry picked from commit 5b94839)

* [Docs] Batch07: adding examples to string functions (#16862)

* Lower,Upper,Lpad,Rpad,Parse_long

* up to REGEXP_EXTRACT

* batch 07 ready for review

* updated definitions in scalar

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

* rpad and lpad

* addressing comments

* minor fixes

* improving examples based on suggestions

* matched -> matches

* correcting typo

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

---------

Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit 7256953)

* [Docs] Batch09: only `lookup` (#16878)

* [Docs] Batch09: only `lookup`

* slight changes

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* applying suggestiontions

* Apply suggestions from code review

Co-authored-by: Victoria Lim <[email protected]>

* otherwise null -> otherwise returns null

* updating definition in sql-scalar.md

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

* hoping to re-run web checks

* change replaceMissingValueWith -> defaultValue

* Update docs/querying/sql-scalar.md

Co-authored-by: Katya Macedo  <[email protected]>

* acronym_to_name -> airportcode_to_name

* shortens `airportcode_to_name` to `code_to_name`

---------

Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Victoria Lim <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit fda2d19)

* [docs] Batch10 date and time functions (#16900)

* just starting

* TIME_PARSE and TIME_FORMAT remaining

* fixing typo

* adding last two functions

* review sql-functions.md

* Apply suggestions from code review

Suggestions that were accepted as is

Co-authored-by: Katya Macedo  <[email protected]>

* Update docs/querying/sql-functions.md

Co-authored-by: Katya Macedo  <[email protected]>

* Update docs/querying/sql-functions.md

needed to confirm that it did indeed return as a number

Co-authored-by: Katya Macedo  <[email protected]>

* reviewing remaining suggestions

* addressing review for time_format

* Apply suggestions from code review

Accepted as is

Co-authored-by: Katya Macedo  <[email protected]>

* addressing final suggestion

* time_zone -> timezone

* timezone fix

---------

Co-authored-by: Katya Macedo <[email protected]>
(cherry picked from commit c4981e3)

* [docs] batch 12: reduction functions (#16930)

* [docs] batch 12: reduction functions

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-functions.md

* applying suggestions

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
(cherry picked from commit c49dc83)

* [docs] Batch13 IP functions (#16947)

* new datasource

* reviewing before pr

* Update docs/querying/sql-functions.md

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

* Applying suggestions to IPV4_PARSE

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit ed81126)

* [docs] Batch11 date and time functions (#16926)

* first draft of functions

* minor improvments

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-scalar.md

* Apply suggestions from code review

Accepted as is

Co-authored-by: Katya Macedo  <[email protected]>

* applying next round of suggestions

* fixing missing column name

* addressing floor and ceil functions

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* re-wording TIMESTAMPADD

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
(cherry picked from commit 2d9e92c)

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-functions.md

Co-authored-by: Benedict Jin <[email protected]>

* [docs] Batches 14-16, 18: HLL, Theta, Quantiles, other (#93)

Co-authored-by: Katya Macedo  <[email protected]>
Co-authored-by: edgar2020 <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Charles Smith <[email protected]>

* batches 20 21 24 25

* fix unnest list

* Add LISTAGG to spelling

* cherry pick batch 21

* cherry pick batch 21

---------

Co-authored-by: Edgar Melendrez <[email protected]>
Co-authored-by: Edgar Melendrez <[email protected]>
Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
317brian pushed a commit to 317brian/druid that referenced this pull request Jan 28, 2025
* docs: add examples for SQL functions (apache#16745)

* updating first batch of numeric functions

* First batch of functions

* addressing first few comments

* alphabetize list

* draft with suggestions applied

* minor discrepency expr -> <NUMERIC>

* changed raises to calculates

* Update docs/querying/sql-functions.md

* switch to underscore

* changed to exp(1) to match slack message

* adding html text for trademark symbol to .spelling

* fixed discrepancy between description and example

---------

Co-authored-by: Benedict Jin <[email protected]>
(cherry picked from commit 721a650)

* [docs] batch02 of updating functions (apache#16761)

* applying changes

* ensuring batch is updated

* Update docs/querying/sql-functions.md

* raise -> raises

* addressing review

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit ca78788)

* [Docs] batch 03 - trig functions (apache#16795)

* batch 03 - trig functions

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

* applying suggestions and corrections

---------

Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit 028ee23)

* [Docs]Batch04 - Bitwise numeric functions (apache#16805)

* Batch04 - Bitwise numeric functions

* Batch04 - Bitwise numeric functions

* minor fixes

* rewording bitwise_shift functions

* rewording bitwise_shift functions

* Update docs/querying/sql-functions.md

* applying suggestions

---------

Co-authored-by: Benedict Jin <[email protected]>
(cherry picked from commit 85a8a1d)

* [docs] batch 5 updating functions (apache#16812)

* batch 5

* Update docs/querying/sql-functions.md

* applying suggestions

---------

Co-authored-by: Benedict Jin <[email protected]>
(cherry picked from commit 3bb6d40)

* [Docs] Batch06: starting string functions (apache#16838)

* batch06, starting string functions

* addind space after Syntax

* quick change

* correcting spelling

* Update docs/querying/sql-functions.md

* Update sql-functions.md

* applying suggestions

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-functions.md

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit ebea34a)

* [Docs] Batch08: adding examples to string functions (apache#16871)

* batch08 completed

* reviewing batch08

* apply corrections suggestions by @FrankChen021

(cherry picked from commit 5b94839)

* [Docs] Batch07: adding examples to string functions (apache#16862)

* Lower,Upper,Lpad,Rpad,Parse_long

* up to REGEXP_EXTRACT

* batch 07 ready for review

* updated definitions in scalar

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

* rpad and lpad

* addressing comments

* minor fixes

* improving examples based on suggestions

* matched -> matches

* correcting typo

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

---------

Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit 7256953)

* [Docs] Batch09: only `lookup` (apache#16878)

* [Docs] Batch09: only `lookup`

* slight changes

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* applying suggestiontions

* Apply suggestions from code review

Co-authored-by: Victoria Lim <[email protected]>

* otherwise null -> otherwise returns null

* updating definition in sql-scalar.md

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

* hoping to re-run web checks

* change replaceMissingValueWith -> defaultValue

* Update docs/querying/sql-scalar.md

Co-authored-by: Katya Macedo  <[email protected]>

* acronym_to_name -> airportcode_to_name

* shortens `airportcode_to_name` to `code_to_name`

---------

Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Victoria Lim <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit fda2d19)

* [docs] Batch10 date and time functions (apache#16900)

* just starting

* TIME_PARSE and TIME_FORMAT remaining

* fixing typo

* adding last two functions

* review sql-functions.md

* Apply suggestions from code review

Suggestions that were accepted as is

Co-authored-by: Katya Macedo  <[email protected]>

* Update docs/querying/sql-functions.md

Co-authored-by: Katya Macedo  <[email protected]>

* Update docs/querying/sql-functions.md

needed to confirm that it did indeed return as a number

Co-authored-by: Katya Macedo  <[email protected]>

* reviewing remaining suggestions

* addressing review for time_format

* Apply suggestions from code review

Accepted as is

Co-authored-by: Katya Macedo  <[email protected]>

* addressing final suggestion

* time_zone -> timezone

* timezone fix

---------

Co-authored-by: Katya Macedo <[email protected]>
(cherry picked from commit c4981e3)

* [docs] batch 12: reduction functions (apache#16930)

* [docs] batch 12: reduction functions

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-functions.md

* applying suggestions

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
(cherry picked from commit c49dc83)

* [docs] Batch13 IP functions (apache#16947)

* new datasource

* reviewing before pr

* Update docs/querying/sql-functions.md

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* Apply suggestions from code review

Co-authored-by: Charles Smith <[email protected]>

* Applying suggestions to IPV4_PARSE

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
(cherry picked from commit ed81126)

* [docs] Batch11 date and time functions (apache#16926)

* first draft of functions

* minor improvments

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-scalar.md

* Apply suggestions from code review

Accepted as is

Co-authored-by: Katya Macedo  <[email protected]>

* applying next round of suggestions

* fixing missing column name

* addressing floor and ceil functions

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* Apply suggestions from code review

Co-authored-by: Katya Macedo  <[email protected]>

* re-wording TIMESTAMPADD

---------

Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
(cherry picked from commit 2d9e92c)

* Update docs/querying/sql-functions.md

* Update docs/querying/sql-functions.md

Co-authored-by: Benedict Jin <[email protected]>

* [docs] Batches 14-16, 18: HLL, Theta, Quantiles, other (apache#93)

Co-authored-by: Katya Macedo  <[email protected]>
Co-authored-by: edgar2020 <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Charles Smith <[email protected]>

* batches 20 21 24 25

* fix unnest list

* Add LISTAGG to spelling

* cherry pick batch 21

* cherry pick batch 21

---------

Co-authored-by: Edgar Melendrez <[email protected]>
Co-authored-by: Edgar Melendrez <[email protected]>
Co-authored-by: Benedict Jin <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Katya Macedo <[email protected]>
Co-authored-by: Charles Smith <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants