Refresh Synonyms

The Refresh Synonyms option updates the metadata tables to reflect the latest metadata changes, ensuring that associated synonyms are current.

The Refresh Synonyms option is used to refresh the metadata tables to reflect any changes in the metadata. This ensures that the synonyms associated with a Metadata Store are up to date with the latest changes.

When the refresh is triggered, the system will update the synonyms, ensuring the metadata tables are accurate and synchronized.

Best Situations to Use

Use the Refresh Synonyms option when you want to:

  • Update synonyms for a metadata store after changes to the underlying data.

  • Ensure that all synonyms reflect the most current structure and naming conventions.

  • Clear outdated synonyms and refresh them to avoid inconsistencies in data queries.

Not Recommended for:

  • Scenarios where no changes have been made to the metadata (use this function only when updates are required).

  • Bulk synonym management where multiple synonyms need to be added at once (use Add Synonyms instead).

Steps to Refresh Synonyms

  1. Navigate to the Data Store Metadata list.

  2. Select a Metadata Store from the list of available stores.

  3. Click the Refresh Synonyms option next to the selected Metadata Store.

  4. A confirmation message will appear, informing you that the synonyms have been updated successfully.

Example Use Case

  • Scenario: A new field is added to a metadata table, and you need to update the synonyms to reflect this new field.

  • Action: Refresh the synonyms to ensure that the new field is included, and then add any necessary synonyms for it.

Notes:

  • Use the Refresh Synonyms feature cautiously, as it removes existing synonyms. Make sure to add synonyms back after refreshing to maintain full data accessibility.

  • For large updates, consider reviewing the changes in the metadata before performing the refresh to avoid potential errors.

  • Synonym Removal: When you refresh synonyms, all previously added synonyms will be cleared.

  • Re-adding Synonyms: After refreshing, you will need to use the Add Synonyms option to insert new synonyms in the same Metadata Store.

Last updated