Preview Schema Change
preview_schema_changePreview a schema change, saving nothing: the one way to see what a change would do before it is saved.
Pass ONE of: • operations: the operations patch_schema or drop_schema_items would apply (relational projects) • schema: a whole schema in place of the saved one (relational or graph projects)
ANSWER: 'applied' (for operations), 'diff' (every property saving it would change, by path), 'summary' and 'plan' (the migration the next deploy would then run, every table, field, entity or relationship it drops named), and 'version' (the saved schema's: pass it as expected_version to the save that follows, so it is refused if someone saved meanwhile).
A relational schema the deploy would refuse is refused here, with the reason.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schema | No | A whole schema in place of the saved one (relational or graph). Pass this or operations. | |
| operations | No | A change to part of a relational schema, as patch_schema or drop_schema_items take it. Pass this or schema. | |
| project_id | Yes | Project ID (UUID) |