[
https://issues.apache.org/jira/browse/FLINK-5447?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15824566#comment-15824566
]
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_r96255434
--- 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>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-NUMERIC.sqrt()
+boolean1 && boolean2
{% endhighlight %}
</td>
<td>
- <p>Calculates the square root of a given value.</p>
+ <p>Whether <i>boolean1</i> and <i>boolean2</i> are both true.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-NUMERIC.abs()
+!BOOLEAN
{% endhighlight %}
</td>
<td>
- <p>Calculates the absolute value of given value.</p>
+ <p>Whether boolean expression is not true; returns null if boolean
is null.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-NUMERIC.floor()
+BOOLEAN.isTrue
{% endhighlight %}
</td>
<td>
- <p>Calculates the largest integer less than or equal to a given
number.</p>
+ <p>Returns true if the given boolean expression is true. False
otherwise (for null and false).</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-NUMERIC.ceil()
+BOOLEAN.isFalse
{% endhighlight %}
</td>
<td>
- <p>Calculates the smallest integer greater than or equal to a
given number.</p>
+ <p>Returns true if given boolean expression is false. False
otherwise (for null and true).</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-STRING.substring(INT, INT)
+BOOLEAN.isNotTrue
{% endhighlight %}
</td>
<td>
- <p>Creates a substring of the given string at the given index for
the given length. The index starts at 1 and is inclusive, i.e., the character
at the index is included in the substring. The substring has the specified
length or less.</p>
+ <p>Returns true if the given boolean expression is not true (for
null and false). False otherwise.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-STRING.substring(INT)
+BOOLEAN.isNotFalse
{% endhighlight %}
</td>
<td>
- <p>Creates a substring of the given string beginning at the given
index to the end. The start index starts at 1 and is inclusive.</p>
+ <p>Returns true if given boolean expression is not false (for null
and true). False otherwise.</p>
</td>
</tr>
+ </tbody>
+</table>
+
+
+<table class="table table-bordered">
+ <thead>
<tr>
+ <th class="text-left" style="width: 40%">Arithmetic functions</th>
+ <th class="text-center">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+ <tr>
<td>
{% highlight java %}
-STRING.trim(LEADING, STRING)
-STRING.trim(TRAILING, STRING)
-STRING.trim(BOTH, STRING)
-STRING.trim(BOTH)
-STRING.trim()
++ numeric
{% endhighlight %}
</td>
<td>
- <p>Removes leading and/or trailing characters from the given
string. By default, whitespaces at both sides are removed.</p>
+ <p>Returns <i>numeric</i>.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-STRING.charLength()
+- numeric
{% endhighlight %}
</td>
<td>
- <p>Returns the length of a String.</p>
+ <p>Returns negative <i>numeric</i>.</p>
</td>
</tr>
-
+
<tr>
<td>
{% highlight java %}
-STRING.upperCase()
+numeric1 + numeric2
{% endhighlight %}
</td>
<td>
- <p>Returns all of the characters in a string in upper case using
the rules of the default locale.</p>
+ <p>Returns <i>numeric1</i> plus <i>numeric2</i>.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-STRING.lowerCase()
+numeric1 - numeric2
{% endhighlight %}
</td>
<td>
- <p>Returns all of the characters in a string in lower case using
the rules of the default locale.</p>
+ <p>Returns <i>numeric1</i> minus <i>numeric2</i>.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-STRING.initCap()
+numeric1 * numeric2
{% endhighlight %}
</td>
-
<td>
- <p>Converts the initial letter of each word in a string to
uppercase. Assumes a string containing only [A-Za-z0-9], everything else is
treated as whitespace.</p>
+ <p>Returns <i>numeric1</i> multiplied by <i>numeric2</i>.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-STRING.like(STRING)
+numeric1 / numeric2
{% endhighlight %}
</td>
<td>
- <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>
+ <p>Returns <i>numeric1</i> divided by <i>numeric2</i>.</p>
</td>
</tr>
<tr>
<td>
{% highlight java %}
-STRING.similar(STRING)
+NUMERIC.power(NUMERIC)
{% endhighlight %}
</td>
<td>
- <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>
+ <p>Calculates the given number raised to the power of the other
value.</p>
--- End diff --
use `numeric1` and `numeric2` to refer to the parameters?
> 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)
