Skip to content

[SPARK-28789][DOCS][SQL] Document ALTER DATABASE command #25523

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.

Sign up for GitHub

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

Closed
dilipbiswal wants to merge 7 commits into from
Closed

[SPARK-28789][DOCS][SQL] Document ALTER DATABASE command #25523

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b0e4c64
[SPARK-28789] Document ALTER DATABASE command
dilipbiswal Aug 21, 2019
4b70e0c
Code review
dilipbiswal Aug 21, 2019
42a7e4e
css changes for parameters
dilipbiswal Aug 28, 2019
3eb967c
changes
dilipbiswal Aug 28, 2019
0d130f6
nit
dilipbiswal Aug 28, 2019
ffa449f
minor
dilipbiswal Aug 28, 2019
843f705
Update sql-ref-syntax-ddl-alter-database.md
gatorsmile Aug 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion docs/sql-ref-syntax-ddl-alter-database.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,23 @@ license: |
See the License for the specific language governing permissions and
limitations under the License.
---
### Description
You can author metadata associated with a database by setting the `DBPROPERTIES`. Using this command
Copy link
Member

@srowen srowen Aug 21, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove "the" before DBPROPERTIES here and below?
And maybe back-tick SCHEMA and DATABASE.

you can set key-value pairs in the `DBPROPERTIES`. The specified property values override any existing
value with the same property name. Please note that the usage of SCHEMA and DATABASE are interchangable
and mean the same thing. An error message is issued if the database does not exist in the system. This
command is mostly used to record the metadata for a database and can be used for auditing purposes.

### Syntax
{% highlight sql %}
ALTER {DATABASE | SCHEMA} database_name SET DBPROPERTIES (propery_name=property_value, ...)
{% endhighlight %}

### Example
{% highlight sql %}
ALTER DATABASE inventory SET DBPROPERTIES ('Edited-by' = 'John', 'Edit-date' = '01/01/2001')
{% endhighlight %}

You can use [describe-database](sql-ref-syntax-aux-describe-database.html) command to verify the setting
of properties.

**This page is under construction**