DocsICP FilingConsole
官方文档
首页

Table

更新时间：
复制 MD 格式
产品详情
我的收藏

Parameter

Type

Description

Example

object

The data table object.

Id

string

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

The format is ${EntityType}:${instance ID or escaped URL}:${data catalog identifier}:${database name}:${schema name}:${table name}. Use an empty string as a placeholder for any non-existent level.

Note

For MaxCompute and DLF data types, use an empty string as a placeholder for the instance ID. For MaxCompute, the database name is the MaxCompute project name. You must provide a schema name for projects where the three-layer model is enabled. If the model is not enabled, use an empty string as a placeholder for the schema name.

Note

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

The following are the ID formats for several common data types:

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. 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, this is required only when the three-layer model is enabled for the project. If the model 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. Values vary by metadata collector type.

TABLE
PartitionKeys

array

The partition keys. 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 MaxCompute requires the three-layer model to be enabled for the project), ParentMetaEntityId is the database schema to which the table belongs. The format is ${EntityType}:${instance ID or escaped URL}:${data catalog identifier}:${database name}:${schema name}. Use an empty string as a placeholder for any non-existent level.

  • For other types, ParentMetaEntityId is the database to which the table belongs. The format is ${EntityType}:${instance ID or escaped URL}:${data catalog identifier}:${database name}. Use an empty string as a placeholder for any non-existent level.

Note

For MaxCompute and DLF data types, use an empty string as a placeholder for the instance ID. For MaxCompute, the database name is the MaxCompute project name. You must provide a schema name for projects where the three-layer model is enabled. If the model is not enabled, use an empty string as a placeholder for the schema name.

Note

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

The following are the ParentMetaEntityId formats for several common data types:

maxcompute-project:::project_name

maxcompute-schema:::project_name:schema_name (only when the three-layer 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. 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.

dlf-database::catalog_id:database_name
CreateTime

integer

The creation time, as a millisecond timestamp.

1736852168000
ModifyTime

integer

The modification time, as a millisecond timestamp.

1736852168000
TechnicalMetadata

object

The technical metadata.

Owner

string

The owner.

test_user
Location

string

The storage location.

oss://test-bucket/test_tbl
Compressed

boolean

Indicates 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 SerDe class.

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

object

The parameters.

string

The parameter value.

value
BusinessMetadata

object

The business metadata in DataWorks, including the readme, tags, categories, upstream producer tasks, and extension.

Readme

string

The readme.

## Readme
CustomAttributes

object

The custom attribute values. Each key is a custom attribute identifier, and each value is a list of attribute values.

array

The list of attribute values.

string

The attribute value.

John
Tags

array

The list of tags.

object

The tag information.

Key

string

The tag key. Required.

tag_key
Value

string

The tag value. Can be empty.

tag_value
Categories

array

The list of categories.

array

The hierarchy path of a single category (multi-level).

object

The category information.

Id

string

The category ID.

CATEGORY.456
Name

string

The name.

test category
ParentId

string

The parent category ID. Can be empty.

CATEGORY.123
UpstreamTasks

array

The list of upstream producer tasks.

object

The upstream producer task.

Id

integer

The task ID.

123456
Name

string

The task name.

test_task
Extension

object

The extension. Only the MaxCompute type is currently supported.

ProjectId

integer

The workspace ID.

234
EnvType

string

The environment type. Valid values:

  • Prod: The production environment.

  • Dev: The development environment.

Dev
ViewCount

integer

The number of views.

0
ReadCount

integer

The number of reads.

0
FavorCount

integer

The number of favorites.

0