diff --git a/docs/sql-ref-syntax-aux-describe-database.md b/docs/sql-ref-syntax-aux-describe-database.md index 5d1c9deb13a7a..c94383a82ef7e 100644 --- a/docs/sql-ref-syntax-aux-describe-database.md +++ b/docs/sql-ref-syntax-aux-describe-database.md @@ -18,5 +18,77 @@ license: | See the License for the specific language governing permissions and limitations under the License. --- +### Description +​ +`DESCRIBE DATABASE` statement returns the metadata of an existing database. The metadata information includes database +name, database comment, and database location on the filesystem. If the optional `EXTENDED` option is specified, it +returns the basic metadata information along with the database properties. The `DATABASE` and `SCHEMA` are +interchangeable. -**This page is under construction** +### Syntax +{% highlight sql %} +{DESC | DESCRIBE} DATABASE [EXTENDED] db_name +{% endhighlight %} + +### Parameters +
+
db_name
+
+ Specifies a name of an existing database or an existing schema in the syetem. If the name does not exist, an + exception is thrown. +
+
+ +### Example +{% highlight sql %} +-- Create employees DATABASE +CREATE DATABASE employees COMMENT 'For software companies'; + +-- Describe employees DATABASE. +-- Returns Database Name, Description and Root location of the filesystem +-- for the employees DATABASE. +DESCRIBE DATABASE employees; + +-------------------------+-----------------------------+ + |database_description_item|database_description_value | + +-------------------------+-----------------------------+ + |Database Name |employees | + |Description |For software companies | + |Location |file:/Users/Temp/employees.db| + +-------------------------+-----------------------------+ + +-- Create employees DATABASE +CREATE DATABASE employees COMMENT 'For software companies'; + +-- Alter employees database to set DBPROPERTIES +ALTER DATABASE employees SET DBPROPERTIES ('Create-by' = 'Kevin', 'Create-date' = '09/01/2019'); + +-- Describe employees DATABASE with EXTENDED option to return additional database properties +DESCRIBE DATABASE EXTENDED employees; + +-------------------------+---------------------------------------------+ + |database_description_item|database_description_value | + +-------------------------+---------------------------------------------+ + |Database Name |employees | + |Description |For software companies | + |Location |file:/Users/Temp/employees.db | + |Properties |((Create-by,kevin), (Create-date,09/01/2019))| + +-------------------------+---------------------------------------------+ + +-- Create deployment SCHEMA +CREATE SCHEMA deployment COMMENT 'Deployment environment'; + +-- Describe deployment, the DATABASE and SCHEMA are interchangeable, their meaning are the same. +DESC DATABASE deployment; + +-------------------------+------------------------------+ + |database_description_item|database_description_value | + +-------------------------+------------------------------+ + |Database Name |deployment | + |Description |Deployment environment | + |Location |file:/Users/Temp/deployment.db| + +-------------------------+------------------------------+ + +{% endhighlight %} + +### Related Statements +- [DESCRIBE FUNCTION](sql-ref-syntax-aux-describe-function.html) +- [DESCRIBE TABLE](sql-ref-syntax-aux-describe-table.html) +- [DESCRIBE QUERY](sql-ref-syntax-aux-describe-query.html)