updateTableSchema

VPC環境で利用できます。

テーブルのカラム(スキーマ)を変更します。リクエストボディで送信されたカラムリストにより、既存のスキーマがすべて置き換えられます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
PUT	/api/v1/catalogs/{catalogId}/databases/{databaseName}/tables/{tableName}/schema

リクエストヘッダ

Data Catalog APIで共通して使用されるヘッダの詳細は、Data Catalogのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	Required	カタログ ID getCatalogsを参照
`databaseName`	String	Required	データベース名 getDatabaseを参照
`tableName`	String	Required	テーブル名 getTableを参照

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`columns`	Array	Required	カラムリスト: columns 送信したリストによってテーブルスキーマがすべて置き換えられるため、少なくとも1つ以上入力

`columns`

columnsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	カラム名 1~256文字
`type`	String	Required	カラムのデータタイプ例) `string`、`int`、`bigint`、`double`、`boolean`、`timestamp`など
`typeValue`	String	Optional	複合タイプの詳細な定義例) `array`、`struct`、`map`
`description`	String	Optional	カラムの説明最大512文字

リクエスト例

リクエストのサンプルコードは次の通りです。

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

レスポンス

レスポンス形式を説明します。

レスポンスボディ

成功すると本文なしで204 No Contentを返します。

レスポンスステータスコード

Data Catalog APIで共通して使用されるレスポンスステータスコードの詳細は、Data Catalogのレスポンスステータスコードをご参照ください。

HTTP Status	説明
204	No Content (変更成功)

Documentation Index