Docs menu

Review, check, then create

A plan is a proposal, so read it before anything is built.

  1. Review the plan. Each key and relationship carries the rule that made it; ambiguous columns and tables without a key are listed. Correct a key with keys and add a relationship the rules did not make with confirmed.
  2. Check it against the data. validate_plan counts duplicate and NULL key values and references with no matching row. create_backend does not run it for you, so ask for it. A check that passes shows the data agrees with the plan today; it does not show that the plan means the right thing.
  3. Create the API. create_backend creates the API for GraphQL item, or updates the one with that name. It has no dry run: run plan_drift first to see what an update would change. An update keeps the field names the existing API has for the same relationships. If it would still remove relationships the API has, nothing is written and the answer lists them with the confirmed entries that keep them (both field names included); allow_removals=true drops them on purpose.
  4. Query it. describe_backend gives the field names; query_graphql runs read-only queries and refuses mutations. Two portal steps stay manual (see below).
  5. Keep the review. review_plan writes the plan, your decisions with their reasons and the check results as one file for your own repository. Pass it back later as previous: the corrections apply again and what changed since is listed (see Keep your review).