Schema-Objektbeschreibungen zu einem Data Agent hinzufügen (Vorschau)

Schema-Objektbeschreibungen geben dem Datenagenten Geschäftskontext zu Tabellen, Spalten und anderen Elementen in einem Datenquellenschema. Dieser Kontext hilft dem Agenten, zwischen ähnlich benannten oder mehrdeutigen Objekten zu unterscheiden, den Zweck jedes Objekts zu verstehen und genauere Abfragen zu generieren. Beschreibungen sind besonders nützlich für große Schemata, bei denen Objektnamen allein ihre Bedeutung nicht klar vermitteln.

Schema-Objektbeschreibungen werden für SQL-Datenquellen unterstützt, einschließlich Lakehouses, Warehouses, Fabric SQL-Datenbanken und gespiegelten Datenbanken.

Hinweis

Schema-Objektbeschreibungen befinden sich derzeit in der öffentlichen Vorschau.

Hinweis

Schema-Objektbeschreibungen sind nur verfügbar, wenn Ihr Datenagent die Vorschaulaufzeit verwendet.

Eine Beschreibung hinzufügen oder bearbeiten

Standardmäßig erbt der Data Agent verfügbare Beschreibungen aus der Datenquelle und aktualisiert sie automatisch. Wenn Sie eine vererbte Beschreibung im Data Agent bearbeiten, gilt die Änderung nur für den Data Agent. Es überschreibt die Beschreibung im Quellcode nicht, und dieses Objekt erhält keine Beschreibungsupdates mehr vom Quellcode.

  1. Öffne deinen Data Agent und wähle dann Einrichten aus.
  2. Wählen Sie unter der Datenquelle Schema-Objektbeschreibungen aus.
  3. Erweitern Sie das Schema, um das Objekt zu finden, das Sie beschreiben möchten.
  4. Wählen Sie das Bearbeitungssymbol neben dem Objekt.
  5. Geben Sie eine Beschreibung ein und wählen Sie dann Fertig.

Screenshot der Bearbeitung einer Tabellenbeschreibung im Schema-Objektbeschreibungsfenster eines Datenagenten.

Füge eine Beschreibung mit dem Python SDK hinzu

Verwenden Sie das Fabric Data Agent Python SDK, um Schema-Objektbeschreibungen programmatisch zu verwalten. Das folgende Beispiel stellt eine Beschreibung für eine Tabelle in der ersten Datenquelle eines bestehenden Datenagenten fest:

from fabric.dataagent.client import FabricDataAgentManagement

agent = FabricDataAgentManagement("<data-agent-name>")
datasource = agent.get_datasources()[0]

table_path = ("Schemas", "dbo", "Tables", "adoptions")
datasource.update_description({
    table_path: "Contains one row for each pet adoption transaction."
})

Das Tupel identifiziert das Schema-Element anhand seines Pfades in der Datenquelle. Um eine Spalte zu beschreiben, fügen Sie ihren Namen dem Tabellenpfad hinzu. Verwenden Sie z. B. table_path + ("adoption_date",). Pfadnamen sind groß- und kleinschreibungssensitiv und müssen der für die Datenquelle angezeigten Hierarchie entsprechen.

Effektive Beschreibungen verfassen

Verwenden Sie Beschreibungen, um geschäftliche Bedeutung zu erklären, die sich nicht aus dem Namen eines Objekts ergibt. Halte jede Beschreibung prägnant und konkret.

  • Für Tabellen beschreiben Sie die dargestellten Geschäftseinheiten oder Ereignisse, den Detailgrad der Tabelle und ihren Hauptzweck.
  • Für Spalten definieren Sie die geschäftliche Bedeutung, das Format, die Einheit oder die erwarteten Werte des Wertes, wenn diese möglicherweise unklar sind.
  • Für andere Schema-Elemente erkläre ihre Rolle und wann der Datenagent sie verwenden sollte.
  • Erläutern Sie Abkürzungen, interne Terminologie und ähnlich benannte Objekte.
  • Fügen Sie Kontext hinzu, der dem Agenten hilft, bei der Erstellung einer Abfrage die richtigen Objekte und Beziehungen auszuwählen.

Verwandte Inhalte

  • Last updated on