2019-08-19 02:17:50 -04:00
|
|
|
---
|
|
|
|
layout: global
|
|
|
|
title: SHOW FUNCTIONS
|
|
|
|
displayTitle: SHOW FUNCTIONS
|
|
|
|
license: |
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
the License. You may obtain a copy of the License at
|
2020-05-10 13:57:25 -04:00
|
|
|
|
2019-08-19 02:17:50 -04:00
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
---
|
|
|
|
|
2019-09-04 14:47:10 -04:00
|
|
|
### Description
|
[SPARK-31383][SQL][DOC] Clean up the SQL documents in docs/sql-ref*
### What changes were proposed in this pull request?
This PR intends to clean up the SQL documents in `doc/sql-ref*`.
Main changes are as follows;
- Fixes wrong syntaxes and capitalize sub-titles
- Adds some DDL queries in `Examples` so that users can run examples there
- Makes query output in `Examples` follows the `Dataset.showString` (right-aligned) format
- Adds/Removes spaces, Indents, or blank lines to follow the format below;
```
---
license...
---
### Description
Writes what's the syntax is.
### Syntax
{% highlight sql %}
SELECT...
WHERE... // 4 indents after the second line
...
{% endhighlight %}
### Parameters
<dl>
<dt><code><em>Param Name</em></code></dt>
<dd>
Param Description
</dd>
...
</dl>
### Examples
{% highlight sql %}
-- It is better that users are able to execute example queries here.
-- So, we prepare test data in the first section if possible.
CREATE TABLE t (key STRING, value DOUBLE);
INSERT INTO t VALUES
('a', 1.0), ('a', 2.0), ('b', 3.0), ('c', 4.0);
-- query output has 2 indents and it follows the `Dataset.showString`
-- format (right-aligned).
SELECT * FROM t;
+---+-----+
|key|value|
+---+-----+
| a| 1.0|
| a| 2.0|
| b| 3.0|
| c| 4.0|
+---+-----+
-- Query statements after the second line have 4 indents.
SELECT key, SUM(value)
FROM t
GROUP BY key;
+---+----------+
|key|sum(value)|
+---+----------+
| c| 4.0|
| b| 3.0|
| a| 3.0|
+---+----------+
...
{% endhighlight %}
### Related Statements
* [XXX](xxx.html)
* ...
```
### Why are the changes needed?
The most changes of this PR are pretty minor, but I think the consistent formats/rules to write documents are important for long-term maintenance in our community
### Does this PR introduce any user-facing change?
Yes.
### How was this patch tested?
Manually checked.
Closes #28151 from maropu/MakeRightAligned.
Authored-by: Takeshi Yamamuro <yamamuro@apache.org>
Signed-off-by: Sean Owen <srowen@gmail.com>
2020-04-13 00:40:36 -04:00
|
|
|
|
2019-09-04 14:47:10 -04:00
|
|
|
Returns the list of functions after applying an optional regex pattern.
|
|
|
|
Given number of functions supported by Spark is quite large, this statement
|
2020-03-05 19:54:59 -05:00
|
|
|
in conjunction with [describe function](sql-ref-syntax-aux-describe-function.html)
|
2019-09-04 14:47:10 -04:00
|
|
|
may be used to quickly find the function and understand its usage. The `LIKE`
|
|
|
|
clause is optional and supported only for compatibility with other systems.
|
|
|
|
|
|
|
|
### Syntax
|
[SPARK-31383][SQL][DOC] Clean up the SQL documents in docs/sql-ref*
### What changes were proposed in this pull request?
This PR intends to clean up the SQL documents in `doc/sql-ref*`.
Main changes are as follows;
- Fixes wrong syntaxes and capitalize sub-titles
- Adds some DDL queries in `Examples` so that users can run examples there
- Makes query output in `Examples` follows the `Dataset.showString` (right-aligned) format
- Adds/Removes spaces, Indents, or blank lines to follow the format below;
```
---
license...
---
### Description
Writes what's the syntax is.
### Syntax
{% highlight sql %}
SELECT...
WHERE... // 4 indents after the second line
...
{% endhighlight %}
### Parameters
<dl>
<dt><code><em>Param Name</em></code></dt>
<dd>
Param Description
</dd>
...
</dl>
### Examples
{% highlight sql %}
-- It is better that users are able to execute example queries here.
-- So, we prepare test data in the first section if possible.
CREATE TABLE t (key STRING, value DOUBLE);
INSERT INTO t VALUES
('a', 1.0), ('a', 2.0), ('b', 3.0), ('c', 4.0);
-- query output has 2 indents and it follows the `Dataset.showString`
-- format (right-aligned).
SELECT * FROM t;
+---+-----+
|key|value|
+---+-----+
| a| 1.0|
| a| 2.0|
| b| 3.0|
| c| 4.0|
+---+-----+
-- Query statements after the second line have 4 indents.
SELECT key, SUM(value)
FROM t
GROUP BY key;
+---+----------+
|key|sum(value)|
+---+----------+
| c| 4.0|
| b| 3.0|
| a| 3.0|
+---+----------+
...
{% endhighlight %}
### Related Statements
* [XXX](xxx.html)
* ...
```
### Why are the changes needed?
The most changes of this PR are pretty minor, but I think the consistent formats/rules to write documents are important for long-term maintenance in our community
### Does this PR introduce any user-facing change?
Yes.
### How was this patch tested?
Manually checked.
Closes #28151 from maropu/MakeRightAligned.
Authored-by: Takeshi Yamamuro <yamamuro@apache.org>
Signed-off-by: Sean Owen <srowen@gmail.com>
2020-04-13 00:40:36 -04:00
|
|
|
|
2020-05-10 13:57:25 -04:00
|
|
|
```sql
|
|
|
|
SHOW [ function_kind ] FUNCTIONS [ [ LIKE ] { function_name | regex_pattern } ]
|
|
|
|
```
|
2019-09-04 14:47:10 -04:00
|
|
|
|
|
|
|
### Parameters
|
[SPARK-31383][SQL][DOC] Clean up the SQL documents in docs/sql-ref*
### What changes were proposed in this pull request?
This PR intends to clean up the SQL documents in `doc/sql-ref*`.
Main changes are as follows;
- Fixes wrong syntaxes and capitalize sub-titles
- Adds some DDL queries in `Examples` so that users can run examples there
- Makes query output in `Examples` follows the `Dataset.showString` (right-aligned) format
- Adds/Removes spaces, Indents, or blank lines to follow the format below;
```
---
license...
---
### Description
Writes what's the syntax is.
### Syntax
{% highlight sql %}
SELECT...
WHERE... // 4 indents after the second line
...
{% endhighlight %}
### Parameters
<dl>
<dt><code><em>Param Name</em></code></dt>
<dd>
Param Description
</dd>
...
</dl>
### Examples
{% highlight sql %}
-- It is better that users are able to execute example queries here.
-- So, we prepare test data in the first section if possible.
CREATE TABLE t (key STRING, value DOUBLE);
INSERT INTO t VALUES
('a', 1.0), ('a', 2.0), ('b', 3.0), ('c', 4.0);
-- query output has 2 indents and it follows the `Dataset.showString`
-- format (right-aligned).
SELECT * FROM t;
+---+-----+
|key|value|
+---+-----+
| a| 1.0|
| a| 2.0|
| b| 3.0|
| c| 4.0|
+---+-----+
-- Query statements after the second line have 4 indents.
SELECT key, SUM(value)
FROM t
GROUP BY key;
+---+----------+
|key|sum(value)|
+---+----------+
| c| 4.0|
| b| 3.0|
| a| 3.0|
+---+----------+
...
{% endhighlight %}
### Related Statements
* [XXX](xxx.html)
* ...
```
### Why are the changes needed?
The most changes of this PR are pretty minor, but I think the consistent formats/rules to write documents are important for long-term maintenance in our community
### Does this PR introduce any user-facing change?
Yes.
### How was this patch tested?
Manually checked.
Closes #28151 from maropu/MakeRightAligned.
Authored-by: Takeshi Yamamuro <yamamuro@apache.org>
Signed-off-by: Sean Owen <srowen@gmail.com>
2020-04-13 00:40:36 -04:00
|
|
|
|
2020-05-10 13:57:25 -04:00
|
|
|
* **function_kind**
|
|
|
|
|
2019-09-04 14:47:10 -04:00
|
|
|
Specifies the name space of the function to be searched upon. The valid name spaces are :
|
2020-05-10 13:57:25 -04:00
|
|
|
|
|
|
|
* **USER** - Looks up the function(s) among the user defined functions.
|
|
|
|
* **SYSTEM** - Looks up the function(s) among the system defined functions.
|
|
|
|
* **ALL** - Looks up the function(s) among both user and system defined functions.
|
|
|
|
|
|
|
|
* **function_name**
|
|
|
|
|
2019-09-04 14:47:10 -04:00
|
|
|
Specifies a name of an existing function in the system. The function name may be
|
|
|
|
optionally qualified with a database name. If `function_name` is qualified with
|
|
|
|
a database then the function is resolved from the user specified database, otherwise
|
2020-05-10 13:57:25 -04:00
|
|
|
it is resolved from the current database.
|
|
|
|
|
|
|
|
**Syntax:** `[ database_name. ] function_name`
|
|
|
|
|
|
|
|
* **regex_pattern**
|
|
|
|
|
2020-04-28 20:17:23 -04:00
|
|
|
Specifies a regular expression pattern that is used to filter the results of the
|
2019-09-04 14:47:10 -04:00
|
|
|
statement.
|
2020-05-10 13:57:25 -04:00
|
|
|
|
|
|
|
* Except for `*` and `|` character, the pattern works like a regular expression.
|
|
|
|
* `*` alone matches 0 or more characters and `|` is used to separate multiple different regular expressions,
|
|
|
|
any of which can match.
|
|
|
|
* The leading and trailing blanks are trimmed in the input pattern before processing. The pattern match is case-insensitive.
|
2019-09-04 14:47:10 -04:00
|
|
|
|
|
|
|
### Examples
|
[SPARK-31383][SQL][DOC] Clean up the SQL documents in docs/sql-ref*
### What changes were proposed in this pull request?
This PR intends to clean up the SQL documents in `doc/sql-ref*`.
Main changes are as follows;
- Fixes wrong syntaxes and capitalize sub-titles
- Adds some DDL queries in `Examples` so that users can run examples there
- Makes query output in `Examples` follows the `Dataset.showString` (right-aligned) format
- Adds/Removes spaces, Indents, or blank lines to follow the format below;
```
---
license...
---
### Description
Writes what's the syntax is.
### Syntax
{% highlight sql %}
SELECT...
WHERE... // 4 indents after the second line
...
{% endhighlight %}
### Parameters
<dl>
<dt><code><em>Param Name</em></code></dt>
<dd>
Param Description
</dd>
...
</dl>
### Examples
{% highlight sql %}
-- It is better that users are able to execute example queries here.
-- So, we prepare test data in the first section if possible.
CREATE TABLE t (key STRING, value DOUBLE);
INSERT INTO t VALUES
('a', 1.0), ('a', 2.0), ('b', 3.0), ('c', 4.0);
-- query output has 2 indents and it follows the `Dataset.showString`
-- format (right-aligned).
SELECT * FROM t;
+---+-----+
|key|value|
+---+-----+
| a| 1.0|
| a| 2.0|
| b| 3.0|
| c| 4.0|
+---+-----+
-- Query statements after the second line have 4 indents.
SELECT key, SUM(value)
FROM t
GROUP BY key;
+---+----------+
|key|sum(value)|
+---+----------+
| c| 4.0|
| b| 3.0|
| a| 3.0|
+---+----------+
...
{% endhighlight %}
### Related Statements
* [XXX](xxx.html)
* ...
```
### Why are the changes needed?
The most changes of this PR are pretty minor, but I think the consistent formats/rules to write documents are important for long-term maintenance in our community
### Does this PR introduce any user-facing change?
Yes.
### How was this patch tested?
Manually checked.
Closes #28151 from maropu/MakeRightAligned.
Authored-by: Takeshi Yamamuro <yamamuro@apache.org>
Signed-off-by: Sean Owen <srowen@gmail.com>
2020-04-13 00:40:36 -04:00
|
|
|
|
2020-05-10 13:57:25 -04:00
|
|
|
```sql
|
2019-09-04 14:47:10 -04:00
|
|
|
-- List a system function `trim` by searching both user defined and system
|
|
|
|
-- defined functions.
|
|
|
|
SHOW FUNCTIONS trim;
|
2020-05-01 13:11:43 -04:00
|
|
|
+--------+
|
|
|
|
|function|
|
|
|
|
+--------+
|
|
|
|
| trim|
|
|
|
|
+--------+
|
2019-09-04 14:47:10 -04:00
|
|
|
|
|
|
|
-- List a system function `concat` by searching system defined functions.
|
|
|
|
SHOW SYSTEM FUNCTIONS concat;
|
2020-05-01 13:11:43 -04:00
|
|
|
+--------+
|
|
|
|
|function|
|
|
|
|
+--------+
|
|
|
|
| concat|
|
|
|
|
+--------+
|
2019-09-04 14:47:10 -04:00
|
|
|
|
|
|
|
-- List a qualified function `max` from database `salesdb`.
|
|
|
|
SHOW SYSTEM FUNCTIONS salesdb.max;
|
2020-05-01 13:11:43 -04:00
|
|
|
+--------+
|
|
|
|
|function|
|
|
|
|
+--------+
|
|
|
|
| max|
|
|
|
|
+--------+
|
2019-09-04 14:47:10 -04:00
|
|
|
|
|
|
|
-- List all functions starting with `t`
|
|
|
|
SHOW FUNCTIONS LIKE 't*';
|
2020-05-01 13:11:43 -04:00
|
|
|
+-----------------+
|
|
|
|
| function|
|
|
|
|
+-----------------+
|
|
|
|
| tan|
|
|
|
|
| tanh|
|
|
|
|
| timestamp|
|
|
|
|
| tinyint|
|
|
|
|
| to_csv|
|
|
|
|
| to_date|
|
|
|
|
| to_json|
|
|
|
|
| to_timestamp|
|
|
|
|
|to_unix_timestamp|
|
|
|
|
| to_utc_timestamp|
|
|
|
|
| transform|
|
|
|
|
| transform_keys|
|
|
|
|
| transform_values|
|
|
|
|
| translate|
|
|
|
|
| trim|
|
|
|
|
| trunc|
|
|
|
|
| typeof|
|
|
|
|
+-----------------+
|
2019-09-04 14:47:10 -04:00
|
|
|
|
|
|
|
-- List all functions starting with `yea` or `windo`
|
|
|
|
SHOW FUNCTIONS LIKE 'yea*|windo*';
|
2020-05-01 13:11:43 -04:00
|
|
|
+--------+
|
|
|
|
|function|
|
|
|
|
+--------+
|
|
|
|
| window|
|
|
|
|
| year|
|
|
|
|
+--------+
|
2019-09-04 14:47:10 -04:00
|
|
|
|
|
|
|
-- Use normal regex pattern to list function names that has 4 characters
|
|
|
|
-- with `t` as the starting character.
|
|
|
|
SHOW FUNCTIONS LIKE 't[a-z][a-z][a-z]';
|
2020-05-01 13:11:43 -04:00
|
|
|
+--------+
|
|
|
|
|function|
|
|
|
|
+--------+
|
|
|
|
| tanh|
|
|
|
|
| trim|
|
|
|
|
+--------+
|
2020-05-10 13:57:25 -04:00
|
|
|
```
|
2019-09-04 14:47:10 -04:00
|
|
|
|
[SPARK-31383][SQL][DOC] Clean up the SQL documents in docs/sql-ref*
### What changes were proposed in this pull request?
This PR intends to clean up the SQL documents in `doc/sql-ref*`.
Main changes are as follows;
- Fixes wrong syntaxes and capitalize sub-titles
- Adds some DDL queries in `Examples` so that users can run examples there
- Makes query output in `Examples` follows the `Dataset.showString` (right-aligned) format
- Adds/Removes spaces, Indents, or blank lines to follow the format below;
```
---
license...
---
### Description
Writes what's the syntax is.
### Syntax
{% highlight sql %}
SELECT...
WHERE... // 4 indents after the second line
...
{% endhighlight %}
### Parameters
<dl>
<dt><code><em>Param Name</em></code></dt>
<dd>
Param Description
</dd>
...
</dl>
### Examples
{% highlight sql %}
-- It is better that users are able to execute example queries here.
-- So, we prepare test data in the first section if possible.
CREATE TABLE t (key STRING, value DOUBLE);
INSERT INTO t VALUES
('a', 1.0), ('a', 2.0), ('b', 3.0), ('c', 4.0);
-- query output has 2 indents and it follows the `Dataset.showString`
-- format (right-aligned).
SELECT * FROM t;
+---+-----+
|key|value|
+---+-----+
| a| 1.0|
| a| 2.0|
| b| 3.0|
| c| 4.0|
+---+-----+
-- Query statements after the second line have 4 indents.
SELECT key, SUM(value)
FROM t
GROUP BY key;
+---+----------+
|key|sum(value)|
+---+----------+
| c| 4.0|
| b| 3.0|
| a| 3.0|
+---+----------+
...
{% endhighlight %}
### Related Statements
* [XXX](xxx.html)
* ...
```
### Why are the changes needed?
The most changes of this PR are pretty minor, but I think the consistent formats/rules to write documents are important for long-term maintenance in our community
### Does this PR introduce any user-facing change?
Yes.
### How was this patch tested?
Manually checked.
Closes #28151 from maropu/MakeRightAligned.
Authored-by: Takeshi Yamamuro <yamamuro@apache.org>
Signed-off-by: Sean Owen <srowen@gmail.com>
2020-04-13 00:40:36 -04:00
|
|
|
### Related Statements
|
|
|
|
|
2020-05-10 13:57:25 -04:00
|
|
|
* [DESCRIBE FUNCTION](sql-ref-syntax-aux-describe-function.html)
|