All Products
Search

This Product

    DataWorks:Database

    Document Center

    DataWorks:Database

    Last Updated:Jan 12, 2026
    ParameterTypeDescriptionExample
    object

    The information about the database.

    Idstring

    The database ID. For more information, see Concepts related to metadata entities.

    The common format of this parameter is ${Entity type}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}. If a level does not exist, specify an empty string as a placeholder.

    Note For StarRocks data sources, specify a catalog name at the Catalog identifier level. For DLF data sources, specify a catalog ID at the Catalog identifier level. Other types of data sources do not support the Catalog identifier level. You can specify an empty string as a placeholder.

    You can configure this parameter in one of the following formats based on your data source type:

    dlf-database::catalog_id:database_name

    holo-database:instance_id::database_name

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

    Note
    catalog_id: the ID of a DLF catalog.
    instance_id: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.
    encoded_jdbc_url: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.
    database_name: the name of a database.
    		holo-database:h-xxxx::test_db
    Namestring

    The database name.

    		test_db
    Commentstring

    The comments.

    		test comment
    LocationUristring

    The uniform resource identifier (URI) of the storage location.

    		oss://test-bucket/test_db
    ParentMetaEntityIdstring

    The parent entity ID. For more information, see Concepts related to metadata entities.

    You can call the ListCrawlerTypes operation to query the parent entity types.

    • If the parent entity is a catalog, you can configure the ParentMetaEntityId parameter by referring to the Catalog topic.
    • If the parent entity is a metadata crawler, you can configure the ParentMetaEntityId parameter in the ${Crawler type}:${Instance ID or escaped URL} format.

    You can configure the ParentMetaEntityId parameter in one of the following formats based on your data source type:

    dlf-catalog::catalog_id

    holo:instance_id

    mysql:(instance_id|encoded_jdbc_url)

    Note
    catalog_id: the ID of a DLF catalog.
    instance_id: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.
    encoded_jdbc_url: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.
    		holo:h-xxxx
    CreateTimelong

    The creation time. This value is a UNIX timestamp. Unit: milliseconds.

    		1736852168000
    ModifyTimelong

    The update time. This value is a UNIX timestamp. Unit: milliseconds.

    		1736852168000