GraphQL şema görünümü ve şema gezgini için Fabric API

GraphQL için Doku API'si, bağlandığınız veri kaynaklarını temel alarak API'nizin yapısını tanımlayan bir şemayı otomatik olarak oluşturur. GraphQL Şema Tanım Dili (SDL) ile yazılan şema, istemcilerin verilerinizle etkileşimde bulunabilecek tüm kullanılabilir türleri, alanları, sorguları ve mutasyonları açıklar.

Şema görünümü, tam GraphQL şemanızın salt okunur, metin tabanlı bir görünümünü sağlarken, sol bölmedeki şema gezgini API'niz aracılığıyla kullanıma sunulan nesnelerde gezinmenize, bunları incelemenize ve değiştirmenize olanak tanır. Bu araçlar birlikte API'nizin yapısını anlamanıza ve istemciler için hangi verilerin erişilebilir olduğunu denetlemenize yardımcı olur.

Şema görünümünü kimler kullanır?

Şema görünümü ve gezgini şunlar için değerlidir:

• GraphQL aracılığıyla hangi Fabric lakehouse ve veri ambarı nesnelerini kullanıma sunacak şekilde yapılandıran veri mühendisleri
• Sorgu yazmadan önce kullanılabilir Doku veri türlerini, alanlarını ve ilişkilerini keşfeden uygulama geliştiricileri
• Fabric çalışma alanına katkıda bulunanlar, kendi çalışma alanları için veri erişim yapısını anlamak ve yönetmek.
• Özel analiz uygulamaları oluştururken Doku veri ilişkilerini gözden geçiren BI geliştiricileri

API'nizin yapısını keşfetmek için şema görünümünü ve hangi veri nesnelerinin kullanıma sunulduğunda değişiklik yapmak için şema gezginini kullanın.

Şemaya erişme ve şemayı keşfetme

Şema görünümüne sorgu düzenleyicisinden veya doğrudan GraphQL API öğenizden erişebilirsiniz. Şema görünümünü açmak için sol alt köşedeki Şema'yı seçin. Şema görünümü, oluşturulan tüm türler, alanlar, sorgular ve mutasyonlarla birlikte eksiksiz GraphQL SDL'nizin salt okunur, metin tabanlı bir sürümünü görüntüler.

Aşağıdaki görüntüde, sol tarafta Şema gezgini bölmesinin yer aldığı şema görünümü gösterilmektedir:

Şema gezginiyle gezinme

Sol bölmedeki Şema gezgini , API'nizdeki tüm nesnelerde gezinmenize ve bunları incelemenize olanak tanır. Gezgin hem şema görünümünde hem de sorgu düzenleyicisinde kullanılabilir ve sorgu yazarken API yapınızı keşfetmenizi kolaylaştırır.

Şema gezginindeki düğümleri genişleterek aşağıdakileri görüntüleyin:

• Türler: Veri kaynağı tablolarınızdan ve görünümlerinden oluşturulan GraphQL türleri
• Sorgular: Verileri almak için otomatik olarak oluşturulan okuma işlemleri
• Mutasyonlar: Verileri oluşturmak, güncelleştirmek ve silmek için otomatik üretilen yazma işlemleri (yalnızca veri ambarı)

Türler

Türler, verilerinizin yapısını temsil ederler ve oluşturuldukları veri kaynağının adı altında görünür. Aşağıdaki görüntüde AdventureWorks SQL analiz uç noktasındaki SalesOrderDetail tablosundan oluşturulan SalesOrderDetail türü gösterilmektedir:

Queries

API, erişime açtığınız nesnelerden veri almak için otomatik olarak sorgular oluşturur. Kullanılabilir tüm okuma işlemlerini görmek için sorgular düğümünü genişletin:

Mutasyon

Mutasyonlar veri oluşturmaya, güncelleştirmeye ve silmeye yönelik yazma işlemleridir. Tüm kullanılabilir yazma işlemlerini görmek için mutasyon düğümünü genişletin:

Not

Mutasyonlar yalnızca Doku Veri Ambarı veri kaynakları için oluşturulur. SQL Analytics Uç Noktaları (Lakehouses ve yansıtılmış veritabanları) salt okunur ve yalnızca sorguları destekler. Şema gezgininizde mutasyonlar görmüyorsanız Doku Veri Ambarı'na bağlandığınızdan emin olun.

Şema gezginini kullanarak nesneleri değiştirme

API ilk şemanızı oluşturduktan sonra, API'niz aracılığıyla kullanıma sunulanları iyileştirmek için şema gezginini kullanabilirsiniz. Şema gezgini, temel alınan veri kaynaklarını değiştirmeden API'nizin yapısını denetlemenize olanak sağlayan yönetim seçenekleri sağlar. Bu araçlar, yalnızca istemcilerinizin ihtiyaç duyduğu verileri kullanıma sunan temiz, iyi düzenlenmiş bir API'yi korumak için gereklidir.

Erişim değiştirme seçenekleri

