Table-DataWorks(DataWorks)-阿里云帮助中心

Parameter	Type	Description	Example
	object	The table object.
Id	string	The ID. For more information, see Metadata entity concepts. The format is `${EntityType}:${Instance ID or URL-encoded URL}:${Data catalog identifier}:${Database name}:${Schema name}:${Table name}`. Use an empty string as a placeholder for non-existent levels. Note For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For the MaxCompute type, the database name is the MaxCompute project name. Projects with the three-level model enabled must provide the schema name. For projects without the three-level model enabled, use an empty string as a placeholder for the schema name. Note For the StarRocks type, the data catalog identifier is the catalog name. For the DLF type, 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 ID formats for several common types are as follows: `maxcompute-table:::project_name:[schema_name]:table_name` `dlf-table::catalog_id:database_name::table_name` `hms-table:instance_id::database_name::table_name` `holo-table:instance_id::database_name:schema_name:table_name` `mysql-table:(instance_id\|encoded_jdbc_url)::database_name::table_name` Note Where: `instance_id`: The instance ID, which is required when the data source is registered in instance mode. `encoded_jdbc_url`: The URL-encoded JDBC connection string, which is required when the data source is registered in connection string mode. `catalog_id`: The DLF catalog ID. `project_name`: The MaxCompute project name. `database_name`: The database name. `schema_name`: The schema name. For the MaxCompute type, this is required only when the three-level model is enabled for the project. If it is not enabled, use an empty string as a placeholder. `table_name`: The table name.	dlf-table::catalog_id:database_name::table_name
Name	string	The name.	table_name
Comment	string	The comment.	Test table
TableType	string	The table type. The valid values depend on the metadata collector type.	TABLE
PartitionKeys	array	The list of partition keys. This parameter is empty for non-partitioned tables.
	string	The partition key.	ds
ParentMetaEntityId	string	The ID of the parent metadata entity. For more information, see Metadata entity concepts. For types that support schemas (`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle`, where the MaxCompute type requires the three-level model to be enabled for the project), `ParentMetaEntityId` is the database schema to which the table belongs. The format is `${EntityType}:${Instance ID or URL-encoded URL}:${Data catalog identifier}:${Database name}:${Schema name}`. Use an empty string as a placeholder for non-existent levels. For other types, `ParentMetaEntityId` is the database to which the table belongs. The format is `${EntityType}:${Instance ID or URL-encoded URL}:${Data catalog identifier}:${Database name}`. Use an empty string as a placeholder for non-existent levels. Note For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For the MaxCompute type, the database name is the MaxCompute project name. Note For the StarRocks type, the data catalog identifier is the catalog name. For the DLF type, 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 `ParentMetaEntityId` formats for several common types are as follows: `maxcompute-project:::project_name` `maxcompute-schema:::project_name:schema_name` (Only when the three-level model is enabled for the project) `dlf-database::catalog_id:database_name` `hms-database:instance_id::database_name` `holo-schema:instance_id::database_name:schema_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` Note Where: `instance_id`: The instance ID, which is required when the data source is registered in instance mode. `encoded_jdbc_url`: The URL-encoded JDBC connection string, which is required when the data source is registered in connection string mode. `catalog_id`: The DLF catalog ID. `project_name`: The MaxCompute project name. `database_name`: The database name. `schema_name`: The schema name.	dlf-database::catalog_id:database_name
CreateTime	integer	The creation time. The value is a timestamp in milliseconds.	1736852168000
ModifyTime	integer	The modification time. The value is a timestamp in milliseconds.	1736852168000
TechnicalMetadata	object	The technical metadata.
Owner	string	The owner.	test_user
Location	string	The storage location.	oss://test-bucket/test_tbl
Compressed	boolean	Specifies whether the table is compressed.	false
InputFormat	string	The input format.	org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat
OutputFormat	string	The output format.	org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat
SerializationLibrary	string	The class used for SerDe.	org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe
Parameters	object	The parameter information.
	string	The parameter information.	value
BusinessMetadata	object	The business metadata related to DataWorks, including the instructions, tags, categories, upstream output tasks, and extension information.
Readme	string	The instructions.	## Instructions
CustomAttributes	object	The custom attribute values, where the key is the custom attribute identifier and the value is the list of attribute values.
	array	The list of attribute values.
	string	The attribute value.	John Doe
Tags	array	The list of tags.
	object	The tag information.
Key	string	The tag key. This parameter cannot be empty.	tag_key
Value	string	The tag value. This parameter can be empty.	tag_value
Categories	array	The list of categories.
	array	The hierarchy list of a single category (multi-level category).
	object	The category information.
