All Products
Search

This Product

    DataWorks:DLF Catalog data management

    Document Center

    DataWorks:DLF Catalog data management

    Last Updated:Nov 14, 2025

    The data catalog provides a unified interface for managing DLF Catalog metadata. This topic describes how to use the data catalog to create and manage database and table metadata.

    Go to the DLF Catalog data catalog page

    1. Go to the Workspaces page in the DataWorks console. In the top navigation bar, select a desired region. Find the desired workspace and choose Shortcuts > Data Studio in the Actions column.

    2. In the navigation pane on the left, click the image icon. In the Data Catalog tree, click DLF Catalog to open the DLF Catalog data management page.

    Create a DLF Catalog data catalog

    On the DLF Catalog data management page, you can add an existing DLF Catalog to the data catalog list as a dataset.

    1. Click the image icon to the right of DLF Catalog to open the Add DLF Catalog page.

    2. On the appropriate tab, add the DLF Catalog for the required version to the data catalog list.

      DLF version

      Attachment instructions

      DLF 1.0

      On the DLF 1.0 tab, click Create DLF Catalog. In the Data Lake Formation 1.0 console, create a DLF Catalog data catalog. After the catalog is created, add it to the DLF Catalog data catalog list.

      • Attach a single catalog: On the DLF 1.0 tab, find the DLF Catalog that you want to add in the list, and click Add in the Actions column.

      • Attach multiple catalogs in a batch: On the DLF 1.0 tab, select multiple DLF Catalogs in the list and click Batch Add below the list.

      DLF 2.0

      Creating DLF Catalogs is not supported.

      (Recommended) DLF 2.5 And Later

      On the DLF 2.5 And Later tab, click Create DLF Catalog. In the Data Lake Formation 2.5 console, create a DLF Catalog data catalog. After the catalog is created, add it to the DLF Catalog data catalog list.

      • Attach a single catalog: On the DLF 2.5 tab, find the DLF Catalog that you want to add in the list, and click Add in the Actions column.

      • Attach multiple catalogs in a batch: On the DLF 2.5 tab, select multiple DLF Catalogs in the list and click Batch Add below the list.

    Manage a DLF Catalog data catalog

    You can add and manage databases and tables in the DLF Catalog.

    Manage databases

    Create a database

    1. Find the target DLF Catalog and click the image icon to its right.

    2. On the Create Database page, enter a Database Name.

    3. Click Save in the top toolbar.

    Manage a database

    1. View a database: After a database is added, click the image icon to the left of the DLF Catalog to view the database.

    2. Delete a database: If you no longer need a database, right-click it and select Delete.

      Important

      • This operation cannot be undone. Proceed with caution.

      • Before you can delete a database, you must delete all tables in it.

    Manage tables

    Create a table

    1. Click the image icon to the right of the target database to open the New Table page.

    2. You can generate basic table and field information in one of the following ways.

      • Create a table with Copilot:

        1. In the top toolbar, click Create Table With Copilot to open the Copilot Chat interface.

        2. Enter an instruction to create a table. For example: Create a user table.

        3. Click Generate And Replace. The system generates a default table name and field information based on your instruction.

        4. If the table name and fields meet your requirements, click Accept.

          Note

          To modify the table information, you can manually edit the system-generated details after you click Accept.

      • Create a table manually:

        Configure the parameters to create the table.

        Parameter

        Description

        Basic Information

        Specify a custom Table Name, Table Description, and other information.

        Field Information

        Edit field and field annotation information.

        • Edit manually: Click Insert above the field information list. Specify the number of rows to insert, and then edit the field, field type, and other information.

        • Edit with Copilot: Click Generate Fields or Generate Field Descriptions above the field information list. The system generates relevant fields and descriptions based on the table name and description you set.

    3. (Optional) Configure partition information.

      To create a partitioned table, in the Partition Fields section, set the number of Rows to add and click Insert. Multiple partition fields are supported. In the partition field list, specify the Field Name, Field Type, and other required information for each field.

    4. (Optional) Configure advanced settings.

      DLF version

      Parameter

      Description

      DLF 2.5 and later

      DLF 2.0

      Custom Properties

      You can configure custom property parameters to set the table storage location, storage format, and other information. For more information about the configuration, see Create a data table in Data Lake Formation.

      DLF 1.0

      Storage Location

      Click Change next to Storage Location. In the OSS Path dialog box, select a storage location for the table. Storing metadata in OSS ensures data security and reliability and simplifies unified management and maintenance.

      Data Format

      The storage format can be set to CSV, PARQUET, ORC, AVRO, JSON, or SELE_DEFINE. The system automatically defines the data input format, output format, and serialization and deserialization methods based on the selected storage format.

      • CSV: A comma-separated text file suitable for simple data structures.

      • PARQUET: A columnar storage format with a high compression ratio, suitable for big data analysis.

      • ORC: An optimized columnar storage format with excellent performance that supports complex data types.

      • AVRO: A binary format that supports schema evolution, suitable for dynamic data structures.

      • JSON: Supports nested structures and is suitable for semi-structured data.

      • SELE_DEFINE: Lets you customize serialization and deserialization logic.

    5. When you are finished with the configuration, click Publish in the top toolbar to create the table.

    Manage a table

    1. View a table: After you create a table, click the image icon to the left of the database, and then click Tables to view basic table information. You can also click a specific table name to view its Details and Basic Information.

    2. Delete a table: Right-click the table that you want to delete and select Delete.

      Important

      This operation cannot be undone. Proceed with caution.

    View and remove a DLF Catalog data catalog

    If you no longer need a DLF Catalog, you can view its information or remove it.

    1. View the data catalog.

      1. After a DLF Catalog is added, click the image icon to the left of its entry to expand it.

      2. Hover your mouse over the DLF Catalog to view its Version, Creation Time, and other information.

    2. Detaching a project

      If you no longer need to manage a DLF Catalog, right-click it and select Remove.