API Fabric για προβολή σχήματος GraphQL και εξερεύνηση σχήματος

Το Fabric API για GraphQL δημιουργεί αυτόματα ένα σχήμα που καθορίζει τη δομή του API σας με βάση τις πηγές δεδομένων που συνδέετε. Το σχήμα, γραμμένο σε GraphQL Schema Definition Language (SDL), περιγράφει όλους τους διαθέσιμους τύπους, πεδία, ερωτήματα και μεταλλάξεις που μπορούν να χρησιμοποιήσουν οι πελάτες για να αλληλεπιδράσουν με τα δεδομένα σας.

Η προβολή σχήματος παρέχει μια προβολή μόνο για ανάγνωση, βασισμένη σε κείμενο του πλήρους σχήματος GraphQL, ενώ η εξερεύνηση σχήματος στο αριστερό παράθυρο σάς επιτρέπει να πλοηγείστε, να επιθεωρείτε και να τροποποιείτε τα αντικείμενα που εκτίθενται μέσω του API σας. Μαζί, αυτά τα εργαλεία σάς βοηθούν να κατανοήσετε τη δομή του API σας και να ελέγξετε ποια δεδομένα είναι προσβάσιμα στους πελάτες.

Ποιος χρησιμοποιεί την προβολή σχήματος

Η προβολή σχήματος και ο εξερευνητής είναι πολύτιμοι για:

• Μηχανικοί δεδομένων που διαμορφώνουν ποια αντικείμενα λίμνης και αποθήκης Fabric θα εκτεθούν μέσω του GraphQL
• Προγραμματιστές εφαρμογών που ανακαλύπτουν διαθέσιμους τύπους δεδομένων, πεδία και σχέσεις Fabric πριν από τη σύνταξη ερωτημάτων
• Οι συμβάλλοντες χώρου εργασίας Fabric κατανοούν και διαχειρίζονται τη δομή πρόσβασης δεδομένων για τον χώρο εργασίας τους
• Προγραμματιστές BI που εξετάζουν τις σχέσεις δεδομένων Fabric κατά τη δημιουργία προσαρμοσμένων εφαρμογών ανάλυσης

Χρησιμοποιήστε την προβολή σχήματος για να εξερευνήσετε τη δομή του API σας και την εξερεύνηση σχήματος για να τροποποιήσετε ποια αντικείμενα δεδομένων εκτίθενται.

Πρόσβαση και εξερεύνηση του σχήματος

Μπορείτε να αποκτήσετε πρόσβαση στην προβολή σχήματος είτε από το πρόγραμμα επεξεργασίας ερωτημάτων είτε απευθείας από το στοιχείο GraphQL API. Για να ανοίξετε την προβολή σχήματος, επιλέξτε Σχήμα από την κάτω αριστερή γωνία. Η προβολή σχήματος εμφανίζει μια έκδοση μόνο για ανάγνωση, βασισμένη σε κείμενο του πλήρους GraphQL SDL με όλους τους τύπους, τα πεδία, τα ερωτήματα και τις μεταλλάξεις που δημιουργούνται.

Η παρακάτω εικόνα εμφανίζει την προβολή σχήματος με το τμήμα παραθύρου Εξερεύνηση σχήματος στα αριστερά:

Περιήγηση με την εξερεύνηση σχήματος

Η Εξερεύνηση σχήματος στο αριστερό τμήμα παραθύρου σάς επιτρέπει να περιηγηθείτε και να επιθεωρήσετε όλα τα αντικείμενα στο API σας. Ο εξερευνητής είναι διαθέσιμος τόσο στην προβολή σχήματος όσο και στο πρόγραμμα επεξεργασίας ερωτημάτων, καθιστώντας εύκολη την εξερεύνηση της δομής του API σας κατά τη σύνταξη ερωτημάτων.

Αναπτύξτε τους κόμβους στην εξερεύνηση σχήματος για να δείτε:

• Τύποι: Οι τύποι GraphQL που δημιουργούνται από τους πίνακες και τις προβολές προέλευσης δεδομένων σας
• Ερωτήματα: Λειτουργίες ανάγνωσης που δημιουργούνται αυτόματα για την ανάκτηση δεδομένων
• Μεταλλάξεις: Λειτουργίες εγγραφής που δημιουργούνται αυτόματα για τη δημιουργία, την ενημέρωση και τη διαγραφή δεδομένων (μόνο αποθήκη)

Τύποι

Οι τύποι αντιπροσωπεύουν τη δομή των δεδομένων σας και εμφανίζονται κάτω από το όνομα της προέλευσης δεδομένων από την οποία δημιουργήθηκαν. Η παρακάτω εικόνα εμφανίζει τον τύπο SalesOrderDetail που δημιουργήθηκε από τον πίνακα SalesOrderDetail στο τελικό σημείο ανάλυσης SQL της AdventureWorks :

