Bir veri ajanına şema nesne açıklamaları ekle (önizleme)

Şema nesne açıklamaları, veri ajanına bir veri kaynağı şemasındaki tablolar, sütunlar ve diğer öğeler hakkında iş bağlamı sağlar. Bu bağlam, ajanın benzer isimli veya belirsiz nesneleri ayırt etmesine yardımcı olur, her nesnenin amacını anlamasına ve daha doğru sorgular üretmesine yardımcı olur. Açıklamalar, nesne isimlerinin anlamlarını net bir şekilde ifade etmediği büyük şemalar için özellikle faydalıdır.

Şema nesne açıklamaları, göl evleri, depolar, Fabric SQL veritabanları ve aynalı veritabanları dahil olmak üzere SQL veri kaynakları için desteklenir.

Not

Şema nesnesi açıklamaları şu anda halka açık önizleme aşamasındadır.

Not

Şema nesne açıklamaları yalnızca veri ajanınız önizleme çalışma zamanını kullandığında kullanılabilir.

Bir açıklama ekleyin veya düzenleyin

Varsayılan olarak, veri ajanı mevcut açıklamaları veri kaynağından devralır ve otomatik olarak günceller. Veri ajanında miras alınan bir açıklamayı düzenlediğinizde, değişiklik yalnızca veri ajanına uygulanır. Kaynaktaki açıklamanın üzerine yazmaz ve o nesne artık kaynaktan açıklama güncellemeleri almıyor.

  1. Veri ajanınızı açın ve ardından Kurulum'u seçin.
  2. Veri kaynağı altında, Şema nesne açıklamalarını seçin.
  3. Şemayı genişleterek tanımlamak istediğiniz nesneyi bulun.
  4. Nesnenin yanındaki Düzenle simgesini seçin.
  5. Bir açıklama girin ve ardından Bitti'ni seçin.

Bir veri ajanının Şema nesne açıklamaları panelinde bir tablo açıklamasının düzenlenmiş ekran görüntüsü.

Python SDK ile bir açıklama ekleyin

Şema nesne açıklamalarını programatik olarak yönetmek için Fabric veri ajanı Python SDK'yı kullanın. Aşağıdaki örnek, mevcut bir veri ajanının ilk veri kaynağında bir tablo için bir açıklama oluşturur:

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."
})

Tuple, şema elemanını veri kaynağındaki yoluna göre tanımlar. Bir sütunu tanımlamak için, adını tablo yoluna ekleyin. Örneğin, kullanın table_path + ("adoption_date",). Yol adları büyük/küçük harfe duyarlıdır ve veri kaynağı için gösterilen hiyerarşiyle eşleşmelidir.

Etkili açıklamalar yazın

Bir nesnenin adından belli olmayan iş anlamını açıklamak için açıklamalar kullanın. Her tanımı kısa ve spesifik tutun.

  • Tablolar için, temsil edilen iş birimleri veya olayları, tablonun detay seviyesini ve birincil amacını tanımlayın.
  • Sütunlar için, değerin iş anlamını ve gerektiğinde biçimini, birimini veya beklenen değerlerini tanımlayın.
  • Diğer şema öğeleri için, rollerini ve veri ajanının ne zaman kullanması gerektiğini açıklayın.
  • Kısaltmaları, iç terimleri ve benzer isimli nesneleri netleştirin.
  • Bir sorgu oluştururken ajanın doğru nesneleri ve ilişkileri seçmesine yardımcı olacak bağlamı ekleyin.