Query Execution - Execute Query

Υπηρεσία:: Dataflow

Έκδοση API:: v1

Εκτελεί ένα ερώτημα σε σχέση με μια ροή δεδομένων και επιστρέφει το αποτέλεσμα.
Εκτελεί ένα καθορισμένο ερώτημα σε σχέση με μια ροή δεδομένων και αναπαράγει μέσω ροής το αποτέλεσμα στον καλούντα. Υποστηρίζει τη χρήση προσαρμοσμένων εγγράφων συνδυασμού δεδομένων για σύνθετα σενάρια.

Αυτό το API υποστηρίζει λειτουργίες μεγάλης διάρκειας (LRO).

Δικαιώματα

Ο καλών πρέπει να έχει δικαιώματα εκτέλεσης για τη ροή δεδομένων.

Απαιτούμενες εμβέλειες με ανάθεση

Dataflow.Execute.All ή Item.Execute.All.

Περιορισμοί

Τα ερωτήματα μπορούν να εκτελεστούν για μέγιστο διάστημα 90 δευτερολέπτων.

Υποστηριζόμενες ταυτότητες Microsoft Entra

Αυτό το API υποστηρίζει τις ταυτότητες Microsoft που παρατίθενται σε αυτή την ενότητα.

Ταυτότητα	Υποστηρίζω
User	Yes
Υπηρεσίας και διαχειριζόμενες ταυτότητες	Yes

Μορφές απόκρισης

Χρησιμοποιήστε την Accept κεφαλίδα για να διαπραγματευτείτε τον τύπο πολυμέσων απόκρισης. Σήμερα, η μορφή ροής Βέλος Apache είναι η μοναδική διαθέσιμη μορφή απόκρισης. ενδέχεται να προσφερθούν πρόσθετες μορφές στο μέλλον.

Μορφή ροής βέλους Apache

Τύπος πολυμέσων:application/vnd.apache.arrow.stream

Κατά την αποστολή αυτού του τύπου πολυμέσων, pq-arrow-version η παράμετρος τύπου πολυμέσων και επιλέγει την έκδοση κωδικοποίησης βέλους:

pq-arrow-version=1 — Αρχική κωδικοποίηση με βέλος Apache. Συμβατή με όλες τις ροές δεδομένων, συμπεριλαμβανομένων εκείνων που συνδέονται μέσω μιας πύλης δεδομένων εσωτερικής εγκατάστασης.
pq-arrow-version=2 — Νεότερη κωδικοποίηση με βέλος Apache με βελτιωμένες επιδόσεις ροής. Δεν υποστηρίζεται για ροές δεδομένων που συνδέονται μέσω μιας πύλης δεδομένων εσωτερικής εγκατάστασης.

Παράδειγμα: Accept: application/vnd.apache.arrow.stream;pq-arrow-version=2

