Model publication and version history

Updated at:

This feature lets you publish multiple model versions. For each version, the system records the publication time, author, the number of entity and relationship types, and the version description. The version list provides an intuitive overview of the scale and change notes for each version, making the model iteration process clear, orderly, and traceable.

Permissions

  • Space administrators and modelers can create and manage entity types and relationship types, and publish models.

  • Space administrators, modelers, business experts, and analysts can view model details and the model version list.

Limitations

This feature only supports the full publication of a graph space. You cannot yet publish incremental changes or individual entity and relationship types.

Model publication

During publication, the system automatically synchronizes the model to the graph engine configured for the Knowledge Graph and updates the associated knowledge. The three-layer change architecture is detailed below.

Layer

Description

Storage location

Example changes

1

ontology model

The model definition at the product level, including entity types, relationship types, property definitions, and constraint rules.

product metadata database

Add an entity type, modify a property name or type, or delete a relationship type.

2

graph schema

The schema structure at the graph engine level, such as labels, property keys, and indexes.

Graph database

Create a label, add a property key, or create or delete an index.

3

graph data

The actual node and edge data stored in the database.

Graph database

Convert node property values, backfill default values, or delete nodes or edges.

Publishing a model automatically generates a new version. Version statuses include Draft, Publishing, Succeeded, Partially Succeeded, and Failed. The following table describes the scenarios and resolutions for the Partially Succeeded and Failed statuses.

System status

Failure scenario

Resolution

Failed

ontology model update fails

The system performs an automatic rollback. After fixing the issue, republish the model.

graph schema synchronization fails

The system automatically rolls back the ontology model. Check the graph engine status, and then republish the model.

Partially Succeeded

Some graph data adjustments fail.

You can choose one of the following options:

  • Retry Failed Items: Reruns only the failed graph data adjustment tasks. This option is suitable for transient errors, such as a graph engine timeout or a network error.

  • Skip failed items: Ignores the failed graph data adjustments and marks the version as Succeeded. Use this option when you can temporarily accept data inconsistency and plan to resolve it manually.

  • Roll back version: Rolls back the ontology model and graph schema to the previous version. Use this option when data inconsistency is unacceptable and a full rollback is necessary.

    Note

    A rollback cannot restore deleted property values; you must reconfigure them.

All graph data adjustments fail.

Procedure

  1. In the top navigation bar of the Dataphin homepage, choose Knowledge Graph > Model Design.

  2. Select a space from the top menu bar. The canvas displays the last published version of the model for that space. You can then edit this model. For more information about modifications and their impacts, see Entity types and relationship types.

  3. After making your changes, click Publish to publish the current model to the production environment. The publication process is as follows.

    Parameter

    Description

    ① Change overview

    • Change summary: Displays all breaking changes, compatible changes, and non-breaking changes.

      Note

      If this publication includes major breaking changes, back up your data beforehand to ensure a quick recovery if an error occurs.

    • Version number: The system automatically increments this number. You cannot modify this field.

    • Version description: A brief description of the version, up to 128 characters.

    ② Publication check

    The draft model can be published to the production environment only after passing this check.

    schema compatibility check: Compares the model with the previous production version to identify any breaking changes.

  4. Click Publish to publish the current version of the model.

    If the publication check detects breaking changes, you must select the I understand the data risks and confirm to publish checkbox and then click Confirm Publish.

Model version history

  1. Click Versions in the upper-right corner of the canvas. The Versions panel displays all published versions of the current model.

  2. The version list shows the publication time, author, the number of entity and relationship types, and the version description for each version.