All Products
Search

This Product

    Data Management:Synchronize a data dictionary

    Document Center

    Data Management:Synchronize a data dictionary

    Last Updated:Apr 14, 2026

    After you add an instance to Data Management Service (DMS), DMS automatically collects the data dictionary from the databases within that instance. If you find that the instance information in DMS is out of sync, you can manually sync the data dictionary. If you perform a schema change in DMS, DMS automatically syncs the data dictionary. Otherwise, you must sync the data dictionary manually.

    Background information

    DMS collects the following information for the data dictionary:

    • Database names and character set information.

      Note

      For an instance in Security Collaboration control mode, DMS ignores system databases by default when collecting metadata. For more information, see System databases that are ignored by DMS by default.

    • Table names, occupied storage space, row count, character sets, columns, indexes, and descriptions.

    • Column data types, precision, and descriptions.

    Data dictionary update rules:

    • If you perform a schema change in DMS, DMS automatically syncs the data dictionary.

    • If you perform a schema change outside DMS, you must manually sync the data dictionary.

    For more information about data dictionaries, see Metadata.

    Prerequisites

    You must have the DBA or administrator system role. To check your role, see View my system roles.

    Procedure

    Method 1

    1. Log in to DMS 5.0.

    2. In the top navigation bar, choose Data Assets > Instances.

      Note

      If you use the DMS console in simple mode, move the pointer over the 2023-01-28_15-57-17.png icon in the upper-left corner of the console and choose All Features > Data Assets > Instances.

    3. Click the Instance List tab.

    4. In the Actions column for the target instance, click More > Refresh/Sync Dictionary.

    5. In the Sync Dictionary dialog box, click OK.

    Method 2

    1. Log in to DMS 5.0.

    2. In the instance list on the left of the homepage, right-click the target instance and select Refresh/Sync Dictionary.

    3. In the Sync Dictionary dialog box, click OK.

    FAQ

    Q: Why can't I see my new database or table in DMS after I manually sync the data dictionary?

    A: This issue is usually caused by one of the following reasons:

    1. The DMS account lacks permissions on the new database. By default, when you create a new database on an RDS SQL Server instance, permissions are not automatically granted to the account that DMS uses. Therefore, even after a sync, DMS cannot display the database if the account lacks the necessary permissions.

    1. Log on to the Alibaba Cloud console. In the navigation pane on the left, choose Instance List.

    2. In the top navigation bar, select the target region to open the Instance List page.

    3. Find the target instance and click the instance ID to open the Basic Information page.

    4. In the navigation pane on the left, choose Account Management.

    5. Find the database account that DMS uses. In the Actions column, click Modify Permissions or Reset Account Permissions to grant the account permissions on the new database.

    2. Synchronization can be slow for instances with many databases and tables. The time required is proportional to the number of objects in the instance, and the task can take several minutes or longer to complete.