Skip to content

QUA-1806: Clean up Enrichment Datastore FAQ and remove internal flag#1123

Merged
RafaelOsiro merged 2 commits into
mainfrom
qua-1806-enrichment-datastore-faq-fix
May 19, 2026
Merged

QUA-1806: Clean up Enrichment Datastore FAQ and remove internal flag#1123
RafaelOsiro merged 2 commits into
mainfrom
qua-1806-enrichment-datastore-faq-fix

Conversation

@RafaelOsiro
Copy link
Copy Markdown
Contributor

@RafaelOsiro RafaelOsiro commented May 19, 2026

Overview

Refines the Datastore Enrichment FAQ. Engineering flagged an internal flag exposed in the "Which connectors support enrichment?" answer; this PR removes that detail and aligns the rest of the page with our writing standards (no em-dashes, plain-language wording, consistent bold for UI values).

Key Changes

  • Remove internal flag: rewrote the "Which connectors support enrichment?" answer to drop the internal flag and the "write-back capabilities" jargon, pointing readers to the Supported Enrichment Datastores list instead.
  • Em-dash cleanup: replaced em-dashes with periods, commas, semicolons, or colons across the linking, settings, unlinking, storage, operations, troubleshooting, and API sections.
  • Wording polish: tightened the "Maximum Source Examples per Anomaly" entry, reworded the Scan flow bullet to mention records written to dedicated enrichment tables, and standardized None as None in remediation references.
  • Alignment fixes: aligned the troubleshooting prefix-conflict bullet with the existing prefix-uniqueness wording, and added a note in the post-unlink cleanup answer about per-container tables that remain under Append/Overwrite remediation.

Pages to Test

Replace the sensitive `enrichment_only=true` reference and "write-back
capabilities" jargon in the "Which connectors support enrichment?" answer
with user-facing wording that points readers to the Supported Enrichment
Datastores list. Remove em-dashes across linking, settings, unlinking,
storage, operations, troubleshooting, and API sections; standardize
`None` as bold None; tighten the Maximum Source Examples entry; reword
the Scan flow bullet to mention records written to dedicated enrichment
tables; align the prefix-conflict troubleshooting bullet with the
existing prefix-uniqueness wording; and note per-container tables that
remain after unlink under Append/Overwrite remediation.
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label May 19, 2026
@RafaelOsiro RafaelOsiro self-assigned this May 19, 2026
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 19, 2026

Greptile Summary

This PR cleans up the Enrichment Datastore FAQ page: it removes an exposed internal implementation flag (enrichment_only=true and "write-back capabilities" jargon) from the connector-support answer, replaces all em-dashes with standard punctuation throughout, and standardises bold formatting for UI values such as None.

  • The "Which connectors support enrichment?" answer now describes support in plain terms ("Many JDBC connectors and all cloud object storage (DFS) connectors") and defers to the Supported Enrichment Datastores reference page.
  • The post-unlink cleanup answer gains a new sentence noting that Append/Overwrite remediation leaves behind per-container tables; and the Scan flow step 4 is reworded from "source tables are replicated" to "records are written to dedicated enrichment tables" for accuracy.
  • The range 1 to 1,000,000,000 is dropped from the Maximum Source Examples entry, and a new undefined term ("anomalous source container") appears in the cleanup section.

Confidence Score: 4/5

Documentation-only change that removes an internal implementation detail and standardises formatting; safe to merge with minor wording observations.

The change is purely editorial — no code, no schema, no API contract is altered. The removal of the valid input range for "Maximum Source Examples per Anomaly" and the introduction of the undefined term "anomalous source container" are small wording gaps that could leave users without enough context, but neither causes incorrect information to be published.

docs/source-datastore/enrichment-datastore/faq.md — the two small wording gaps noted in comments (undefined "container" term and removed range) are worth a quick second read.

Important Files Changed

Filename Overview
docs/source-datastore/enrichment-datastore/faq.md Documentation-only cleanup: removes internal enrichment_only=true flag, replaces all em-dashes with appropriate punctuation, standardises bold for UI values, and adds a note about per-container tables left behind after Append/Overwrite remediation. One new sentence introduces the term "anomalous source container" without a definition anchor.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Source Datastore] -->|Link| B[Enrichment Datastore]
    A -->|Scan| C{Remediation Strategy}
    C -->|None| D[Anomaly metadata only stored in Qualytics]
    C -->|Append| E[Source records appended to dedicated enrichment tables]
    C -->|Overwrite| F[Enrichment tables replaced with latest anomalous records]
    E --> G[Per-container tables remain after unlinking]
    F --> G
    A -->|Unlink| H[Connection severed, data preserved in enrichment datastore]
    H --> I[Manual cleanup required via database tools]
Loading

Reviews (1): Last reviewed commit: "docs(enrichment-faq): remove internal fl..." | Re-trigger Greptile

### How do I clean up enrichment tables after unlinking?

Qualytics does not automatically delete enrichment tables when you unlink. If you want to remove the historical data, you must **manually drop** the enrichment tables (e.g., `_prefix_check_metrics`, `_prefix_failed_checks`, `_prefix_source_records`, `_prefix_scan_operations`) directly in the enrichment datastore using your database tools.
Qualytics does not automatically delete enrichment tables when you unlink. If you want to remove the historical data, you must **manually drop** the enrichment tables (e.g., `_prefix_check_metrics`, `_prefix_failed_checks`, `_prefix_source_records`, `_prefix_scan_operations`) directly in the enrichment datastore using your database tools. If you used Append or Overwrite remediation, Qualytics also creates one table per anomalous source container; those tables remain as well.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Undefined term "anomalous source container"

The new sentence introduces "one table per anomalous source container" without defining what "container" means in this context. Elsewhere in the doc the vocabulary is "tables", "schema", or "source datastore". A user who hasn't read the enrichment overview may not know whether "container" means a database table, a schema, a file path, or something else. Consider replacing it with the same terminology used in the rest of the page (e.g., "one table per source table that contained anomalous records") or linking to the glossary entry for "container".

### What is the "Maximum Source Examples per Anomaly"?

It controls how many actual source data rows are written to the enrichment datastore when a quality check fails. Default is 10. Range: 1 to 1,000,000,000. For practical recommendations on which values to use, see the [Source Examples: Practical Recommendations](introduction.md#source-examples-practical-recommendations){:target="_blank"} section.
It controls how many actual source data rows are written to the enrichment datastore when a quality check fails. Default is 10. For recommended values, see the [Source Examples: Practical Recommendations](introduction.md#source-examples-practical-recommendations){:target="_blank"} section.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Range information removed without replacement

The previous answer included "Range: 1 to 1,000,000,000" for Maximum Source Examples per Anomaly, which was actionable input-validation guidance. The new text only says "Default is 10" and redirects to a recommendations section. If the recommendations page does not restate the valid range, users who need to set a specific large value have no way to confirm the upper bound without consulting the product UI or API docs directly.

…r to glossary

Address Greptile review on PR #1123: put the valid 1 to 1,000,000,000
range back on the Maximum Source Examples per Anomaly answer (the
recommendations table covers values but not the explicit bounds), and
link "container" in the post-unlink cleanup note to the glossary entry
instead of redefining it inline.
@RafaelOsiro RafaelOsiro merged commit 27f6ca3 into main May 19, 2026
1 check passed
@RafaelOsiro RafaelOsiro deleted the qua-1806-enrichment-datastore-faq-fix branch May 19, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants