Docs menu

Keep your review

A review is worth keeping when the next report or app builds on the same tables. review_plan returns one JSON file (krusgraph-review.<source>.<schema>.json) and a short Markdown report; it creates nothing in Fabric.

  • What it holds: the format and its version, a plan id, the source (workspace, item and schema names), a fingerprint of the tables' columns and types, the plan snapshot (the same one the drift monitor keeps), every key and relationship as an item (key:orders, rel:orders.customer_id>customers) with its rule and what the rules alone proposed when you corrected it, open questions (ambiguous columns, tables without a key, items you left open), and the keys and confirmed arguments that carry your corrections into the other tools. Names, types, rules, decisions and counts only: no row values, samples, connection strings or tokens.
  • Two statuses per item. Review is what a person decided: proposed, accepted, rejected or open, with a reason (decisions). Check is what the counting queries found: not checked, passed, failed or stale, with the counts and the time. They are kept apart: an accepted relationship can fail its check, and a passing check does not show that a relationship means the right thing.
  • Reading it back. With previous, the decisions apply again, the schema is compared with the file's (tables, columns, types, keys and relationships added or removed), decisions that no longer match the plan are listed, and a check on a table whose columns changed becomes stale: an old pass is not carried forward as new evidence. validate=true runs the checks again.
  • Limits. A relationship you reject stays rejected in the file, but the other tools still infer it from the names; leave it out of what you build. A large schema may not fit one answer; tables limits the file to an area. The file is unit-tested and not yet run against a live workspace (Experimental).