Zum Inhalt springen

Entity YAML Referenz

Feld-Level-Spezifikation fuer Entity YAML-Definitionen (entities/*.yaml).

  • Ort: entities/*.yaml
  • entity_id muss mit dem Dateinamen uebereinstimmen
  • Spalten werden gegen contracts/gold_contract.v1.json validiert
  • Validator: python3 scripts/entitycheck.py
  • Compiler: python3 scripts/entitycompile.py
FeldTypErforderlichBeschreibung
entity_idstringJaMuss mit Dateiname uebereinstimmen
dbt_modelstringJaZiel-dbt-Modellname. Muss mit gold_ beginnen
display_namei18n mappingJaMenschenlesbarer Name (en/de/fr erforderlich)
iconstringNeinEinzelnes Zeichen fuer UI-Anzeige
is_browseablebooleanNeinOb Entity in JinDesk Browse-Ansichten erscheint
probe_entity_typestringNeinGold Contract Entity-Typname
kindstringNeincore | analytical | view
taxonomymappingNeindimension_type, caption_column
columnsmappingJaprimary_key, business_id, label, detail, timestamp, amount, formats, computed_aggregates
column_typesmappingNeinSemantischer Typ pro Spalte (die Typologie). Siehe Column Types
relationshipslistNeinZugehoerige Entity-Definitionen
FeldTypErforderlichBeschreibung
primary_keystringJaSurrogatschluessel-Spalte
business_idstringJaMenschenlesbarer Business-Bezeichner
labelstringNeinHaupt-Anzeigename-Spalte
detailstringNeinSekundaere Detailspalte
timestampstring oder nullNeinPrimaere Zeitstempel-Spalte
amountstring oder nullNeinPrimaere monetaere Betragsspalte

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.

FeldTypErforderlichBeschreibung
target_modelstringJaZiel-dbt-Modellname. Muss mit gold_ beginnen
join_columnstringJaJoin-Spalte auf dieser Entity
target_join_columnstringJaJoin-Spalte auf dem Zielmodell
order_columnstringJaSortier-Spalte
labeli18n mappingJaBeziehungs-Anzeige-Label (en/de/fr erforderlich)
custom_sqlstringNeinBenutzerdefiniertes SQL fuer komplexe Joins mit {schema} und $1 Platzhaltern

Siehe die englische Referenz fuer vollstaendige Beispiele.

jazzisnow jinflow is a jazzisnow product
v0.65.0 · built 2026-11-13 10:20 UTC