DomainApplyBody
Defined in: js-api/src/domains.ts:655
What DomainSchemaClient.apply takes: a partial manifest — named tables replace their registered definition WHOLESALE, everything omitted stays as registered — with the two tokens the edit was made against, the schema-level metadata, and the access deltas.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
access? | DomainAccessDelta | Access changes executed with the manifest change, atomically. | js-api/src/domains.ts:684 |
confirmDestructive? | boolean | Required when the plan is destructive ('destructive-confirmation-required' otherwise, the plan riding in the error's body). | js-api/src/domains.ts:687 |
description? | string | The schema's description (user-managed schemas). | js-api/src/domains.ts:678 |
dropTables? | string[] | Tables to unregister (a destructive plan: needs confirmDestructive, and Delete on each). | js-api/src/domains.ts:669 |
extend? | object | Package-managed schemas only: your own columns on plugin tables that opted in, as the full state of YOUR columns of each table. | js-api/src/domains.ts:672 |
friendlyName? | string | The schema's caption (user-managed schemas). | js-api/src/domains.ts:676 |
ifIncarnation? | string | The incarnation the edit was made against (DomainRegisteredManifest.incarnation): a token from another life of the name (deleted and re-created since) rejects with a DomainVersionConflictError carrying both incarnations. Optional on the wire; send it. | js-api/src/domains.ts:665 |
ifVersion? | string | The apply counter the edit was made against (DomainRegisteredManifest.version): REQUIRED on a user-managed schema ('version-required' without it), checked under the deploy lock — of two concurrent applies exactly one commits, the other rejects with a DomainVersionConflictError. On a package-managed schema (the extension path) it is optional and tracks ext_version. | js-api/src/domains.ts:661 |
propertySchemas? | object | Property schemas to merge by name. | js-api/src/domains.ts:674 |
storage? | object | writable is the one storage key an apply may change, and only on an external binding; any other key must repeat the registered value ('storage-immutable'; the kind cannot flip, 'storage-conversion'). | js-api/src/domains.ts:682 |
storage.writable? | boolean | - | js-api/src/domains.ts:682 |
tables? | object | Tables to create or replace, whole descriptors by logical name. | js-api/src/domains.ts:667 |