Review, check, then create
A plan is a proposal, so read it before anything is built.
- 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
keysand add a relationship the rules did not make withconfirmed. - Check it against the data.
validate_plancounts duplicate and NULL key values and references with no matching row.create_backenddoes 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. - Create the API.
create_backendcreates the API for GraphQL item, or updates the one with that name. It has no dry run: runplan_driftfirst 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 theconfirmedentries that keep them (both field names included);allow_removals=truedrops them on purpose. - Query it.
describe_backendgives the field names;query_graphqlruns read-only queries and refuses mutations. Two portal steps stay manual (see below). - Keep the review.
review_planwrites the plan, your decisions with their reasons and the check results as one file for your own repository. Pass it back later asprevious: the corrections apply again and what changed since is listed (see Keep your review).