Domain name for API request: cdwdoris.tencentcloudapi.com.
This API is used to modify the attributes of a specified table. The API parameters are consistent with those for creating a table.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: UpdateTableSchema. |
Version | Yes | String | Common Params. The value used for this API: 2021-12-28. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Resource ID, which is the TCHouse-D resource ID used for table creation. |
DbName | Yes | String | Database name |
TableName | Yes | String | Table name |
Columns.N | Yes | Array of Column | Column |
Distribution | Yes | Distribution | Bucket information |
UserName | No | String | Use the user who has corresponding permissions for operations. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in. |
PassWord | No | String | Password corresponding to the user. If the TCHouse-D cluster uses a kernel account registered by a CAM user, you do not need to fill it in. |
IndexInfos.N | No | Array of IndexInfo | Index information. The inverted index and N-Gram index can be configured through this parameter. The Prefix index is related to the sort key and key column, and do not require additional configuration. Configure bloom_filter_columns in the table attribute when BloomFilter index is required. |
TableComment | No | String | Table description |
Properties.N | No | Array of Property | Table attribute |
Parameter Name | Type | Description |
---|---|---|
Message | String | Error message |
Success | Boolean | Is it successful |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateTableSchema
<Common request parameters>
{
"InstanceId": "cdwdoris-7da9fumk",
"DbName": "demo1",
"TableName": "my_table_partition",
"Columns": [
{
"Name": "id",
"Type": "BIGINT",
"IsDistribution": true,
"IsKey": true,
"IsNull":true
},
{
"Name": "name",
"Type": "VARCHAR(50)",
"IsKey": true,
"IsNull":true
},
{
"Name": "name446",
"Type": "VARCHAR(50)",
"IsNull":false,
"DefaultValue": "1"
},
{
"Name": "name449",
"Type": "VARCHAR(50)",
"IsNull":false,
"DefaultValue": "33"
},
{
"Name": "name333",
"Type": "VARCHAR(50)",
"IsNull":true,
"DefaultValue": "1"
},
{
"Name": "age2",
"Type": "INT",
"IsNull":true
},
{
"Name": "salary",
"Type": "DECIMAL(10, 5)",
"IsNull":true
},
{
"Name": "join_date",
"Type": "DATE",
"IsPartition":true,
"IsNull":true
}
],
"IndexInfos": [
{
"IdxType": "NGRAM_BF",
"ColumnName": "name333",
"IdxName": "idx_name",
"IdxComment": "Optional comment about the index",
"IdxProperties": [{
"PropertyKey":"gram_size",
"PropertyValue":"3"
},
{
"PropertyKey":"bf_size",
"PropertyValue":"1024"
}]
}
],
"Distribution": {
"DistributionType": "HASH",
"Count": 64
},
"TableComment": "Optional comment about the table=3",
"Properties": [
{
"PropertyKey": "bloom_filter_columns",
"PropertyValue": "age2"
}
]
}
{
"Response": {
"RequestId": "xx-xx-xx-xx-xx",
"Success": true,
"Message": "Table schema updated successfully."
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
本页内容是否解决了您的问题?