Entity YAML Referenz
Feld-Level-Spezifikation fuer Entity YAML-Definitionen (entities/*.yaml).
Dateikonvention
Abschnitt betitelt „Dateikonvention“- Ort:
entities/*.yaml entity_idmuss mit dem Dateinamen uebereinstimmen- Spalten werden gegen
contracts/gold_contract.v1.jsonvalidiert - Validator:
python3 scripts/entitycheck.py - Compiler:
python3 scripts/entitycompile.py
Top-Level-Felder
Abschnitt betitelt „Top-Level-Felder“| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
entity_id | string | Ja | Muss mit Dateiname uebereinstimmen |
dbt_model | string | Ja | Ziel-dbt-Modellname. Muss mit gold_ beginnen |
display_name | i18n mapping | Ja | Menschenlesbarer Name (en/de/fr erforderlich) |
icon | string | Nein | Einzelnes Zeichen fuer UI-Anzeige |
is_browseable | boolean | Nein | Ob Entity in JinDesk Browse-Ansichten erscheint |
probe_entity_type | string | Nein | Gold Contract Entity-Typname |
kind | string | Nein | core | analytical | view |
taxonomy | mapping | Nein | dimension_type, caption_column |
columns | mapping | Ja | primary_key, business_id, label, detail, timestamp, amount, formats, computed_aggregates |
column_types | mapping | Nein | Semantischer Typ pro Spalte (die Typologie). Siehe Column Types |
relationships | list | Nein | Zugehoerige Entity-Definitionen |
Columns
Abschnitt betitelt „Columns“| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
primary_key | string | Ja | Surrogatschluessel-Spalte |
business_id | string | Ja | Menschenlesbarer Business-Bezeichner |
label | string | Nein | Haupt-Anzeigename-Spalte |
detail | string | Nein | Sekundaere Detailspalte |
timestamp | string oder null | Nein | Primaere Zeitstempel-Spalte |
amount | string oder null | Nein | Primaere monetaere Betragsspalte |
Column Types
Abschnitt betitelt „Column Types“Geschwister zu columns: (das UI-Rollen zuweist) deklariert der column_types:-
Block den semantischen Typ jeder Spalte — die Typologie. Ein Eintrag pro Spalte,
verschluesselt nach Spaltenname:
column_types: material_id: { kind: identifier, subkind: foreign_key, references: materials.material_id } unit_price: { kind: quantity, standard: iso_4217, unit: CHF, rollup: non_additive } level: { kind: ordinal } status: { kind: category }Jeder Eintrag deklariert einen von acht kind-Werten (quantity, identifier,
category, ordinal, temporal, boolean, narrative, geometry), plus
optionales subkind, standard, unit, references, derived_from und — fuer
Groessen — eine rollup-Richtlinie. Validiert durch python3 scripts/typologycheck.py.
Siehe die Typologie-Referenz fuer die vollstaendige Feldliste, die Arten-Tabelle und das Roll-up-Vokabular.
Relationships
Abschnitt betitelt „Relationships“| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
target_model | string | Ja | Ziel-dbt-Modellname. Muss mit gold_ beginnen |
join_column | string | Ja | Join-Spalte auf dieser Entity |
target_join_column | string | Ja | Join-Spalte auf dem Zielmodell |
order_column | string | Ja | Sortier-Spalte |
label | i18n mapping | Ja | Beziehungs-Anzeige-Label (en/de/fr erforderlich) |
custom_sql | string | Nein | Benutzerdefiniertes SQL fuer komplexe Joins mit {schema} und $1 Platzhaltern |
Siehe die englische Referenz fuer vollstaendige Beispiele.
v0.65.0 · built 2026-11-13 10:20 UTC