Glossary¶
One term per concept. The pages of this site use these words in these senses.
As-of date¶
Which release of a vendor source the data reflects. A file the vendor released for the quarter ending 30 September
2026 has the as-of date 2026-09-30, whenever you downloaded it. Declared per source in
dates_asof. Not the same as a fact's as_of, which is the date the statement was
written or decided. See also build.
Build¶
One run that produced the data. Each build has an id and a timestamp, so the rows of two builds can be compared. Builds are recorded by tooling, not in the file. A vendor can re-send a file under the same as-of date: the as-of date stays the same and the build changes. See As-of date versus build.
Card¶
The short text a tool shows an agent about one dataset: purpose, grain, as-of dates, coverage, hazards, facts, joins and columns. The card is how the file reaches the agent. See What an agent sees.
Checker¶
A tool that reads the file and reports mistakes: an unknown key, a value of the wrong type, a unit that is not a unit, a declared column that is not in the data. It reports errors and warnings with line numbers. It never stops anyone from working.
Citation¶
A stable id that a number in an answer or a report can point to, so a reader can find the fact or the data it relied
on. A fact's citation id looks like marketdata-example/Rents/fact:office-incl-flex. The full citation form is not
in the spec yet.
Dataset¶
One table that others read, declared under datasets in the file and named there (Rents, Markets). The spec uses
"dataset" for this everywhere. See Datasets.
Fact¶
A dated statement a reader must know to use the data correctly, such as "office includes flex space from 2026Q2".
It has a date (as_of), a severity, a status and an optional id. A fact is about the data; it is not a result drawn
from the data. See Facts.
Grain¶
The columns that identify one row. Rents has the grain [market_id, sector, period_yq]: one row per market, sector
and quarter. The grain also tells an agent which joins are safe. See Datasets.
Hazard¶
A thing not to do with a dataset, declared in do_not ("do not join on market names"). Shown under Hazards on the
card.
Hint¶
Advice from a checker, such as "declare a grain". A hint is a kind of warning: reported, never blocking.
ODCS, ODPS, Ossie¶
Three other open formats. ODCS (Open Data Contract Standard) describes a data contract. ODPS (Open Data Product Specification) describes a data product, including pricing plans. Apache Ossie describes semantic models, including relationships between tables. The spec borrows field names from ODPS (pricing) and Ossie (relationships) and maps one price to ODCS. See Related standards and Mappings.
Probe¶
A small committed script that re-tests a fact against the data on each build and passes or fails. A fact with a passing probe cannot silently stop being true. See Facts.
Project¶
The folder that holds the data (or the code that builds it) and the oryxkb/ folder that describes it. For a vendor,
one project is usually one data product. See Project.
Source¶
A vendor feed or file that a dataset reflects, named in project.sources (for example vendor_a) and given an as-of
date in dates_asof.
The file¶
oryxkb/project.yaml at the project root. It holds everything by default and can be split into more files in the same
folder. See File layout.
UCUM¶
The Unified Code for Units of Measure: a standard code system for units, such as m2 (square metres) or [sft_i]
(square feet). The spec uses it for unit, plus a few short aliases (decimal, pct, bp). See
Units (UCUM) for how codes are built and where the full list of units is, and
Common units.
Warning and error¶
What a checker reports. An error is a mistake in the file; a strict run (for CI) fails on it. A warning is reported and never blocks. See Errors and warnings.