Fabric API untuk tampilan skema GraphQL dan penjelajah skema

Fabric API untuk GraphQL secara otomatis menghasilkan skema yang menentukan struktur API Anda berdasarkan sumber data yang Anda sambungkan. Skema, yang ditulis dalam GraphQL Schema Definition Language (SDL), menjelaskan semua jenis, bidang, kueri, dan mutasi yang tersedia yang dapat digunakan klien untuk berinteraksi dengan data Anda.

Tampilan skema menyediakan tampilan baca-saja berbasis teks dari skema GraphQL lengkap Anda, sementara penjelajah skema di panel kiri memungkinkan Anda menavigasi, memeriksa, dan memodifikasi objek yang diekspos melalui API Anda. Bersama-sama, alat-alat ini membantu Anda memahami struktur API Anda dan mengontrol data apa yang dapat diakses oleh klien.

Siapa yang menggunakan tampilan skema

Tampilan skema dan penjelajah sangat berharga untuk:

• Insinyur data yang mengonfigurasi objek lakehouse dan gudang Fabric untuk diekspos melalui GraphQL
• Pengembang aplikasi menemukan jenis data Fabric, bidang, dan hubungan yang tersedia sebelum menulis kueri
• Kontributor ruang kerja Fabric memahami dan mengelola struktur akses data untuk ruang kerja mereka
• Pengembang BI meninjau hubungan data Fabric saat membangun aplikasi analitik kustom

Gunakan tampilan skema untuk menjelajahi struktur API Anda dan penjelajah skema untuk memodifikasi objek data mana yang diekspos.

Mengakses dan menjelajahi skema

Anda dapat mengakses tampilan skema dari editor kueri atau langsung dari item API GraphQL Anda. Untuk membuka tampilan skema, pilih Skema dari sudut kiri bawah. Tampilan skema menampilkan versi baca-saja berbasis teks dari GraphQL SDL lengkap Anda dengan semua jenis, bidang, kueri, dan mutasi yang dihasilkan.

Gambar berikut menunjukkan tampilan skema dengan panel penjelajah Skema di sebelah kiri:

Menavigasi dengan penjelajah skema

Penjelajah Skema di panel kiri memungkinkan Anda menavigasi dan memeriksa semua objek di API Anda. Penjelajah tersedia di tampilan skema dan editor kueri, sehingga mudah untuk menjelajahi struktur API Anda saat menulis kueri.

Perluas simpul di penjelajah skema untuk melihat:

• Jenis: Jenis GraphQL yang dihasilkan dari tabel dan tampilan sumber data Anda
• Kueri: Operasi baca yang dihasilkan secara otomatis untuk mengambil data
• Mutasi: Operasi tulis yang dihasilkan secara otomatis untuk membuat, memperbarui, dan menghapus data (hanya gudang data)

Jenis

Jenis mewakili struktur data Anda dan muncul di bawah nama sumber data tempat data dihasilkan. Gambar berikut menunjukkan jenis SalesOrderDetail yang dihasilkan dari tabel SalesOrderDetail di titik akhir analitik AdventureWorks SQL:

Queries

API secara otomatis menghasilkan kueri untuk mengambil data dari objek yang Anda ekspos. Perluas simpul kueri untuk melihat semua operasi baca yang tersedia:

Mutasi

Mutasi adalah operasi tulis untuk membuat, memperbarui, dan menghapus data. Perluas simpul mutasi untuk melihat semua operasi tulis yang tersedia:

Catatan

Mutasi hanya dihasilkan untuk sumber data Fabric Data Warehouse. Titik Akhir Analitik SQL (Lakehouse dan database yang dicerminkan) bersifat baca-saja dan hanya mendukung kueri. Jika Anda tidak melihat mutasi di penjelajah Skema, verifikasi bahwa Anda telah tersambung ke Gudang Data Fabric.

Mengubah objek menggunakan penjelajah skema

Setelah API menghasilkan skema awal, Anda dapat menggunakan penjelajah skema untuk menyempurnakan apa yang diekspos melalui API Anda. Penjelajah skema menyediakan opsi manajemen yang memungkinkan Anda mengontrol struktur API tanpa memodifikasi sumber data yang mendasar. Alat-alat ini sangat penting untuk mempertahankan API yang bersih dan terorganisir dengan baik yang hanya mengekspos data yang dibutuhkan klien Anda.

Opsi modifikasi akses

