-
Notifications
You must be signed in to change notification settings - Fork 29k
[SPARK-28792][SQL][DOC] Document CREATE DATABASE statement in SQL Reference. #25595
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
63d035a
321cff9
7ef960b
5cb4c42
0225553
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 database to be created. If the specified path does not exist in the underlying file system, this command creates a directory with the path. If location is not specified, database will be created in default warehouse directory.</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 pair.</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) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sharangk in which the specified database is to be created ?