[SPARK-31556][SQL][DOCS] Document LIKE clause in SQL Reference #28332

huaxingao · 2020-04-24T23:02:03Z

What changes were proposed in this pull request?

Document LIKE clause in SQL Reference

Why are the changes needed?

To make SQL Reference complete

Does this PR introduce any user-facing change?

Yes

How was this patch tested?

Manually build and check

SparkQA · 2020-04-24T23:20:25Z

Test build #121786 has finished for PR 28332 at commit 89fc5d6.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

maropu · 2020-04-25T00:45:16Z

docs/sql-ref-syntax-aux-show-databases.md

  <dd>
-    Specifies a string pattern that is used to match the databases in the system. In 
-    the specified string pattern <code>'*'</code> matches any number of characters.
+    Specifies a regular expression pattern that is used to limit the results of the


nit: limit -> filter?

maropu · 2020-04-25T00:54:40Z

docs/sql-ref-syntax-aux-show-databases.md

+    statement.
+    <ul>
+      <li>Only <code>*</code> and <code>|</code> are allowed as wildcard pattern.</li>
+      <li>Excluding <code>*</code> and <code>|</code> the remaining pattern follows the regex semantics.</li>


nit:

Excluding <code>*</code> and <code>|</code> -> Excluding <code>*</code> and <code>|</code>,

regex -> regular expression

maropu · 2020-04-25T00:54:51Z

docs/sql-ref-syntax-aux-show-databases.md

+    <ul>
+      <li>Only <code>*</code> and <code>|</code> are allowed as wildcard pattern.</li>
+      <li>Excluding <code>*</code> and <code>|</code> the remaining pattern follows the regex semantics.</li>
+      <li>The leading and trailing blanks are trimmed in the input pattern before processing.</li>


How about case sensitivity?

maropu · 2020-04-25T00:56:02Z

docs/sql-ref-syntax-qry-select-where.md

+  +---+----+---+
+  |200|Mary|null|
+  |300|Mike| 80|
+  +---+----+---+


nit: remove the leading spaces.

Could you add a example for LIKE ... ESCAPE..., too?

maropu · 2020-04-25T00:59:57Z

docs/sql-ref-syntax-qry-select-where.md

+    <b>Syntax:</b><br>
+      <code>
+        NOT boolean_expression | EXISTS ( query ) | column_name LIKE regex_pattern | value_expression |<br>
+        boolean_expression AND boolean_expression | boolean_expression OR boolean_expression


Could you add RLIKE and LIKE ... ESCAPE ... ?

maropu · 2020-04-25T01:01:08Z

docs/sql-ref-syntax-aux-show-views.md

  <dd>
     Specifies the regular expression pattern that is used to filter out unwanted views. 
     <ul> 
-          <li> Except for `*` and `|` character, the pattern works like a regex.</li>
-          <li> `*` alone matches 0 or more characters and `|` is used to separate multiple different regexes,
+          <li> Except for <code>*</code> and <code>|</code> character, the pattern works like a regex.</li>


nit: remove the space <li>Except...

huaxingao · 2020-04-25T22:58:53Z

docs/sql-ref-syntax-qry-select-like.md

+### Related Statements
+
+ * [SELECT](sql-ref-syntax-qry-select.html)
+ * [WHERE Clause](sql-ref-syntax-qry-select-where.html)


I separated the LIKE predicate from the WHERE clause page. It seems better to me this way. It's also easier to add LIKE ANY and LIKE ALL later.

You referred some existing documents in the other systems? For example, it seems PgSQL has a single page for patten-matching syntaxes. https://www.postgresql.org/docs/current/functions-matching.html

https://docs.oracle.com/cd/B13789_01/server.101/b10759/conditions016.htm
https://docs.snowflake.com/en/sql-reference/functions/like.html

LIKE ALL and LIKE ANY can be added to this page too later. I don't want to include these two now because this PR is for 3.0.

Yea, we should not include them in this PR.

SparkQA · 2020-04-25T23:10:38Z

Test build #121819 has finished for PR 28332 at commit 488684b.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

maropu · 2020-04-25T23:46:02Z

docs/sql-ref-syntax-qry-select-like.md

+<dl>
+  <dt><code><em>esc_char</em></code></dt>
+  <dd>
+    Specifies the escape character.


Could you describe the default escape char?

maropu · 2020-04-25T23:48:04Z

Looks fine.

huaxingao · 2020-04-26T00:07:34Z

docs/sql-ref-syntax-qry-select-like.md

