Zum Inhalt springen
hs-sql-agent
2.0.3
Dokumentation 2.0.3
Dokumentation Administration

Semantische Metadaten

Datenbank-Ermittlung in hs-sql-agent 2.0.2 um Bedeutungen von Tabellen und Spalten, Beziehungen und Metrik-Metadaten ergänzen.

Entitäten Anzeigenamen, Beschreibungen und Synonyme für Tabellen und Spalten hinterlegen.
Beziehungen Benannte Beziehungen zwischen Quell- und Zielspalten mit Kardinalität und Richtung beschreiben.
Metriken Tabellenbezogene Metrik-Metadaten mit Formel, Aggregation, Grain, Filter und Synonymen pflegen.

Semantische Metadaten gehören zu einem Database-Management-Eintrag. Sie ergänzen die Beschreibung der physischen Datenbank bei der Schema-Ermittlung, ohne das physische Schema selbst zu verändern.

Entitätsmetadaten

Ein Entitätseintrag kann eine Tabelle oder eine einzelne Spalte innerhalb einer Tabelle beschreiben.

FeldBedeutung
DbManagementIdDatabase-Management-Eintrag, dem der semantische Datensatz gehört
SchemaNameOptionales Schema
TableNameErforderlicher physischer Tabellenname
ColumnNameOptional; für Metadaten auf Tabellenebene weglassen
DisplayNameLesbarer Anzeigename
DescriptionFachliche oder betriebliche Beschreibung
SynonymsAlternative Bezeichnungen für Tabelle oder Spalte

Synonyme werden normalisiert: leere Werte werden entfernt, Groß-/Kleinschreibung wird beim Deduplizieren ignoriert und pro Datensatz werden höchstens 100 Werte gespeichert.

Beziehungen

Beziehungsmetadaten beschreiben den Zusammenhang zwischen zwei physischen Spalten.

FeldBedeutung
NameStabiler Beziehungsname
SourceSchema / SourceTable / SourceColumnQuellseite
TargetSchema / TargetTable / TargetColumnZielseite
CardinalityStandard many-to-one
DirectionStandard source-to-target
DescriptionOptionale fachliche oder betriebliche Erklärung

Die Schema-Ermittlung zeigt Beziehungsbeschreibungen nur dann, wenn beide beteiligten Tabellen durch die Tabellen-Whitelist des authentifizierten MCP-Schlüssels erlaubt sind.

Metriken

Metrik-Metadaten sind an eine Tabelle gebunden und können ein fachliches Maß beschreiben:

FeldBedeutung
NameStabiler Metrik-Identifier
DisplayNameLesbarer Anzeigename
DescriptionFachliche Erklärung
FormulaFormel-Metadaten
AggregationStandard custom; beschreibt die beabsichtigte Aggregation
GrainOptionale Grain-Metadaten
FilterOptionale Filter-Metadaten
SynonymsAlternative Bezeichnungen für die Metrik
Executableim Modell 2.0.2 false

Nutzung durch MCP-Schema-Ermittlung

Die formalen MCP-Schema-Tools bleiben get_schemas, get_tables und get_columns.

Wenn für den gebundenen Database-Management-Eintrag semantische Metadaten vorhanden sind:

  • kann get_tables Anzeigename, Beschreibung, Synonyme und passende Metrikbeschreibungen ergänzen;
  • kann get_columns Spalten-Anzeigenamen, Beschreibung, Synonyme und passende Beziehungsbeschreibungen ergänzen;
  • filtern Tabellen-Whitelist-Regeln weiterhin die Sichtbarkeit physischer Tabellen und den Beziehungskontext.

Semantische Metadaten erweitern damit die Beschreibung, nicht die Zugriffsrechte eines Schlüssels.

Admin-API-Oberfläche

Die Admin API von 2.0.2 verwaltet Semantik unter api/DbSemantic:

OperationBerechtigung
Entitätseinträge einer Datenbank lesen/runtime/db-management/semanticview
kombiniertes Entitäts-/Beziehungs-/Metrikmodell lesen/runtime/db-management/semanticview
Entitätsmetadaten anlegen/aktualisieren/runtime/db-management/semanticedit
Entitätsmetadaten löschen/runtime/db-management/semanticedit
Beziehung anlegen/aktualisieren/löschen/runtime/db-management/semanticedit
Metrik anlegen/aktualisieren/löschen/runtime/db-management/semanticedit

Modellierungsempfehlungen

Verwenden Sie semantische Metadaten für Begriffe, die stabil genug sind, mehreren Agents und Administratoren zu helfen:

  • fachliche Namen, die von physischen Tabellen-/Spaltennamen abweichen;
  • Abkürzungen und Domänen-Synonyme;
  • Beziehungen, die für die Query-Erzeugung wichtig sind;
  • Metrikdefinitionen, die Formel und Grain präzisieren.

Nutzen Sie Schema-Beschreibungen nicht, um Zugangsdaten, Laufzeitanweisungen oder Autorisierungsentscheidungen einzuschleusen. Zugriffskontrolle bleibt eine getrennte, durchgesetzte Schicht.