Rhythm 2.0 Specifications

Appearance

WF-PFM-QRY-001Register an application's datasets at deploy

Markdown

WF-PFM-QRY-001

Register an application's datasets at deploy

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Implements
CAP-PFM-QRY-001

KindWorkflowProduct areaPlatformModuleQuestions, record exploration and data deliveryRevision1

Read atservices-platform ad3f6a65

Register an application's datasets at deploy ​

What It Does ​

An application deploy registers its dataset manifest after migrations and metadata registration, before advancing function aliases. Recipe registration follows dataset registration because recipes resolve that vocabulary.

The Flow ​

Synchronously submit the application dataset manifest, including permissions, fields, relationships, computed values and optional search projection. Validate source tables, metadata, scope and references. A supplied custom-field table without the source capability emits a warning rather than rejecting the manifest. Persist the application and dataset declarations with their related metadata; mark omitted objects retired. Database triggers advance relevant description stamps within the metadata-writing transaction. After registration commits, inspect retired fields and ask Quick Search to degrade affected configurations.

When Something Fails ​

A failed invocation stops the deploy before alias advancement. The registration invocation may need retry; no declaration write is established by an invocation failure alone. Return collected validation problems without persisting a rejected manifest. No partial declaration set is written on validation rejection. Rollback a failed registration transaction. The previous declarations remain after rollback. Stamp failure fails that transaction. Stamp changes and declaration changes commit together; later resolution reads still have their separate isolation limitation. A degradation error can fail the invocation after registration has committed. The registry can be updated while search configurations still need degradation.

Idempotency and Concurrency ​

Identical declarations do not need replacement. Metadata changes advance their stamps; a deploy retry can submit the same manifest. Post-commit search-field degradation remains separate work. The validated declaration set is persisted in one application transaction. Concurrent changes contend on the affected rows; this does not independently order deployment releases.

Controls

41 controls apply, from the corpus control catalogue.

TC-AVL-004 TC-AVL-005 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-006 TC-CHG-001 TC-CHG-002 TC-CHG-003 TC-CHG-004 TC-CHG-005 TC-CHG-006 TC-CHG-007 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-004 TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-IAM-006 TC-LOG-001 TC-LOG-004 TC-LOG-005 TC-MON-001 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-004 TC-PI-005 TC-PRV-001 TC-PRV-002 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-TEN-004 TC-VEN-001 TC-VEN-002 TC-VEN-003

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software