Id	string	The category ID.	CATEGORY.456
Name	string	The name.	测试类目
ParentId	string	The parent category ID. This field can be empty.	CATEGORY.123
UpstreamTasks	array	The list of upstream output tasks.
	object	The upstream output task.
Id	integer	The task ID.	123456
Name	string	The task name.	test_task
Extension	object	The extension information. This parameter is currently supported only for the MaxCompute type.
ProjectId	integer	The workspace ID.	234
EnvType	string	The environment type. Valid values: Prod: Production environment. Dev: Development environment.	Dev
ViewCount	integer	The number of views.	0
ReadCount	integer	The number of reads.	0
FavorCount	integer	The number of times added to favorites.	0
StatisticsInfos	object
	string

object

The table object.

Id

string

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

The format is ${EntityType}:${Instance ID or URL-encoded URL}:${Data catalog identifier}:${Database name}:${Schema name}:${Table name}. Use an empty string as a placeholder for non-existent levels.

Note

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

Note

For the StarRocks type, the data catalog identifier is the catalog name. For the DLF type, 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 ID formats for several common types are as follows:

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

dlf-table::catalog_id:database_name::table_name

hms-table:instance_id::database_name::table_name

holo-table:instance_id::database_name:schema_name:table_name

mysql-table:(instance_id|encoded_jdbc_url)::database_name::table_name

Note

Where:
instance_id: The instance ID, which is required when the data source is registered in instance mode.
encoded_jdbc_url: The URL-encoded JDBC connection string, which is required when the data source is registered in connection string mode.
catalog_id: The DLF catalog ID.
project_name: The MaxCompute project name.
database_name: The database name.
schema_name: The schema name. For the MaxCompute type, this is required only when the three-level model is enabled for the project. If it is not enabled, use an empty string as a placeholder.
table_name: The table name.

dlf-table::catalog_id:database_name::table_name

Name

string

The name.

table_name

Comment

string

The comment.

Test table

TableType

string

The table type. The valid values depend on the metadata collector type.

TABLE

PartitionKeys

array

The list of partition keys. This parameter is empty for non-partitioned tables.

string

The partition key.

ds

ParentMetaEntityId

string

The ID of the parent metadata entity. For more information, see Metadata entity concepts.

For types that support schemas (maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle, where the MaxCompute type requires the three-level model to be enabled for the project), ParentMetaEntityId is the database schema to which the table belongs. The format is ${EntityType}:${Instance ID or URL-encoded URL}:${Data catalog identifier}:${Database name}:${Schema name}. Use an empty string as a placeholder for non-existent levels.
For other types, ParentMetaEntityId is the database to which the table belongs. The format is ${EntityType}:${Instance ID or URL-encoded URL}:${Data catalog identifier}:${Database name}. Use an empty string as a placeholder for non-existent levels.

Note

For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For the MaxCompute type, the database name is the MaxCompute project name.

Note

For the StarRocks type, the data catalog identifier is the catalog name. For the DLF type, 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 ParentMetaEntityId formats for several common types are as follows:

maxcompute-project:::project_name

maxcompute-schema:::project_name:schema_name (Only when the three-level model is enabled for the project)

dlf-database::catalog_id:database_name

hms-database:instance_id::database_name

holo-schema:instance_id::database_name:schema_name

mysql-database:(instance_id|encoded_jdbc_url)::database_name

Note

Where:
instance_id: The instance ID, which is required when the data source is registered in instance mode.
encoded_jdbc_url: The URL-encoded JDBC connection string, which is required when the data source is registered in connection string mode.
catalog_id: The DLF catalog ID.
project_name: The MaxCompute project name.
database_name: The database name.
schema_name: The schema name.

dlf-database::catalog_id:database_name

CreateTime

integer

The creation time. The value is a timestamp in milliseconds.

1736852168000

ModifyTime

integer

The modification time. The value is a timestamp in milliseconds.

1736852168000

TechnicalMetadata

object

The technical metadata.

Owner

string

The owner.

test_user

Location

string

The storage location.

oss://test-bucket/test_tbl

Compressed

boolean

Specifies whether the table is compressed.

false

InputFormat

string

The input format.

org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat

OutputFormat

string

The output format.

org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat

SerializationLibrary

string

The class used for SerDe.

org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe

Parameters

object

The parameter information.

string

The parameter information.

value

BusinessMetadata

object

The business metadata related to DataWorks, including the instructions, tags, categories, upstream output tasks, and extension information.

Readme

string

The instructions.

## Instructions

CustomAttributes

object

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

array

The list of attribute values.

string

The attribute value.

John Doe