You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by li...@apache.org on 2019/09/17 21:40:31 UTC
[spark] branch master updated: [SPARK-28792][SQL][DOC] Document
CREATE DATABASE statement in SQL Reference
This is an automated email from the ASF dual-hosted git repository.
lixiao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/master by this push:
new dd32476 [SPARK-28792][SQL][DOC] Document CREATE DATABASE statement in SQL Reference
dd32476 is described below
commit dd32476a8250e82df554683e195c355459d10a5d
Author: sharangk <sh...@gmail.com>
AuthorDate: Tue Sep 17 14:40:08 2019 -0700
[SPARK-28792][SQL][DOC] Document CREATE DATABASE statement in SQL Reference
### What changes were proposed in this pull request?
Document CREATE DATABASE statement in SQL Reference Guide.
### Why are the changes needed?
Currently Spark lacks documentation on the supported SQL constructs causing
confusion among users who sometimes have to look at the code to understand the
usage. This is aimed at addressing this issue.
### Does this PR introduce any user-facing change?
Yes.
### Before:
There was no documentation for this.
### After:
### How was this patch tested?
Manual Review and Tested using jykyll build --serve
Closes #25595 from sharangk/createDbDoc.
Lead-authored-by: sharangk <sh...@gmail.com>
Co-authored-by: Xiao Li <ga...@gmail.com>
Signed-off-by: Xiao Li <ga...@gmail.com>
---
docs/sql-ref-syntax-ddl-create-database.md | 59 +++++++++++++++++++++++++++++-
1 file changed, 58 insertions(+), 1 deletion(-)
diff --git a/docs/sql-ref-syntax-ddl-create-database.md b/docs/sql-ref-syntax-ddl-create-database.md
index bbcd34a..ed0bbf6 100644
--- a/docs/sql-ref-syntax-ddl-create-database.md
+++ b/docs/sql-ref-syntax-ddl-create-database.md
@@ -19,4 +19,61 @@ license: |
limitations under the License.
---
-**This page is under construction**
+### Description
+Creates a database with the specified name. If database with the same name already exists, an exception will be thrown.
+
+### Syntax
+{% highlight sql %}
+CREATE {DATABASE | SCHEMA} [ IF NOT EXISTS ] database_name
+ [ COMMENT database_comment ]
+ [ LOCATION database_directory ]
+ [ WITH DBPROPERTIES (property_name=property_value [ , ...]) ]
+{% endhighlight %}
+
+### Parameters
+<dl>
+ <dt><code><em>database_name</em></code></dt>
+ <dd>Specifies the name of the database to be created.</dd>
+
+ <dt><code><em>IF NOT EXISTS</em></code></dt>
+ <dd>Creates a database with the given name if it doesn't exists. If a database with the same name already exists, nothing will happen.</dd>
+
+ <dt><code><em>database_directory</em></code></dt>
+ <dd>Path of the file system in which the specified database is to be created. If the specified path does not exist in the underlying file system, this command creates a directory with the path. If the location is not specified, the database will be created in the default warehouse directory, whose path is configured by the static configuration spark.sql.warehouse.dir.</dd>
+
+ <dt><code><em>database_comment</em></code></dt>
+ <dd>Specifies the description for the database.</dd>
+
+ <dt><code><em>WITH DBPROPERTIES (property_name=property_value [ , ...])</em></code></dt>
+ <dd>Specifies the properties for the database in key-value pairs.</dd>
+</dl>
+
+### Examples
+{% highlight sql %}
+-- Create database `customer_db`. This throws exception if database with name customer_db
+-- already exists.
+CREATE DATABASE customer_db;
+
+-- Create database `customer_db` only if database with same name doesn't exist.
+CREATE DATABASE IF NOT EXISTS customer_db;
+
+-- Create database `customer_db` only if database with same name doesn't exist with
+-- `Comments`,`Specific Location` and `Database properties`.
+CREATE DATABASE IF NOT EXISTS customer_db COMMENT 'This is customer database' LOCATION '/user'
+ WITH DBPROPERTIES (ID=001, Name='John');
+
+-- Verify that properties are set.
+DESCRIBE DATABASE EXTENDED customer_db;
+ +----------------------------+-----------------------------+
+ | database_description_item | database_description_value |
+ +----------------------------+-----------------------------+
+ | Database Name | customer_db |
+ | Description | This is customer database |
+ | Location | hdfs://hacluster/user |
+ | Properties | ((ID,001), (Name,John)) |
+ +----------------------------+-----------------------------+
+{% endhighlight %}
+
+### Related Statements
+- [DESCRIBE DATABASE](sql-ref-syntax-aux-describe-database.html)
+- [DROP DATABASE](sql-ref-syntax-ddl-drop-database.html)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org