[
https://issues.apache.org/jira/browse/FLINK-5447?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15824565#comment-15824565
]
ASF GitHub Bot commented on FLINK-5447:
---------------------------------------
Github user fhueske commented on a diff in the pull request:
https://github.com/apache/flink/pull/3126#discussion_r96254835
--- Diff: docs/dev/table_api.md ---
@@ -1508,522 +1508,601 @@ Both the Table API and SQL come with a set of
built-in functions for data transf
<table class="table table-bordered">
<thead>
<tr>
- <th class="text-left" style="width: 40%">Function</th>
+ <th class="text-left" style="width: 40%">Comparison functions</th>
<th class="text-center">Description</th>
</tr>
</thead>
<tbody>
+
<tr>
<td>
{% highlight java %}
-ANY.as(name [, name ]* )
+ANY === ANY
{% endhighlight %}
</td>
<td>
- <p>Specifies a name for an expression i.e. a field. Additional
names can be specified if the expression expands to multiple fields.</p>
+ <p>Equals.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-ANY.isNull
+ANY !== ANY
{% endhighlight %}
</td>
<td>
- <p>Returns true if the given expression is null.</p>
+ <p>Not equal.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-ANY.isNotNull
+ANY > ANY
{% endhighlight %}
</td>
<td>
- <p>Returns true if the given expression is not null.</p>
+ <p>Greater than.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-BOOLEAN.isTrue
+ANY >= ANY
{% endhighlight %}
</td>
<td>
- <p>Returns true if the given boolean expression is true. False
otherwise (for null and false).</p>
+ <p>Greater than or equal.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-BOOLEAN.isFalse
+ANY < ANY
{% endhighlight %}
</td>
<td>
- <p>Returns true if given boolean expression is false. False
otherwise (for null and true).</p>
+ <p>Less than.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-BOOLEAN.isNotTrue
+ANY <= ANY
{% endhighlight %}
</td>
<td>
- <p>Returns true if the given boolean expression is not true (for
null and false). False otherwise.</p>
+ <p>Less than or equal.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-BOOLEAN.isNotFalse
+ANY.isNull
{% endhighlight %}
</td>
<td>
- <p>Returns true if given boolean expression is not false (for null
and true). False otherwise.</p>
+ <p>Returns true if the given expression is null.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-NUMERIC.exp()
+ANY.isNotNull
{% endhighlight %}
</td>
<td>
- <p>Calculates the Euler's number raised to the given power.</p>
+ <p>Returns true if the given expression is not null.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-NUMERIC.log10()
+STRING.like(STRING)
{% endhighlight %}
</td>
<td>
- <p>Calculates the base 10 logarithm of given value.</p>
+ <p>Returns true, if a string matches the specified LIKE pattern.
E.g. "Jo_n%" matches all strings that start with "Jo(arbitrary letter)n".</p>
</td>
</tr>
-
<tr>
<td>
{% highlight java %}
-NUMERIC.ln()
+STRING.similar(STRING)
{% endhighlight %}
</td>
<td>
- <p>Calculates the natural logarithm of given value.</p>
+ <p>Returns true, if a string matches the specified SQL regex
pattern. E.g. "A+" matches all strings that consist of at least one "A".</p>
</td>
</tr>
+ </tbody>
+</table>
+
+<table class="table table-bordered">
+ <thead>
+ <tr>
+ <th class="text-left" style="width: 40%">Logical functions</th>
+ <th class="text-center">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
<tr>
<td>
{% highlight java %}
-NUMERIC.power(NUMERIC)
+boolean1 || boolean2
{% endhighlight %}
</td>
<td>
- <p>Calculates the given number raised to the power of the other
value.</p>
+ <p>Whether <i>boolean1</i> is true or <i>boolean2</i> is true.</p>
--- End diff --
I think `returns true if` is more explicit than`Whether`.
> Sync documentation of built-in functions for Table API with SQL
> ---------------------------------------------------------------
>
> Key: FLINK-5447
> URL: https://issues.apache.org/jira/browse/FLINK-5447
> Project: Flink
> Issue Type: Improvement
> Components: Documentation, Table API & SQL
> Reporter: Timo Walther
> Assignee: Timo Walther
> Priority: Minor
>
> I will split up the documentation for the built-in functions similar to the
> SQL structure.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
