Column-阿里云帮助中心

Parameter	Type	Description	Example
	object	A field.
Id	string	The ID. For more information, see Metadata entity concepts. The format is `${EntityType}:${instance ID or URL-encoded connection string}:${data catalog identifier}:${database name}:${schema name}:${table name}:${field name}`. Use an empty string for any level that does not exist. Note For MaxCompute and DLF types, use an empty string for the instance ID. For MaxCompute, the database name is the MaxCompute project name. If the project uses the three-layer model, provide the schema name. Otherwise, use an empty string for the schema name. Note For StarRocks, the data catalog identifier is the catalog name. For DLF, it is the catalog ID. Other types do not support the catalog level, so use an empty string. Examples of common ID formats: `maxcompute-column:::project_name:[schema_name]:table_name:column_name` `dlf-column::catalog_id:database_name::table_name:column_name` `hms-column:instance_id::database_name::table_name:column_name` `holo-column:instance_id::database_name:schema_name:table_name:column_name` `mysql-column:(instance_id\|encoded_jdbc_url)::database_name::table_name:column_name` Note Where: `instance_id`: The instance ID, required when the data source is registered in instance mode. `encoded_jdbc_url`: The URL-encoded JDBC connection string, required when the data source is registered using a connection string. `catalog_id`: The DLF catalog ID. `project_name`: The MaxCompute project name. `database_name`: The database name. `schema_name`: The schema name. For MaxCompute, provide this only if the project uses the three-layer model. Otherwise, use an empty string. `table_name`: The table name. `column_name`: The field name.	maxcompute-column:123456::test_project:default:test_tbl:col1
Name	string	The name.	col1
Comment	string	The comment.	字段1
TableId	string	The table ID. For details, see the `Table` object.	maxcompute-table:123456::test_project:default:test_tbl
Position	integer	The position.	1
Type	string	The type.	bigint
PrimaryKey	boolean	Indicates whether the field is a primary key. Only MaxCompute supports this property.	false
PartitionKey	boolean	Indicates whether the field is a partition key.	false
ForeignKey	boolean	Indicates whether the field is a foreign key. Only MaxCompute supports this property.	false
BusinessMetadata	object	Business metadata.
Description	string	The business description of the field. Supported only for MaxCompute, HMS (EMR cluster), and DLF types.	字段1的业务描述
CustomAttributes	object	Custom attribute values. The key is the custom attribute identifier, and the value is a list of attribute values.
	array	A list of attribute values.
	string	An attribute value.	张三

object

A field.

Id

string

The ID. For more information, see Metadata entity concepts.

The format is ${EntityType}:${instance ID or URL-encoded connection string}:${data catalog identifier}:${database name}:${schema name}:${table name}:${field name}. Use an empty string for any level that does not exist.

Note

For MaxCompute and DLF types, use an empty string for the instance ID. For MaxCompute, the database name is the MaxCompute project name. If the project uses the three-layer model, provide the schema name. Otherwise, use an empty string for the schema name.

Note

For StarRocks, the data catalog identifier is the catalog name. For DLF, it is the catalog ID. Other types do not support the catalog level, so use an empty string.

Examples of common ID formats:

maxcompute-column:::project_name:[schema_name]:table_name:column_name

dlf-column::catalog_id:database_name::table_name:column_name

hms-column:instance_id::database_name::table_name:column_name

holo-column:instance_id::database_name:schema_name:table_name:column_name

mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name

Note

Where:
instance_id: The instance ID, required when the data source is registered in instance mode.
encoded_jdbc_url: The URL-encoded JDBC connection string, required when the data source is registered using a connection string.
catalog_id: The DLF catalog ID.
project_name: The MaxCompute project name.
database_name: The database name.
schema_name: The schema name. For MaxCompute, provide this only if the project uses the three-layer model. Otherwise, use an empty string.
table_name: The table name.
column_name: The field name.

maxcompute-column:123456::test_project:default:test_tbl:col1

Name

string

The name.

col1

Comment

string

The comment.

字段1

TableId

string

The table ID. For details, see the Table object.

maxcompute-table:123456::test_project:default:test_tbl

Position

integer

The position.

1

Type

string

The type.

bigint

PrimaryKey

boolean

Indicates whether the field is a primary key. Only MaxCompute supports this property.

false

PartitionKey

boolean

Indicates whether the field is a partition key.

false

ForeignKey

boolean

Indicates whether the field is a foreign key. Only MaxCompute supports this property.

false

BusinessMetadata

object

Business metadata.

Description

string

The business description of the field. Supported only for MaxCompute, HMS (EMR cluster), and DLF types.

字段1的业务描述

CustomAttributes

object

Custom attribute values. The key is the custom attribute identifier, and the value is a list of attribute values.

array

A list of attribute values.

string

An attribute value.

张三