All Products
Search
Document Center

Dataphin:Full export publish package

Last Updated:Jan 26, 2025

The full export publish package is designed for scenarios requiring rapid and complete replication of objects from the source environment to the target environment. This topic outlines the steps to fully export the publish package file in the source environment.

Prerequisites

  • In the cross-tenant publishing settings, configure the publishing credentials, define the storage location for the deployment package, ensure permission verification, and set up the approval process. For more information, see cross-tenant publishing settings.

  • The source environment is now in maintenance mode for cross-tenant publishing. For detailed instructions, see maintain/upgrade Dataphin.

Permission description

Supports full export of publish package files by cross-tenant publishing users.

Procedure

  1. Log on to Dataphin using the cross-tenant publishing user account.

  2. On the Dataphin home page, single click the top menu bar Management Center.

  3. Navigate to the New Publish Package page by following the operation guide below.

    image.png

  4. On the New Publish Package page, set the necessary parameters.

    Parameter

    Description

    Basic information

    Publish Package Name

    • The system generates the publish package name by default, which can be modified to suit business needs. The file format is TenantName_GenerationTime.dp.

    • During cross-tenant publishing, the target environment only accepts publish package files in .dp format.

    • The publish package name must not start with a period or a space.

    • The publish package name must not include the following characters: ?\ *''<>|/:.

    • The name should not exceed 255 characters, with Chinese characters counting as two each.

    Publish Package Description

    Provide a description for the publish package, limited to 64 characters.

    Export information

    Export Object Settings

    • Select Export Method: Choose Full Export.

    • For Create Table Statement, you can opt to Export or Do Not Export. Exporting the statement requires querying the metadata of the engine, which may take time depending on the engine's performance. Patience is advised.

    Compute Source Export Settings

    • For Connection, the default is Retain. Alternatively, you can select Purge.

    • For Credential, the default is Purge. Alternatively, you can select Retain.

      Warning

      If authentication information is retained, ensure the publish package file is stored securely and not shared indiscriminately.

    Data Source Export Settings

    • For Connection, the default is Retain. Alternatively, you can select Purge.

    • For Credential, the default is Purge. Alternatively, you can select Retain.

      Warning

      If authentication information is retained, ensure the publish package file is stored securely and not shared indiscriminately.

    Standard Export Settings

    Enable the data standard feature to filter the mapping relationships exported from the source environment.

    • Select Only Export Manually Added Mapping Relationships based on the details of the mapping relationships. This includes relationships added manually, imported in batches via Excel, or associated with the development process.

    • Choose All Mapping Relationships to fully export the mapping relationships of the source environment.

    Security Export Settings

    Enable the data security feature to filter the key values and security detection results exported from the source environment.

    • For Key Values, choose to export or not.

      • Select Export to transfer key values from the source environment, allowing direct use after import into the target environment.

      • Opt for Do Not Export to transfer only the name and type of the key, requiring regeneration or completion of the key value after import into the target environment.

        Note

        Key values are sensitive data and are transmitted in ciphertext during export, with decryption occurring after import.

    • For Security Detection Results, choose to export either only manually specified results or all detection results.

      • Select Only Export Manually Specified Results to transfer detection results specified manually in the production environment, including those uploaded in batches via Excel and manually added.

      • Opt for All Detection Results to fully transfer the detection results of the production environment in the source environment.

    Transfer Settings

    When Cross-tenant Publishing Settings Enable OSS Storage is activated, the transfer settings configuration appears on the Export File page. The exported publish file will be automatically stored in the designated OSS location.

    • Select Automatically Transfer To External Storage After Completion to store the publish file in the specified OSS location upon successful export. This option is unchecked by default.

    • For Handling Of Files With The Same Name, choose between renaming, ignoring, or overwriting.

      • Select Rename to automatically rename the publish file. If a file with the same name exists, "Copy N" is appended to the file name, incrementing N if necessary.

      • Choose Ignore to skip the current transfer operation.

      • Opt for Overwrite to replace the existing file with the new one.

  5. Single click Export Publish Package to finalize the full export publish package settings.

    • Single click Save Publish Package to create a draft record on the publish package list page, which you can later edit.

    • Single click Save And Preview to generate a draft record on the publish package list page and automatically proceed to the export content preview page. Here, you can review the export configuration and details of the publish package. To return to the publish package edit page, single click the Return To Edit button at the bottom or the Edit button next to Basic Information/Export Information.

    • The duration of the export process depends on the volume of data being exported and may range from a few minutes to several hours.