BatchCreateMetaEntities

DataWorks Professional Edition or a higher edition is required.

Extension Database

Set EntityType to custom_xxx-database, where xxx comes from the already created custom_xxx-table extension EntityDef.

Attributes

Extension Table

Set EntityType to custom_xxx-table. The columns of the table must also be registered here through Attributes.columns.

Attributes

Attributes.columns

columns is a JSON Array string within Attributes. Each object in the array supports the following fields:

Examples.

Create an extension database

{
  "Entities": [
    {
      "EntityType": "custom_demo-database",
      "Name": "ods",
      "Comment": "ODS database",
      "Attributes": {
        "parentMetaEntityId": "custom_demo:demo_source",
        "technicalMetadata.location": "oss://bucket/ods"
      },
      "CustomAttributes": {
        "biz_owner": ["data_team"]
      }
    }
  ]
}

Create an extension table and register columns

{
  "Entities": [
    {
      "EntityType": "custom_demo-table",
      "Name": "order_fact",
      "Comment": "Order fact table",
      "Attributes": {
        "parentMetaEntityId": "custom_demo-database:demo_source::ods",
        "tableType": "TABLE",
        "partitionKeys": "[\"dt\"]",
        "technicalMetadata.location": "oss://bucket/ods/order_fact",
        "technicalMetadata.compressed": "true",
        "technicalMetadata.parameters": "{\"retention\":\"30\",\"bizDomain\":\"trade\"}",
        "columns": "[{\"name\":\"id\",\"type\":\"BIGINT\",\"comment\":\"Primary key\",\"position\":1,\"primaryKey\":true,\"customAttributes\":{\"security_level\":[\"P1\"]}},{\"name\":\"dt\",\"type\":\"STRING\",\"comment\":\"Partition date\",\"position\":2,\"partitionKey\":true}]"
      },
      "CustomAttributes": {
        "biz_owner": ["data_team"]
      }
    }
  ]
}

Precautions

• The parentMetaEntityId of an extension database must be at the instance level, such as custom_demo:demo_source.

• The parentMetaEntityId of an extension table must be at the database level, such as custom_demo-database:demo_source::ods.

• Parent and child entities must belong to the same extension family. For example, the parent of custom_demo-table must be custom_demo-database.

• columns can only be provided when creating a table. You cannot use BatchCreateMetaEntities to independently create custom_xxx-column.

• The extension entity write path does not strictly block unknown Attributes keys based on MetaEntityDef.AttributeDefs. Unknown keys are typically ignored.