diff --git a/docs/sql-ref-syntax-aux-show-tables.md b/docs/sql-ref-syntax-aux-show-tables.md index e4340d608bf5..46cfe40dc260 100644 --- a/docs/sql-ref-syntax-aux-show-tables.md +++ b/docs/sql-ref-syntax-aux-show-tables.md @@ -18,5 +18,90 @@ 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 +
+
{FROM|IN} database_name
+
+ Specifies the database name from which tables are listed. +
+
LIKE regex_pattern
+
+ Specifies the regular expression pattern that is used to filter out unwanted tables. + + +
+
+ +### Example +{% highlight sql %} +-- List all tables in default database +SHOW TABLES; + +-----------+------------+--------------+--+ + | database | tableName | isTemporary | + +-----------+------------+--------------+--+ + | default | sam | false | + | default | sam1 | false | + | default | suj | false | + +-----------+------------+--------------+--+ + +-- List all tables from userdb database +SHOW TABLES FROM userdb; + +-----------+------------+--------------+--+ + | database | tableName | isTemporary | + +-----------+------------+--------------+--+ + | userdb | user1 | false | + | userdb | user2 | false | + +-----------+------------+--------------+--+ + +-- List all tables in userdb database +SHOW TABLES IN userdb; + +-----------+------------+--------------+--+ + | database | tableName | isTemporary | + +-----------+------------+--------------+--+ + | userdb | user1 | false | + | userdb | user2 | false | + +-----------+------------+--------------+--+ + +-- List all tables from default database matching the pattern `sam*` +SHOW TABLES FROM default LIKE 'sam*'; + +-----------+------------+--------------+--+ + | database | tableName | isTemporary | + +-----------+------------+--------------+--+ + | default | sam | false | + | default | sam1 | false | + +-----------+------------+--------------+--+ + +-- List all tables matching the pattern `sam*|suj` +SHOW TABLES LIKE 'sam*|suj'; + +-----------+------------+--------------+--+ + | database | tableName | isTemporary | + +-----------+------------+--------------+--+ + | default | sam | false | + | default | sam1 | false | + | default | suj | false | + +-----------+------------+--------------+--+ + +{% endhighlight %} + +### Related statements +- [CREATE TABLE](sql-ref-syntax-ddl-create-table.html) +- [DROP TABLE](sql-ref-syntax-ddl-drop-table.html) +- [CREATE DATABASE](sql-ref-syntax-ddl-create-database.html) +- [DROP DATABASE](sql-ref-syntax-ddl-drop-database.html) \ No newline at end of file