Deleting a Database (Discarded)

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 (Discarded).

Note

This API has been discarded and is not recommended.

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.

    Note

    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

Table 3 Response parameters

Parameter

Mandatory

Type

Description

is_success

No

Boolean

Whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

No

String

System prompt. If execution succeeds, the parameter setting may be left blank.

job_id

No

String

Returned job ID, which can be used to obtain the job status and result.

job_type

No

String

Type of a job. The options are as follows:

  • DDL

  • DCL

  • IMPORT

  • EXPORT

  • QUERY

  • INSERT

job_mode

No

String

Job execution mode. The options are as follows:

  • async: asynchronous

  • sync: synchronous

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"
    }
    

    Note

    • 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.

Table 4 Status codes

Status Code

Description

200

Deletion succeeded.

400

Request error.

500

Internal service error.

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 Codes.