Nesneyi değiştirmek için şema gezgininde herhangi bir türün yanında bulunan üç nokta simgesini (...) seçin. Aşağıdaki örnekte SalesOrderDetail türü için değişiklik menüsü gösterilmektedir:

Kullanılabilir değişiklik seçenekleri

Şemayı güncelleştirme - GraphQL şemanızı veri kaynağındaki en son yapıyla eşitler. Veri kaynağınıza yeni tablolar, görünümler veya sütunlar eklediğinizde ve bunları API aracılığıyla kullanıma açmak istediğinizde bunu kullanın. Bu işlem, mevcut yapılandırmanızı korurken yeni nesneleri bulur ve ekler.

Yeniden Adlandır - Nesnenin GraphQL API'nizde nasıl görüneceğini değiştirir. Bu, daha sezgisel API adlandırma kuralları oluşturmak veya uygulama ayrıntılarını istemcilerden gizlemek için kullanışlıdır. Örneğin, basitçe tbl_SalesOrderDetailolarak yeniden adlandırabilirsinizSalesOrderDetail. Yeniden adlandırma yalnızca API şemasını etkiler ve temel alınan veri kaynağı nesnesini değiştirmez.

Şemadan kaldır - Nesneyi GraphQL API'nizden kaldırarak istemciler tarafından kullanılamaz duruma getirir. Hassas verileri gizlemek, kullanım dışı bırakılan nesneleri kaldırmak veya API yüzeyinizi basitleştirmek için bunu kullanın. Veriler veri kaynağınızda kalır; yalnızca API'nin açığa çıkarılması kaldırılır.

İlişkileri yönetme - Nesnelerin birbirine nasıl bağlanabileceğini tanımlayabileceğiniz ilişki yönetimi arabirimini açar. İlişkiler iç içe sorguları ve graf geçişlerini etkinleştirerek istemcilerin tek bir istekte ilgili verileri almasını sağlar. Daha fazla bilgi için bkz . GraphQL için Doku API'sinde ilişkileri yönetme.

Özellikler - Veri kaynağında görünen özgün ad, GraphQL tür adı, sahip ve konum (çalışma alanı ve veri kaynağı adı) dahil olmak üzere nesneyle ilgili ayrıntılı meta verileri görüntüler. Nesnelerin veri kaynağınızla GraphQL API'si arasında nasıl eşlendiğini doğrulamak için bunu kullanın.

Sorguları ve mutasyonları etkinleştirme ve devre dışı bırakma

Sorgular ve mutasyonlar için etkinleştirme veya devre dışı bırakma özelliği, yöneticilere ve geliştiricilere API erişimi ve kullanımı üzerinde ayrıntılı denetim sağlar. GraphQL şemasında belirli sorguları ve mutasyonları seçmeli olarak etkinleştirmenize veya devre dışı bırakmanıza olanak tanır. Bu, kodu değiştirmeden veya değişiklikleri dağıtmadan API özelliklerini dinamik olarak yönetmenizi sağlar.

Aşağıdaki gibi senaryolar için bu özelliği kullanın:

• API sürümü oluşturma: İstemcileri yeni sürümlere geçirirken kullanım dışı bırakılan işlemleri devre dışı bırakma
• Bakım pencereleri: Veri bakımı sırasında yazma işlemlerini (mutasyonları) geçici olarak devre dışı bırakma
• Güvenlik ve uyumluluk: Hassas işlemlere erişimi şemadan kaldırmadan kısıtlama
• Aşamalı dağıtımlar: Kapsamlı olarak kullanılabilir hale getirmeden önce test için yeni sorguları veya mutasyonları etkinleştirin

Şema gezginindeki sorgular ve mutasyonlar için iki seçenek daha vardır:

• Devre dışı bırak: Herhangi bir talebin sorgu veya mutasyonu çalıştırmasını önler. Yürütme denenirse bir hata döndürülür. Bir sorgu veya mutasyon devre dışı bırakıldıktan sonra şema yeniden yüklemesi gerçekleşir ve şema gezgininde sorgu veya mutasyon gri görünür.

• Etkinleştir: Daha önce devre dışı bırakılmış bir sorguyu veya mutasyonu yeniden etkinleştirmenizi sağlar. Etkinleştir seçeneğini belirlediğinizde gerçekleşen şema yeniden yükleme işleminden sonra sorgu veya mutasyon hemen kullanılabilir.

Not

Saklı yordamlardan otomatik olarak oluşturulan sorgular ve mutasyonlar, tablolardan veya görünümlerden oluşturulanlardan farklı davranır. Bunlar yalnızca silinebilir, devre dışı bırakılamaz. Silme işleminden sonra, Veri Al veya Şemayı Güncelleştir seçeneklerini kullanarak bunları okuyabilirsiniz. Daha fazla bilgi için bkz: Saklı yordamlar.

İlgili içerik

• GraphQL düzenleyicisi için Platform API'si
• GraphQL için Doku API'sinde ilişkileri yönetme
• GraphQL için Doku API'sini kullanmaya başlama