Rhythm 2.0 Specifications

Appearance

DOM-PFM-QRY-001Dataset

Markdown

DOM-PFM-QRY-001

Dataset

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Specified by
CON-PFM-QRY-001

Design

Owned by
SVC-PFM-QRY-queries

KindDomain objectProduct areaPlatformModuleQuestions, record exploration and data deliveryRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

Dataset ​

What It Models ​

A dataset is the vocabulary through which applications make records queryable. It combines the owner’s record shape with the workspace’s configuration and the current person’s permitted operations.

Identity and Attributes ​

Registered datasets, workspace custom objects and staff-authored custom tables share the query interface. Their declarations remain distinguishable so retirement, publication and access failures can be explained.

Relationships ​

Queries and derived consumers retain references to datasets. Business-record ownership remains with the application that supplies the source.

Invariants ​

The invariant rows locate registration, execution, custom-table history and access protections at their enforcement boundaries.

How It Is Stored and Shared ​

Application declarations and custom-table definitions are durable; resolved descriptions are cached projections. The query service owns resolution and SQL compilation.

Open Design Questions ​

The production validation-workspace limitation and the description-read consistency gap remain recorded findings.

Relationships

ToCardinalityOwnershipCrosses a serviceOn archive or delete
DOM-PFM-QRY-002one-to-manyQueries retain their base and joined dataset references; datasets do not maintain a reverse query collection.no
DOM-PFM-QRY-005one-to-zero-or-oneQuick Search owns the optional record-type index and obtains its projection vocabulary from the dataset.yes
DOM-PFM-QRY-004one-to-manyQuery files retain their source dataset; workspace export declarations use a separate coverage registry.no

Invariants

InvariantProtectsEnforced atProvenance
INV-DOM-PFM-QRY-001-01
Dataset description, validation and execution check surface access and the dataset grant, including any declared record-read or application requirement.
api, serviceobserved
services-platform:modules/queries/services/describe/resolve-query-model.ts:resolveQueryModel; modules/queries/services/describe/dataset-grants.ts
INV-DOM-PFM-QRY-001-02
Compilation restricts base records to the execution workspace and relates joined or picked records within that workspace, alongside database row security.
service, databasedocumented
services-platform:docs/compliance/control-coverage.md#Component: queries (TC-TEN-001)
INV-DOM-PFM-QRY-001-03
The registration service checks the manifest against metadata and the database catalog before persisting its declarations.
serviceobserved
services-platform:modules/queries/services/registration/register-query-application.ts:registerQueryApplication
INV-DOM-PFM-QRY-001-04
Registration retains omitted datasets with a retirement marker instead of deleting them.
serviceobserved
services-platform:modules/queries/services/persistence/registered-query-objects.ts:retireRegisteredQueryObjectsExcept
INV-DOM-PFM-QRY-001-05
Description caches use the stamps read at resolution start. Trigger updates commit with metadata writes, but the stamp and metadata reads do not share a guaranteed database snapshot.
database, serviceobserved
services-platform:modules/queries/services/describe/resolve-query-model.ts:withCachedReads; modules/queries/services/persistence/query-description-stamps.ts:readQueryDescriptionStamps
INV-DOM-PFM-QRY-001-06
Custom fields appear in a dataset description only when the source object registration enables that capability.
servicedocumented
services-platform:docs/standards/custom-field-capability.md#3.3 What Platform enforces
INV-DOM-PFM-QRY-001-07
A reserved custom-table name cannot identify a different definition later.
service, databaseobserved
services-platform:modules/queries/db/custom-query-tables.table.ts
INV-DOM-PFM-QRY-001-08
Only one draft may exist for a custom table; published versions allow supersession but reject content changes and deletion.
databaseobserved
services-platform:db/migrations/0065_custom_query_tables.sql:custom_query_table_versions_immutable
INV-DOM-PFM-QRY-001-09
Execution verifies the published canonical SQL fingerprint and refuses a mismatch without returning the SQL.
serviceobserved
services-platform:modules/queries/db/custom-query-table-versions.table.ts (sql_hash); modules/queries/services/describe/resolve-query-model.ts
INV-DOM-PFM-QRY-001-10
Custom-table discovery requires an applicable inclusion without a workspace exclusion; other callers receive not found.
serviceobserved
services-platform:modules/queries/db/custom-query-table-assignments.table.ts; modules/queries/services/custom-tables/assignment-visibility.ts
INV-DOM-PFM-QRY-001-11
Custom-table changes commit their history event with the change, without SQL or record values in the event.
serviceobserved
services-platform:modules/queries/services/custom-tables/custom-table-library.ts
INV-DOM-PFM-QRY-001-12
Only system datasets are available through staff system-query operations; workspace datasets appear missing there.
api, servicetest
services-platform:modules/queries/tests/e2e/system-queries.e2e.spec.js#refuses a tenant dataset as one that does not exist, with 404 and never 403

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