Εάν η Accept κεφαλίδα παραλειφθεί εντελώς (ή */* αποσταλεί), η απόκριση ορίζεται από προεπιλογή σε application/vnd.apache.arrow.stream;pq-arrow-version=1.

Διεπαφή

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/executeQuery

Παράμετροι URI

Ονομασία	Σε	Απαιτείται	Τύπος	Περιγραφή
dataflowId	path	True	string (uuid)	Το αναγνωριστικό ροής δεδομένων.
workspaceId	path	True	string (uuid)	Το αναγνωριστικό χώρου εργασίας.

Κεφαλίδα αίτησης

Ονομασία	Απαιτείται	Τύπος	Περιγραφή
Accept		string	Ο επιθυμητός τύπος πολυμέσων της απόκρισης. Ανατρέξτε στην περιγραφή της λειτουργίας για τη λίστα των υποστηριζόμενων μορφών απόκρισης. Σήμερα, υποστηρίζεται μόνο `application/vnd.apache.arrow.stream` . Κατά την αποστολή αυτού του τύπου πολυμέσων, η `pq-arrow-version` παράμετρος απαιτείται και πρέπει να είναι είτε `1` είτε `2` (π.χ. `application/vnd.apache.arrow.stream;pq-arrow-version=1`). Εάν η κεφαλίδα παραλειφθεί πλήρως, χρησιμοποιείται η προεπιλογή `application/vnd.apache.arrow.stream;pq-arrow-version=1` .

Κυρίως τμήμα αίτησης

Ονομασία	Απαιτείται	Τύπος	Περιγραφή
queryName	True	string	Το όνομα του ερωτήματος για εκτέλεση από τη ροή δεδομένων (ή από το προσαρμοσμένο έγγραφο συνδυασμού δεδομένων, εάν παρέχεται).
customMashupDocument		string	Προαιρετικό προσαρμοσμένο έγγραφο συνδυασμού δεδομένων για παράκαμψη του προεπιλεγμένου συνδυασμού δεδομένων.

Αποκρίσεις

Ονομασία	Τύπος	Περιγραφή
200 OK	file	Η ροή του αποτελέσματος του ερωτήματος ολοκληρώθηκε με επιτυχία. Το σώμα της απόκρισης κωδικοποιείται στον τύπο πολυμέσων που αποτελεί αντικείμενο διαπραγμάτευσης μέσω της κεφαλίδας της `Accept` αίτησης (ανατρέξτε στην περιγραφή της λειτουργίας για τη λίστα υποστηριζόμενων μορφών απόκρισης). Όταν η απόκριση είναι σε μορφή ροής Με βέλος Apache (`application/vnd.apache.arrow.stream`, η μόνη μορφή που είναι διαθέσιμη σήμερα), τα αποτελέσματα μεταδίδονται μέσω ροής ως Apache Arrow IPC. Η έκδοση κωδικοποίησης βέλους που επιστρέφεται συμφωνεί με την `pq-arrow-version` παράμετρο που στάλθηκε στην κεφαλίδα της `Accept` αίτησης (προεπιλογή `1`). Ανατρέξτε στην τεκμηρίωση του Arrow σχετικά με τον τρόπο ανάγνωσης της ροής στην Python και σε άλλες γλώσσες. Τα σφάλματα που παρουσιάστηκαν κατά την εκτέλεση ερωτημάτων ή τη ροή αναφέρονται σε μια πρόσθετη στήλη στο τέλος με το όνομα "Μετα-δεδομένα βέλους PQ".
202 Accepted		Αποδοχή αίτησης, εκτέλεση ερωτήματος σε εξέλιξη. Κεφαλίδες Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Έγινε υπέρβαση του ορίου επιτοκίου υπηρεσίας. Ο διακομιστής επιστρέφει μια `Retry-After` κεφαλίδα που υποδεικνύει, σε δευτερόλεπτα, πόσο πρέπει να περιμένει ο υπολογιστής-πελάτης πριν από την αποστολή πρόσθετων αιτήσεων. Κεφαλίδες Retry-After: integer
Other Status Codes	ErrorResponse	Συνήθεις κωδικοί σφαλμάτων: DataflowExecuteQueryError - Η εκτέλεση ερωτήματος απέτυχε. Ορισμένοι πιθανοί λόγοι περιλαμβάνουν: το καθορισμένο όνομα ερωτήματος δεν είναι έγκυρο ή κενό, το προσαρμοσμένο έγγραφο συνδυασμού δεδομένων δεν είναι έγκυρο ή το καθορισμένο όνομα ερωτήματος δεν βρέθηκε στη ροή δεδομένων (ή στο προσαρμοσμένο έγγραφο συνδυασμού δεδομένων, εάν παρέχεται).

Ορισμοί

Ονομασία	Περιγραφή
ErrorParameter	Μια δομημένη παράμετρος που παρέχει πρόσθετο περιβάλλον αναγνώσιμο από υπολογιστή σχετικά με ένα σφάλμα.
ErrorRelatedResource	Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.
ErrorResponse	Η απόκριση σφάλματος.
ErrorResponseDetails	Οι λεπτομέρειες της απόκρισης σφάλματος.
ExecuteQueryRequest	Αίτηση ωφέλιμου φορτίου για την εκτέλεση ενός ερωτήματος σε σχέση με μια ροή δεδομένων.

ErrorParameter

Αντικείμενο

Μια δομημένη παράμετρος που παρέχει πρόσθετο περιβάλλον αναγνώσιμο από υπολογιστή σχετικά με ένα σφάλμα.

Ονομασία	Τύπος	Περιγραφή
message	string	Μια αναγνώσιμη από τον άνθρωπο περιγραφή της έννοιας της παραμέτρου.
name	string	Το αναγνωριστικό παραμέτρου.
value	string	Η τιμή της παραμέτρου.

ErrorRelatedResource

Αντικείμενο

Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.

Ονομασία	Τύπος	Περιγραφή
resourceId	string	Το αναγνωριστικό πόρου που εμπλέκεται στο σφάλμα.
resourceType	string	Ο τύπος του πόρου που εμπλέκεται στο σφάλμα.

ErrorResponse

Αντικείμενο

Η απόκριση σφάλματος.

Ονομασία	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
isRetriable	boolean	Όταν είναι true, η αίτηση μπορεί να επαναληφθεί. Χρησιμοποιήστε την `Retry-After` κεφαλίδα απόκρισης για να προσδιορίσετε την καθυστέρηση, εάν υπάρχει.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
moreDetails	ErrorResponseDetails[]	Λίστα πρόσθετων λεπτομερειών σφάλματος.
parameters	ErrorParameter[]	Δομημένες παράμετροι που παρέχουν πρόσθετο περιβάλλον αναγνώσιμο από υπολογιστή σχετικά με το σφάλμα.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.
requestId	string (uuid)	Το αναγνωριστικό της αίτησης που σχετίζεται με το σφάλμα.

ErrorResponseDetails

Αντικείμενο

Οι λεπτομέρειες της απόκρισης σφάλματος.

Ονομασία	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
parameters	ErrorParameter[]	Δομημένες παράμετροι που παρέχουν πρόσθετο περιβάλλον αναγνώσιμο από υπολογιστή σχετικά με το σφάλμα.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.

ExecuteQueryRequest

Αντικείμενο

Αίτηση ωφέλιμου φορτίου για την εκτέλεση ενός ερωτήματος σε σχέση με μια ροή δεδομένων.

Ονομασία	Τύπος	Περιγραφή
customMashupDocument	string	Προαιρετικό προσαρμοσμένο έγγραφο συνδυασμού δεδομένων για παράκαμψη του προεπιλεγμένου συνδυασμού δεδομένων.
queryName	string	Το όνομα του ερωτήματος για εκτέλεση από τη ροή δεδομένων (ή από το προσαρμοσμένο έγγραφο συνδυασμού δεδομένων, εάν παρέχεται).