DomainApplyPlan
Defined in: js-api/src/domains.ts:788
The change plan of DomainSchemaClient.apply: what a dry run answers, and what a commit
answers with applied: true (and the access effects as resolved under the lock). On an
external binding the plan is registrationOnly — registry rows move, the warehouse is never
touched, no live counts.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
access? | DomainAccessEffects | The access effects, present when the body carried access. | js-api/src/domains.ts:829 |
alters | object | Table-level toggles (audit, name column, relations, permissions), per kind. | js-api/src/domains.ts:809 |
applied? | boolean | Set on the answer of a commit; absent on a dry run. false with noop: the apply changed nothing, so nothing was written. | js-api/src/domains.ts:832 |
autoNumberChanges | object | Per table, the columns whose autonumbering changes. | js-api/src/domains.ts:807 |
businessKeyChanges | object[] | Tables whose business key changes. | js-api/src/domains.ts:805 |
constraintDrops | unknown | Declared constraints dropped. | js-api/src/domains.ts:811 |
creates | object | What the apply creates: tables by name, and per table its new columns, uniques and constraints. | js-api/src/domains.ts:794 |
creates.columns | object | - | js-api/src/domains.ts:794 |
creates.constraints | object | - | js-api/src/domains.ts:795 |
creates.tables | string[] | - | js-api/src/domains.ts:794 |
creates.uniques | object | - | js-api/src/domains.ts:794 |
destructive | boolean | Whether the plan drops data, constraints or registrations — confirmDestructive needed. | js-api/src/domains.ts:792 |
drops | object | What the apply drops; liveRows / nonNullValues on a platform-stored schema only. | js-api/src/domains.ts:797 |
drops.columns | object[] | - | js-api/src/domains.ts:797 |
drops.tables | object[] | - | js-api/src/domains.ts:797 |
extVersion? | number | Package-managed schema: the extension version the apply moved to. | js-api/src/domains.ts:837 |
keyColumnsUnrestricted | DomainColumnTarget[] | Restricted columns of an external target that are now key columns — visible to everyone again, since the row id encodes them. | js-api/src/domains.ts:818 |
lost? | DomainApplyLost | User-managed schema: what the drops purge or break. | js-api/src/domains.ts:824 |
metadata? | object | User-managed schema: the schema-level metadata that changes, {from, to} per key (friendlyName, description), so a rename-only plan is not empty. | js-api/src/domains.ts:827 |
migration | { changes: unknown[]; down: string; from: string; to: string; up: string; } | null | The registered-snapshot transition with its migration scaffold; null when none applies. | js-api/src/domains.ts:820 |
noop? | true | Set on the answer of a commit that found nothing to change — the schema already holds what the body declares: nothing is written and version stays the one the apply was made against. | js-api/src/domains.ts:835 |
refusals | DomainManifestIssue[] | Manifest issues that refuse the plan (empty on an answered plan — a refusal rejects). | js-api/src/domains.ts:815 |
registrationOnly? | true | External binding: registry rows only, no warehouse DDL and no row counts. | js-api/src/domains.ts:822 |
requiredToggles | object[] | Columns turned required or optional, with the rows a NOT NULL would refuse. | js-api/src/domains.ts:803 |
typeChanges | object[] | Columns whose type changes. | js-api/src/domains.ts:799 |
uniqueDrops | object[] | Unique constraints dropped. | js-api/src/domains.ts:801 |
version | string | The manifest version the apply registers. | js-api/src/domains.ts:790 |
violations | unknown[] | Data pre-checks a destructive change would violate. | js-api/src/domains.ts:813 |