From 589e8f1f17080b1dc34024972fdefa3c9ef77f9b Mon Sep 17 00:00:00 2001 From: Jesse Seldess Date: Mon, 26 Sep 2016 23:27:43 -0400 Subject: [PATCH] show database docs --- _data/sidebar_doc.yml | 3 ++ _includes/sql/diagrams/show_database.html | 14 ++++++++ generate/main.go | 1 + show-database.md | 42 +++++++++++++++++++++++ sql-statements.md | 1 + 5 files changed, 61 insertions(+) create mode 100644 _includes/sql/diagrams/show_database.html create mode 100644 show-database.md diff --git a/_data/sidebar_doc.yml b/_data/sidebar_doc.yml index 5552e2f8a80..098419da640 100644 --- a/_data/sidebar_doc.yml +++ b/_data/sidebar_doc.yml @@ -130,6 +130,9 @@ entries: - title: SHOW CREATE TABLE url: /show-create-table.html + - title: SHOW DATABASE + url: /show-database.html + - title: SHOW DATABASES url: /show-databases.html diff --git a/_includes/sql/diagrams/show_database.html b/_includes/sql/diagrams/show_database.html new file mode 100644 index 00000000000..e952b0f9bb3 --- /dev/null +++ b/_includes/sql/diagrams/show_database.html @@ -0,0 +1,14 @@ + + + + + + + SHOW + + + DATABASE + + + + \ No newline at end of file diff --git a/generate/main.go b/generate/main.go index 22a1c9bec6d..83120931ae5 100644 --- a/generate/main.go +++ b/generate/main.go @@ -213,6 +213,7 @@ func main() { {name: "show_columns", stmt: "show_stmt", match: regexp.MustCompile("'SHOW' 'COLUMNS'"), replace: map[string]string{"var_name": "table_name"}, unlink: []string{"table_name"}}, {name: "show_constraints", stmt: "show_stmt", match: regexp.MustCompile("'SHOW' 'CONSTRAINTS'"), replace: map[string]string{"var_name": "table_name"}, unlink: []string{"table_name"}}, {name: "show_create_table", stmt: "show_stmt", match: regexp.MustCompile("'SHOW' 'CREATE' 'TABLE'"), replace: map[string]string{"var_name": "table_name"}, unlink: []string{"table_name"}}, + {name: "show_database", stmt: "show_stmt", match: regexp.MustCompile("'SHOW' 'DATABASE'")}, {name: "show_databases", stmt: "show_stmt", match: regexp.MustCompile("'SHOW' 'DATABASES'")}, {name: "show_grants", stmt: "show_stmt", inline: []string{"on_privilege_target_clause", "privilege_target", "for_grantee_clause", "grantee_list"}, match: regexp.MustCompile("'SHOW' 'GRANTS'")}, {name: "show_index", stmt: "show_stmt", match: regexp.MustCompile("'SHOW' 'INDEX'"), replace: map[string]string{"var_name": "table_name"}, unlink: []string{"table_name"}}, diff --git a/show-database.md b/show-database.md new file mode 100644 index 00000000000..188592ad8d1 --- /dev/null +++ b/show-database.md @@ -0,0 +1,42 @@ +--- +title: SHOW DATABASE +summary: The SHOW DATABASE statement lists the default database for the current session. +toc: false +--- + +The `SHOW DATABASE` [statement](sql-statements.html) lists the default database for the current session. + +
+ +## Synopsis + +{% include sql/diagrams/show_database.html %} + +## Required Privileges + +No [privileges](privileges.html) are required to list the default database. + +## Example + +~~~ shell +$ cockroach sql --database=test +# Welcome to the cockroach SQL interface. +# All statements must be terminated by a semicolon. +# To exit: CTRL + D. +~~~ +~~~ sql +> SHOW DATABASE; +~~~ +~~~ ++----------+ +| DATABASE | ++----------+ +| test | ++----------+ +(1 row) +~~~ + +## See Also + +- [`SET DATABASE`](set-database.html) +- [Other SQL Statements](sql-statements.html) diff --git a/sql-statements.md b/sql-statements.md index 8d945ac6d6a..e5941b504af 100644 --- a/sql-statements.md +++ b/sql-statements.md @@ -35,6 +35,7 @@ Statement | Usage [`SHOW COLUMNS`](show-columns.html) | View details about columns in a table. [`SHOW CONSTRAINTS`](show-constraints.html) | List constraints on a table. [`SHOW CREATE TABLE`](show-create-table.html) | View the `CREATE TABLE` statement that would create a carbon copy of the specified table. +[`SHOW DATABASE`](show-database.html) | List the default database for the session. [`SHOW DATABASES`](show-databases.html) | List databases in the cluster. [`SHOW GRANTS`](show-grants.html) | View privileges granted to users. [`SHOW INDEX`](show-index.html) | View index information for a table.