Ερωτήματα

Το API δημιουργεί αυτόματα ερωτήματα για την ανάκτηση δεδομένων από τα αντικείμενα που εκθέτετε. Αναπτύξτε τον κόμβο ερωτημάτων για να δείτε όλες τις διαθέσιμες λειτουργίες ανάγνωσης:

Μεταλλάξεις

Οι μεταλλάξεις είναι λειτουργίες εγγραφής για τη δημιουργία, την ενημέρωση και τη διαγραφή δεδομένων. Αναπτύξτε τον κόμβο μεταλλάξεων για να δείτε όλες τις διαθέσιμες λειτουργίες εγγραφής:

Σημείωμα

Οι μεταλλάξεις δημιουργούνται μόνο για προελεύσεις δεδομένων Fabric Data Warehouse. Τα τελικά σημεία ανάλυσης SQL (Lakehouses και βάσεις δεδομένων κατοπτρισμού) είναι μόνο για ανάγνωση και υποστηρίζουν μόνο ερωτήματα. Εάν δεν βλέπετε μεταλλάξεις στην εξερεύνηση σχήματος, επαληθεύστε ότι έχετε συνδεθεί σε μια αποθήκη δεδομένων Fabric.

Τροποποίηση αντικειμένων με χρήση της εξερεύνησης σχημάτων

Αφού το API δημιουργήσει το αρχικό σας σχήμα, μπορείτε να χρησιμοποιήσετε την εξερεύνηση σχήματος για να κάνετε πιο συγκεκριμένο αυτό που εκτίθεται μέσω του API σας. Η εξερεύνηση σχήματος παρέχει επιλογές διαχείρισης που σας επιτρέπουν να ελέγχετε τη δομή του API σας χωρίς να τροποποιείτε τις υποκείμενες προελεύσεις δεδομένων. Αυτά τα εργαλεία είναι απαραίτητα για τη διατήρηση ενός καθαρού, καλά οργανωμένου API που εκθέτει μόνο τα δεδομένα που χρειάζονται οι πελάτες σας.

Πρόσβαση σε επιλογές τροποποίησης

Για να τροποποιήσετε ένα αντικείμενο, επιλέξτε τα αποσιωπητικά (...) δίπλα σε οποιονδήποτε τύπο στην εξερεύνηση σχήματος. Το παρακάτω παράδειγμα εμφανίζει το μενού τροποποίησης για τον τύπο SalesOrderDetail :

Διαθέσιμες επιλογές τροποποίησης

Ενημέρωση σχήματος - Συγχρονίζει το σχήμα GraphQL με την πιο πρόσφατη δομή από την πηγή δεδομένων. Χρησιμοποιήστε αυτήν την επιλογή όταν έχετε προσθέσει νέους πίνακες, προβολές ή στήλες στην προέλευση δεδομένων σας και θέλετε να τις εκθέσετε μέσω του API. Αυτή η λειτουργία ανακαλύπτει και προσθέτει νέα αντικείμενα, διατηρώντας παράλληλα την υπάρχουσα διαμόρφωσή σας.

Μετονομασία - Αλλάζει τον τρόπο εμφάνισης του αντικειμένου στο GraphQL API σας. Αυτό είναι χρήσιμο για τη δημιουργία πιο εύχρηστων συμβάσεων ονομασίας API ή την απόκρυψη λεπτομερειών υλοποίησης από πελάτες. Για παράδειγμα, μπορείτε να μετονομάσετε tbl_SalesOrderDetail σε απλά SalesOrderDetail. Η μετονομασία επηρεάζει μόνο το σχήμα API και δεν τροποποιεί το υποκείμενο αντικείμενο προέλευσης δεδομένων.

Κατάργηση από το σχήμα - Καταργεί το αντικείμενο από το GraphQL API, καθιστώντας το μη διαθέσιμο στους πελάτες. Χρησιμοποιήστε το για να αποκρύψετε ευαίσθητα δεδομένα, να αφαιρέσετε αντικείμενα που έχουν καταργηθεί ή να απλοποιήσετε την επιφάνεια API σας. Τα δεδομένα παραμένουν στην πηγή δεδομένων σας. αφαιρείται μόνο η έκθεση API.

