srowen commented on a change in pull request #25561: [SPARK-28810][DOC][SQL]
Document SHOW TABLES in SQL Reference.
URL: https://github.com/apache/spark/pull/25561#discussion_r331549323
##########
File path: docs/sql-ref-syntax-aux-show-tables.md
##########
@@ -18,5 +18,86 @@ license: |
See the License for the specific language governing permissions and
limitations under the License.
---
+### Description
-**This page is under construction**
+The `SHOW TABLES` statement returns all the tables for an optionally specified
`database`.
+Additionally, the output of this statement may be filtered by an optional
matching
+pattern. If no database is specified then the tables are returned from the
+current database.
+
+### Syntax
+{% highlight sql %}
+SHOW TABLES [{FROM|IN} database_name] [LIKE 'regex_pattern']
+{% endhighlight %}
+
+### Parameters
+<dl>
+ <dt><code><em>{FROM|IN} database_name</em></code></dt>
+ <dd>
+ Specifies the `database` name from which tables are listed.
+ </dd>
+ <dt><code><em>LIKE 'regex_pattern'</em></code></dt>
+ <dd>
+ Specifies the regex pattern that is used to filter out unwanted tables.
+ <br> - The pattern is a regex except that `*` and `|`characters
Review comment:
"... except that `*` and `|` work differently"
----------------------------------------------------------------
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:
[email protected]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
