updateTableSchema

Available in VPC

Edit the columns (schema) of a table. The entire existing schema is replaced with the list of columns provided in the request body.

Request

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

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

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.
`tableName`	String	Required	Table name See getTable.

Request body

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

Field	Type	Required	Description
`columns`	Array	Required	Column list: columns Since the entire table schema will be replaced with the provided list, you must enter at least one item.

`columns`

The following describes columns.

Field	Type	Required	Description
`name`	String	Required	Column name 1-256 characters
`type`	String	Required	Column data type Example: `string`, `int`, `bigint`, `double`, `boolean`, `timestamp`, etc.
`typeValue`	String	Optional	Detailed definition of composite types Example: `array`, `struct`, `map`
`description`	String	Optional	Column description Up to 512 characters

Request example

The request example is as follows:

curl --location --request PUT 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/mydatabase/tables/mytable/schema' \
--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 '{
    "columns": [
        {
            "name": "id",
            "type": "bigint",
            "description": "primary key"
        },
        {
            "name": "name",
            "type": "string",
            "description": "user name"
        }
    ]
}'

Response

This section describes the response format.

Response body

If successful, it returns 204 No Content without a body.

Response status codes

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

HTTP Status	Description
204	No Content (modification successful)

Documentation Index