Διαχείριση σχέσεων - Ανοίγει το περιβάλλον διαχείρισης σχέσεων όπου μπορείτε να ορίσετε τον τρόπο σύνδεσης των αντικειμένων μεταξύ τους. Οι σχέσεις επιτρέπουν ένθετα ερωτήματα και διέλευση γραφήματος, επιτρέποντας στους πελάτες να ανακτούν σχετικά δεδομένα σε μία μόνο αίτηση. Για περισσότερες πληροφορίες, ανατρέξτε στο θέμα Διαχείριση σχέσεων στο API Fabric για GraphQL.

Ιδιότητες - Εμφανίζει λεπτομερή μεταδεδομένα σχετικά με το αντικείμενο, συμπεριλαμβανομένου του αρχικού ονόματος όπως εμφανίζεται στην πηγή δεδομένων, του ονόματος τύπου GraphQL, του κατόχου και της τοποθεσίας (όνομα χώρου εργασίας και πηγής δεδομένων). Χρησιμοποιήστε το για να επαληθεύσετε τον τρόπο αντιστοίχισης των αντικειμένων μεταξύ της πηγής δεδομένων σας και του GraphQL API.

Ενεργοποίηση και απενεργοποίηση ερωτημάτων και μεταλλάξεων

Η δυνατότητα ενεργοποίησης ή απενεργοποίησης για ερωτήματα και μεταλλάξεις παρέχει στους διαχειριστές και τους προγραμματιστές λεπτομερή έλεγχο της πρόσβασης και της χρήσης του API. Σας επιτρέπει να ενεργοποιήσετε ή να απενεργοποιήσετε επιλεκτικά συγκεκριμένα ερωτήματα και μεταλλάξεις μέσα στο σχήμα GraphQL. Αυτό σας επιτρέπει να διαχειρίζεστε τις δυνατότητες του API δυναμικά χωρίς να τροποποιείτε κώδικα ή να αναπτύσσετε αλλαγές.

Χρησιμοποιήστε αυτήν τη δυνατότητα για σενάρια όπως:

• Διαχείριση εκδόσεων API: Απενεργοποιήστε τις λειτουργίες που έχουν καταργηθεί κατά τη μετάβαση των υπολογιστών-πελατών σε νέες εκδόσεις
• Παράθυρα συντήρησης: Απενεργοποιήστε προσωρινά τις λειτουργίες εγγραφής (μεταλλάξεις) κατά τη συντήρηση δεδομένων
• Ασφάλεια και συμμόρφωση: Περιορίστε την πρόσβαση σε ευαίσθητες λειτουργίες χωρίς να τις αφαιρέσετε από το σχήμα
• Σταδιακή διάθεση: Ενεργοποιήστε νέα ερωτήματα ή μεταλλάξεις για δοκιμή πριν τα κάνετε ευρέως διαθέσιμα

Τα ερωτήματα και οι μεταλλάξεις στον εξερευνητή σχήματος έχουν δύο άλλες επιλογές:

• Απενεργοποίηση: Αποτρέπει τυχόν αιτήματα από την εκτέλεση του ερωτήματος ή της μετάλλαξης. Εάν επιχειρηθεί εκτέλεση, επιστρέφεται σφάλμα. Μετά την απενεργοποίηση ενός ερωτήματος ή μιας μετάλλαξης, πραγματοποιείται επαναφόρτωση σχήματος και το ερώτημα ή η μετάλλαξη εμφανίζεται με αχνά γράμματα στην εξερεύνηση σχήματος.

• Ενεργοποίηση: Σας επιτρέπει να ενεργοποιήσετε ξανά ένα ερώτημα ή μετάλλαξη που είχε απενεργοποιηθεί προηγουμένως. Το ερώτημα ή η μετάλλαξη είναι άμεσα διαθέσιμη μετά τη λειτουργία επαναφόρτωσης σχήματος που προκύπτει όταν επιλέγετε την επιλογή Ενεργοποίηση .

Σημείωμα

Τα ερωτήματα και οι μεταλλάξεις που δημιουργούνται αυτόματα από αποθηκευμένες διαδικασίες συμπεριφέρονται διαφορετικά από αυτά που δημιουργούνται από πίνακες ή προβολές. Μπορούν μόνο να διαγραφούν, όχι να απενεργοποιηθούν. Μετά τη διαγραφή, μπορείτε να τα προσθέσετε ξανά χρησιμοποιώντας τις επιλογές Λήψη δεδομένων ή Ενημέρωση σχήματος . Για περισσότερες πληροφορίες, ανατρέξτε στην ενότητα Αποθηκευμένες διαδικασίες.

Σχετικό περιεχόμενο

• API Fabric για το πρόγραμμα επεξεργασίας GraphQL
• Διαχείριση σχέσεων στο Fabric API για GraphQL
• Γρήγορα αποτελέσματα με το Fabric API για GraphQL