Deleting a Database

Function

This API is used to delete an empty database. If there are tables in the database to be deleted, delete all tables first. For details about the API used to delete tables, see Deleting a Table.

URI

• URI format

  DELETE /v1.0/{project_id}/databases/{database_name}

• Parameter description

  Table 1 URI parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.
  database_name	Yes	String	Name of the database to be deleted.

  Table 2 query parameter description

  Parameter	Mandatory	Type	Description
  cascade	No	Boolean	Specifies whether to forcibly delete the database. The value can be true or false. Default value: false.
  async	No	Boolean	Specifies whether to delete the database in asynchronous mode. The value can be true or false. Default value: false.

  

  The following is an example of the URL containing the query parameter:

  DELETE /v1.0/{project_id}/databases/{database_name}?cascade={is_cascade}&async={is_asyn}

Request

None

Response

Example Request

None

Example Response

• The following is an example of a successful response in synchronous mode:

  {
   "is_success": true,
   "message": "",
   "job_mode": "sync"
  }

• The following is an example of a successful response in asynchronous mode:

  {
   "is_success": true,
   "message": "",
   "job_id": "208b08d4-0dc2-4dd7-8879-ddd4c020d7aa",
   "job_type": "DDL",
   "job_mode": "async"
  }

  

  • If the database is deleted asynchronously, you can view the current job status by calling the API for querying job status. For details, see Querying Job Status.
  • If cascade is set to true, all tables in the database will be deleted. Exercise caution when performing this operation.

Status Codes

Table 4 describes the status code.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.