Aller au contenu
hs-sql-agent
2.0.3
Documentation 2.0.3
Documentation Administration

Métadonnées sémantiques

Enrichir la découverte de base avec la sémantique des tables et colonnes, les relations et les métriques dans hs-sql-agent 2.0.2.

Entités Noms d’affichage, descriptions et synonymes pour les tables et colonnes.
Relations Relations nommées entre colonnes source et cible avec cardinalité et direction.
Métriques Métadonnées de métrique par table avec formule, agrégation, grain, filtres et synonymes.

Les métadonnées sémantiques appartiennent à une entrée Database Management. Elles enrichissent la façon dont la découverte de schéma décrit la base physique sans modifier le schéma lui-même.

Métadonnées d’entité

Un enregistrement d’entité peut cibler une table entière ou une colonne précise.

ChampSignification
DbManagementIdEntrée Database Management propriétaire
SchemaNameSchéma facultatif
TableNameNom physique de table obligatoire
ColumnNameFacultatif ; absent pour les métadonnées de niveau table
DisplayNameNom lisible par un humain
DescriptionDescription métier ou opérationnelle
SynonymsTermes alternatifs décrivant la table/colonne

Les synonymes sont normalisés en supprimant les valeurs vides, en dédupliquant sans tenir compte de la casse et en conservant au maximum 100 valeurs par enregistrement.

Relations

Les métadonnées de relation décrivent le lien entre deux colonnes physiques.

ChampSignification
NameNom de relation stable
SourceSchema / SourceTable / SourceColumnCôté source
TargetSchema / TargetTable / TargetColumnCôté cible
Cardinalitymany-to-one par défaut
Directionsource-to-target par défaut
DescriptionExplication facultative opérateur/métier

La découverte de schéma n’expose une description de relation que si les deux tables participantes sont autorisées par la liste blanche de la clé MCP authentifiée.

Métriques

Les métadonnées de métrique sont limitées à une table et peuvent décrire une mesure métier :

ChampSignification
NameIdentifiant stable de métrique
DisplayNameNom lisible
DescriptionExplication métier
FormulaMétadonnées de formule
Aggregationcustom par défaut ; peut décrire l’agrégation prévue
GrainGrain facultatif
FilterFiltre facultatif
SynonymsTermes alternatifs
Executablefalse dans le modèle 2.0.2

Consommation par la découverte de schéma MCP

Les outils formels de schéma restent get_schemas, get_tables et get_columns.

Lorsque des métadonnées sémantiques existent pour l’entrée liée à la clé :

  • get_tables peut ajouter nom d’affichage, description, synonymes et descriptions de métriques de la table ;
  • get_columns peut ajouter nom d’affichage, description, synonymes et descriptions de relations ;
  • la liste blanche de tables continue de filtrer la visibilité physique et le contexte des relations.

Les métadonnées sémantiques enrichissent donc la découverte sans élargir l’accès de la clé.

Surface Admin API

L’API 2.0.2 expose la gestion sémantique sous api/DbSemantic :

OpérationPermission
lire les entités d’une base/runtime/db-management/semanticview
lire le modèle combiné entités/relations/métriques/runtime/db-management/semanticview
upsert des métadonnées d’entité/runtime/db-management/semanticedit
supprimer les métadonnées d’entité/runtime/db-management/semanticedit
upsert/suppression d’une relation/runtime/db-management/semanticedit
upsert/suppression d’une métrique/runtime/db-management/semanticedit

Conseils de modélisation

Utilisez les métadonnées sémantiques pour les termes suffisamment stables pour aider plusieurs agents et opérateurs :

  • noms métier différents des noms physiques ;
  • abréviations et synonymes du domaine ;
  • relations importantes pour la génération de requêtes ;
  • définitions de métriques précisant formule et grain.

N’y placez pas d’identifiants secrets, d’instructions runtime ou de décisions d’autorisation. Le contrôle d’accès reste une couche appliquée séparément.