ianmcook commented on a change in pull request #10356:
URL: https://github.com/apache/arrow/pull/10356#discussion_r635595821
##########
File path: docs/source/cpp/compute.rst
##########
@@ -529,28 +529,36 @@ Containment tests
+---------------------------+------------+------------------------------------+---------------+----------------------------------------+
| Function name | Arity | Input types
| Output type | Options class |
+===========================+============+====================================+===============+========================================+
-| match_substring | Unary | String-like
| Boolean (1) | :struct:`MatchSubstringOptions` |
+| match_like | Unary | String-like
| Boolean (1) | :struct:`MatchSubstringOptions` |
+---------------------------+------------+------------------------------------+---------------+----------------------------------------+
-| match_substring_regex | Unary | String-like
| Boolean (2) | :struct:`MatchSubstringOptions` |
+| match_substring | Unary | String-like
| Boolean (2) | :struct:`MatchSubstringOptions` |
+---------------------------+------------+------------------------------------+---------------+----------------------------------------+
-| index_in | Unary | Boolean, Null, Numeric, Temporal,
| Int32 (3) | :struct:`SetLookupOptions` |
+| match_substring_regex | Unary | String-like
| Boolean (3) | :struct:`MatchSubstringOptions` |
++---------------------------+------------+------------------------------------+---------------+----------------------------------------+
+| index_in | Unary | Boolean, Null, Numeric, Temporal,
| Int32 (4) | :struct:`SetLookupOptions` |
| | | Binary- and String-like
| | |
+---------------------------+------------+------------------------------------+---------------+----------------------------------------+
-| is_in | Unary | Boolean, Null, Numeric, Temporal,
| Boolean (4) | :struct:`SetLookupOptions` |
+| is_in | Unary | Boolean, Null, Numeric, Temporal,
| Boolean (5) | :struct:`SetLookupOptions` |
| | | Binary- and String-like
| | |
+---------------------------+------------+------------------------------------+---------------+----------------------------------------+
-* \(1) Output is true iff :member:`MatchSubstringOptions::pattern`
- is a substring of the corresponding input element.
+* \(1) Output is true iff the SQL-style LIKE pattern
+ :member:`MatchSubstringOptions::pattern` fully matches the
+ corresponding input element. That is, ``%`` will match any number of
+ characters, ``_`` will match exactly one character, and any other
+ character matches itself.
Review comment:
IMO this is worth mentioning because some SQL engines (e.g. PostgreSQL)
use backslashes to escape `%` or `_` whereas others (e.g. Oracle) don't by
default.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
