updateDatabase

Available in VPC

Edit database information.

Note

Request

This section describes the request format. The method and URI are as follows:

Method	URI
PUT	/api/v1/catalogs/{catalogId}/databases/{databaseName}

Request headers

For information about the headers common to all Data Catalog APIs, see Data Catalog request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`catalogId`	Integer	Required	Catalog ID See getCatalogs.
`databaseName`	String	Required	Database name See getDatabase.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`location`	String	Optional	Database location (path)
`description`	String	Optional	Database description Up to 1000 characters

Request example

The request example is as follows:

curl --location --request PUT 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/mydatabase' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "location": "s3a://mybucket/mydatabase",
    "description": "updated description"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`catalogId`	Integer	-	Catalog ID
`name`	String	-	Database name
`databaseName`	String	-	Database name
`description`	String	-	Database description Displayed if a value exists
`location`	String	-	Database location (path)
`createTime`	String	-	Database creation date and time ISO 8601 format
`updateTime`	String	-	Database modification date and time ISO 8601 format

Response status codes

For information about the HTTP status codes common to all Data Catalog APIs, see Data Catalog response status codes.

Response example

The response example is as follows:

{
    "catalogId": 4**,
    "name": "mydatabase",
    "databaseName": "mydatabase",
    "description": "updated description",
    "location": "s3a://mybucket/mydatabase",
    "createTime": "2026-06-25T14:44:55+0900",
    "updateTime": "2026-06-25T15:10:21+0900"
}

Documentation Index