<?xml version="1.0" encoding="UTF-8"?>
<!--
  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">

<document>
  <header>
    <title>DELETE ddl/database/:db</title>
  </header>

  <body>
  <section>
   <title>Description</title>
    <p>Delete a database.</p>
  </section>

  <section>
   <title>URL</title>
    <p><code>http://</code>www.myserver.com<code>/templeton/v1/ddl/database/</code>:db</p>
  </section>

  <section>
   <title>Parameters</title>
    <table>
    <tr><th>Name</th><th>Description</th><th>Required?</th><th>Default</th></tr>

    <tr><td><strong>:db</strong></td>
        <td>The database name</td>
        <td>Required</td>
        <td>None</td>
    </tr>

    <tr><td><strong>ifExists</strong></td>
        <td>Hive returns an error if the database specified does not exist,
            unless ifExists is set to true.</td>
        <td>Optional</td>
        <td>false</td>
    </tr>

    <tr><td><strong>option</strong></td>
        <td>Parameter set to either "restrict" or "cascade".  Restrict will remove the
            schema if all the tables are empty.  Cascade removes everything including
            data and definitions.</td>
        <td>Optional</td>
        <td>None</td>
    </tr>

    <tr><td><strong>group</strong></td>
        <td>The user group to use</td>
        <td>Optional</td>
        <td>None</td>
    </tr>

    <tr><td><strong>permissions</strong></td>
        <td>The permissions string to use.  The format is
          "<code>rwxrw-r-x</code>".</td>
        <td>Optional</td>
        <td>None</td>
    </tr>

    </table>
  </section>

  <section>
   <title>Results</title>
    <table>
    <tr><th>Name</th><th>Description</th></tr>

    <tr><td><strong>database</strong></td>
        <td>The database name</td>
    </tr>

    </table>
 </section>

  <section>
   <title>Example</title>

   <p><strong>Curl Command</strong></p>
<source>
% curl -s -X DELETE "http://localhost:50111/templeton/v1/ddl/database/newdb?user.name=ctdean"
</source>

   <p><strong>JSON Output</strong></p>
<source>
{
 "database":"newdb"
}
</source>

   <p><strong>JSON Output (error)</strong></p>
<source>
{
  "errorDetail": "
    NoSuchObjectException(message:There is no database named my_db)
        at org.apache.hadoop.hive.metastor...
    ",
  "error": "There is no database named newdb",
  "errorCode": 404,
  "database": "newdb"
}
</source>

  </section>
 </body>
</document>
