Column Struct Fields and Metadata ID Format Overview - DataWorks - Alibaba Cloud - DataWorks

Parameter	Type	Description	Example
	object	The table column.
Id	string	The ID. For more information, see Metadata entity concepts. The format is `${EntityType}:${instance ID or encoded URL}:${DataCatalogIdentity}:${DatabaseName}:${PatternName}:${TableName}:${ColumnName}`. Use an empty character as a placeholder for levels that do not exist. Note For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For MaxCompute, the database name is the MaxCompute project name. Projects with the three-layer model enabled must include the schema name. For projects without the three-layer model enabled, use an empty string as a placeholder for the schema name. Note For StarRocks, the data catalog identifier is the catalog name. For DLF, the data catalog identifier is the catalog ID. Other types do not support the catalog level, and you can use an empty string as a placeholder. The following examples show the ID formats for several common types: `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. This is required when the data source is registered in instance mode. `encoded_jdbc_url`: The URL-encoded JDBC connection string. This is required when the data source is registered by 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, this is required only when the three-layer model is enabled for the project. If the three-layer model is not enabled, use an empty string as a placeholder. `table_name`: The table name. `column_name`: The column name.	maxcompute-column:::project_name:[schema_name]:table_name:column_name
Name	string	The name.	column_name
Comment	string	The comment.	字段1
TableId	string	The table ID. For more information, see the `Table` object.	maxcompute-table:::project_name:[schema_name]:table_name
Position	integer	The position.	1
Type	string	The type.	bigint
PrimaryKey	boolean	Indicates whether the column is a primary key. Currently, only MaxCompute is supported.	false
PartitionKey	boolean	Indicates whether the column is a partition key.	false
ForeignKey	boolean	Indicates whether the column is a foreign key. Currently, only MaxCompute is supported.	false
BusinessMetadata	object	The business metadata.
Description	string	The business description of the field. Currently, only MaxCompute, HMS (EMR cluster), and DLF types are supported.	字段1的业务描述
CustomAttributes	object	The custom attribute values, where key is the custom attribute identifier and value is the attribute value list.
	array	The attribute value list.
	string	The attribute value.	张三
StatisticsInfos	object
	string

object

The table column.

Id

string

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

The format is ${EntityType}:${instance ID or encoded URL}:${DataCatalogIdentity}:${DatabaseName}:${PatternName}:${TableName}:${ColumnName}. Use an empty character as a placeholder for levels that do not exist.

Note

For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For MaxCompute, the database name is the MaxCompute project name. Projects with the three-layer model enabled must include the schema name. For projects without the three-layer model enabled, use an empty string as a placeholder for the schema name.

Note

For StarRocks, the data catalog identifier is the catalog name. For DLF, the data catalog identifier is the catalog ID. Other types do not support the catalog level, and you can use an empty string as a placeholder.

The following examples show the ID formats for several common types:

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. This is required when the data source is registered in instance mode.
encoded_jdbc_url: The URL-encoded JDBC connection string. This is required when the data source is registered by 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, this is required only when the three-layer model is enabled for the project. If the three-layer model is not enabled, use an empty string as a placeholder.
table_name: The table name.
column_name: The column name.

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

Name

string

The name.

column_name

Comment

string

The comment.

字段1

TableId

string

The table ID. For more information, see the Table object.

maxcompute-table:::project_name:[schema_name]:table_name

Position

integer

The position.

1

Type

string

The type.

bigint

PrimaryKey

boolean

Indicates whether the column is a primary key. Currently, only MaxCompute is supported.

false

PartitionKey

boolean

Indicates whether the column is a partition key.

false

ForeignKey

boolean

Indicates whether the column is a foreign key. Currently, only MaxCompute is supported.

false

BusinessMetadata

object

The business metadata.

Description

string

The business description of the field. Currently, only MaxCompute, HMS (EMR cluster), and DLF types are supported.

字段1的业务描述

CustomAttributes

object

The custom attribute values, where key is the custom attribute identifier and value is the attribute value list.

array

The attribute value list.

string

The attribute value.

张三

StatisticsInfos

object

string