+|200|Mary|null|
+---+----+----+
+
+SELECT * FROM person WHERE name LIKE '%\_%';


I am not sure to put %\_% or %\\_%
spark-sql takes one \
while spark shell requires two \

scala> sql("SELECT * FROM person WHERE name LIKE '%\_%'").show() <console>:1: error: invalid escape character sql("SELECT * FROM person WHERE name LIKE '%\_%'").show() ^

Ah, I see... I think a single \ is ok now. If we get user's feedbacks, we will update it then.

SparkQA · 2020-04-26T00:19:44Z

Test build #121820 has finished for PR 28332 at commit c5cbabc.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

huaxingao · 2020-04-28T16:04:44Z

cc @srowen

### What changes were proposed in this pull request? Document LIKE clause in SQL Reference ### Why are the changes needed? To make SQL Reference complete ### Does this PR introduce any user-facing change? Yes <img width="1050" alt="Screen Shot 2020-04-25 at 5 49 57 PM" src="https://user-images.githubusercontent.com/13592258/80294346-5babab80-871d-11ea-8ac9-51bbab0aca88.png"> <img width="1050" alt="Screen Shot 2020-04-25 at 5 50 24 PM" src="https://user-images.githubusercontent.com/13592258/80294347-5ea69c00-871d-11ea-8c51-7a90ee20f7da.png"> <img width="1050" alt="Screen Shot 2020-04-25 at 5 50 42 PM" src="https://user-images.githubusercontent.com/13592258/80294351-61a18c80-871d-11ea-9e75-e3345d2f52f5.png"> ### How was this patch tested? Manually build and check Closes #28332 from huaxingao/where_clause. Authored-by: Huaxin Gao <huaxing@us.ibm.com> Signed-off-by: Takeshi Yamamuro <yamamuro@apache.org> (cherry picked from commit d34cb59) Signed-off-by: Takeshi Yamamuro <yamamuro@apache.org>

maropu · 2020-04-29T00:18:08Z

ok, thanks. Merged to master/3.0.

huaxingao · 2020-04-29T00:30:15Z

Thanks! @maropu @srowen

[SPARK-31556][SQL][DOCS] Document LIKE clause in SQL Reference

4f0a812

probot-autolabeler bot added the DOCS label Apr 24, 2020

fix

89fc5d6

maropu reviewed Apr 25, 2020

View reviewed changes

address comments

488684b

huaxingao commented Apr 25, 2020

View reviewed changes

maropu reviewed Apr 25, 2020

View reviewed changes

add default escape char

c5cbabc

huaxingao commented Apr 26, 2020

View reviewed changes

srowen approved these changes Apr 28, 2020

View reviewed changes

maropu closed this in d34cb59 Apr 29, 2020

huaxingao deleted the where_clause branch April 29, 2020 00:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SPARK-31556][SQL][DOCS] Document LIKE clause in SQL Reference #28332

[SPARK-31556][SQL][DOCS] Document LIKE clause in SQL Reference #28332

huaxingao commented Apr 24, 2020 •

edited

SparkQA commented Apr 24, 2020

maropu Apr 25, 2020

maropu Apr 25, 2020

maropu Apr 25, 2020

maropu Apr 25, 2020

maropu Apr 25, 2020

maropu Apr 25, 2020

maropu Apr 25, 2020

huaxingao Apr 25, 2020

maropu Apr 25, 2020 •

edited

huaxingao Apr 25, 2020

huaxingao Apr 25, 2020

maropu Apr 25, 2020

SparkQA commented Apr 25, 2020

maropu Apr 25, 2020

maropu commented Apr 25, 2020

huaxingao Apr 26, 2020

maropu Apr 26, 2020

SparkQA commented Apr 26, 2020

huaxingao commented Apr 28, 2020

maropu commented Apr 29, 2020

huaxingao commented Apr 29, 2020

[SPARK-31556][SQL][DOCS] Document LIKE clause in SQL Reference #28332

[SPARK-31556][SQL][DOCS] Document LIKE clause in SQL Reference #28332

Conversation

huaxingao commented Apr 24, 2020 • edited

What changes were proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user-facing change?

How was this patch tested?

SparkQA commented Apr 24, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maropu Apr 25, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SparkQA commented Apr 25, 2020

Choose a reason for hiding this comment

maropu commented Apr 25, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SparkQA commented Apr 26, 2020

huaxingao commented Apr 28, 2020

maropu commented Apr 29, 2020

huaxingao commented Apr 29, 2020

huaxingao commented Apr 24, 2020 •

edited

maropu Apr 25, 2020 •

edited