Untuk mengubah objek, pilih elipsis (...) di samping jenis apa pun di penjelajah skema. Contoh berikut menunjukkan menu modifikasi untuk jenis SalesOrderDetail :

Opsi modifikasi yang tersedia

Perbarui skema - Menyinkronkan skema GraphQL Anda dengan struktur terbaru dari sumber data. Gunakan ini saat Anda telah menambahkan tabel, tampilan, atau kolom baru ke sumber data Anda dan ingin mengeksposnya melalui API. Operasi ini menemukan dan menambahkan objek baru sambil mempertahankan konfigurasi yang ada.

Ganti nama - Mengubah tampilan objek di GraphQL API Anda. Ini berguna untuk membuat konvensi penamaan API yang lebih intuitif atau menyembunyikan detail implementasi dari klien. Misalnya, Anda mungkin mengganti nama tbl_SalesOrderDetail menjadi hanya SalesOrderDetail. Penggantian nama hanya memengaruhi skema API dan tidak mengubah objek sumber data yang mendasar.

Hapus dari skema - Menghapus objek dari API GraphQL Anda, membuatnya tidak tersedia untuk klien. Gunakan ini untuk menyembunyikan data sensitif, menghapus objek yang tidak digunakan lagi, atau menyederhanakan permukaan API Anda. Data tetap berada di sumber data Anda; hanya paparan API yang dihapus.

Mengelola hubungan - Membuka antarmuka manajemen hubungan tempat Anda dapat menentukan bagaimana objek terhubung satu sama lain. Hubungan memungkinkan kueri berlapis dan traversal grafik, memungkinkan klien mengambil data terkait dalam satu permintaan. Untuk informasi selengkapnya, lihat Mengelola hubungan di Fabric API untuk GraphQL.

Properti - Menampilkan metadata terperinci tentang objek, termasuk nama asli seperti yang muncul di sumber data, nama jenis GraphQL, pemilik, dan lokasi (nama ruang kerja dan sumber data). Gunakan ini untuk memverifikasi bagaimana objek dipetakan antara sumber data Anda dan API GraphQL.

Mengaktifkan dan menonaktifkan kueri dan mutasi

Fitur aktifkan atau nonaktifkan untuk kueri dan mutasi memberi administrator dan pengembang kontrol terperinci atas akses dan penggunaan API. Ini memungkinkan Anda untuk secara selektif mengaktifkan atau menonaktifkan kueri dan mutasi tertentu dalam skema GraphQL. Ini memungkinkan Anda mengelola kemampuan API secara dinamis tanpa memodifikasi kode atau menyebarkan perubahan.

Gunakan fitur ini untuk skenario seperti:

• Penerapan versi API: Menonaktifkan operasi yang tidak digunakan lagi saat transisi klien ke versi baru
• Jendela pemeliharaan: Nonaktifkan operasi tulis (mutasi) untuk sementara waktu selama pemeliharaan data
• Keamanan dan kepatuhan: Membatasi akses ke operasi sensitif tanpa menghapusnya dari skema
• Peluncuran bertahap: Mengaktifkan kueri atau mutasi baru untuk pengujian sebelum membuatnya tersedia secara luas

Kueri dan mutasi di penjelajah skema memiliki dua opsi lain:

• Nonaktifkan: Mencegah permintaan apa pun menjalankan kueri atau mutasi. Jika eksekusi dicoba, kesalahan akan dikembalikan. Setelah kueri atau mutasi dinonaktifkan, pemuatan ulang skema terjadi, dan kueri atau mutasi tampak berwarna abu-abu di penjelajah skema.

• Aktifkan: Memungkinkan Anda mengaktifkan kembali kueri atau mutasi yang dinonaktifkan sebelumnya. Kueri atau mutasi segera tersedia setelah operasi pemuatan ulang skema yang terjadi saat Anda memilih opsi Aktifkan .

Catatan

Kueri dan mutasi yang dibuat secara otomatis dari prosedur tersimpan bereaksi berbeda dari yang dihasilkan dari tabel atau tampilan. Mereka hanya dapat dihapus, tidak dinonaktifkan. Setelah penghapusan, Anda dapat membacanya menggunakan opsi Dapatkan Data atau Perbarui Skema . Untuk informasi selengkapnya, lihat Prosedur tersimpan.

Konten terkait

• Fabric API untuk editor GraphQL
• Mengelola hubungan di Fabric API untuk GraphQL
• Mulai menggunakan Fabric API untuk GraphQL