Explain what a schema will generate
explain_schemaValidate a schema before generation to catch conflicts early; see planned row counts, memory estimates, column overlaps, and invariants.
Instructions
Show what generate_from_schema would do with a schema, without generating.
Call it before generate_from_schema on a schema you designed: it is
cheap, and it catches the mistakes that would otherwise surface after a
long run. Returns each table's planned row count and approximate memory,
the declarations and the columns each one writes, any column two
declarations both write, every outcome curve's period plan and warnings,
and the invariants attest_dataset will check on the output. When
will_generate is false, conflicts names each contradiction with
the arithmetic and a remedy; fix those in the schema and call again.
Args: schema: The schema dict you would pass to generate_from_schema. seed: The seed you would generate with. max_invariants: How many invariants to include in the response.
Returns:
{"ok", "will_generate", "total_rows", "estimated_bytes", "tables", "relationships", "declarations", "writers", "overlaps", "conflicts", "conformance", "invariants", "invariants_total"}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | ||
| schema | Yes | ||
| max_invariants | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |