Query Execution - Execute Query

บริการ:
Dataflow
เวอร์ชัน API:
v1

ดําเนินการคิวรีกับกระแสข้อมูลและแสดงผลลัพธ์
ดําเนินการคิวรีที่ระบุกับกระแสข้อมูลและสตรีมผลลัพธ์กลับไปยังผู้เรียก รองรับการใช้เอกสาร Mashup แบบกําหนดเองสําหรับสถานการณ์ขั้นสูง

API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

การอนุญาต

ผู้เรียกต้องมีสิทธิ์ ในการดําเนินการ สําหรับกระแสข้อมูล

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

Dataflow.Execute.All หรือ Item.Execute.All.

ข้อจำกัด

คิวรีสามารถเรียกใช้ได้สูงสุด 90 วินาที

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

Identity สนับสนุน
ผู้ใช้ ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ ใช่

รูปแบบการตอบสนอง

Acceptใช้หัวข้อเพื่อเจรจาชนิดสื่อการตอบสนอง วันนี้ รูปแบบการสตรีม ลูกศร Apache เป็นรูปแบบการตอบสนองที่พร้อมใช้งานเท่านั้น และอาจมีรูปแบบอื่นๆ เพิ่มเติมในอนาคต

รูปแบบการสตรีมลูกศร Apache

ชนิดของสื่อ:application/vnd.apache.arrow.stream

เมื่อส่งสื่อชนิด pq-arrow-version นี้ จําเป็นต้องใช้ พารามิเตอร์ media-type และเลือกรุ่นการเข้ารหัสลูกศร:

  • 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)

ID กระแสข้อมูล
workspaceId
 path True

string (uuid)

ID พื้นที่ทํางาน

ส่วนหัวของคำขอ

ชื่อ จำเป็น พิมพ์ คำอธิบาย
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

ชื่อของคิวรีที่จะดําเนินการจากกระแสข้อมูล (หรือจากเอกสาร Mashup แบบกําหนดเองถ้ามีให้)
customMashupDocument

string

เอกสาร Mashup แบบกําหนดเองที่เลือกได้เพื่อแทนที่ Mashup เริ่มต้นของกระแสข้อมูล

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
200 OK

file

ผลลัพธ์ของคิวรีสตรีมเสร็จเรียบร้อยแล้ว เนื้อความการตอบสนองจะถูกเข้ารหัสในชนิดของสื่อที่เจรจากันผ่านส่วนหัวของ Accept คําขอ (ดูคําอธิบายการดําเนินการสําหรับรายการของรูปแบบการตอบสนองที่ได้รับการสนับสนุน)

เมื่อการตอบกลับอยู่ในรูปแบบการสตรีมลูกศร Apache (application/vnd.apache.arrow.streamรูปแบบเดียวที่พร้อมใช้งานในวันนี้) ผลลัพธ์จะถูกสตรีมเป็น Apache Arrow IPC เวอร์ชันการเข้ารหัสลูกศรจะส่งคืนตรงกับพารามิเตอร์ที่ pq-arrow-version ส่งบนส่วนหัวของ Accept คําขอ (ค่าเริ่มต้น 1) ดู เอกสารประกอบลูกศร เกี่ยวกับวิธีการอ่านสตรีมใน 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 - การดําเนินการคิวรีล้มเหลว สาเหตุที่เป็นไปได้บางประการรวมถึง: ชื่อคิวรีที่ระบุไม่ถูกต้องหรือว่างเปล่า เอกสาร Mashup แบบกําหนดเองไม่ถูกต้อง หรือไม่พบชื่อคิวรีที่ระบุในกระแสข้อมูล (หรือในเอกสาร Mashup แบบกําหนดเองถ้ามี)

คำจำกัดความ

ชื่อ คำอธิบาย
ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse

การตอบสนองข้อผิดพลาด
ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด
ExecuteQueryRequest

คําขอส่วนข้อมูลสําหรับการดําเนินการคิวรีกับกระแสข้อมูล

ErrorRelatedResource

วัตถุ

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

การตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable

boolean

เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง Retry-After เพื่อกําหนดความล่าช้า ถ้ามี
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId

string (uuid)

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ExecuteQueryRequest

วัตถุ

คําขอส่วนข้อมูลสําหรับการดําเนินการคิวรีกับกระแสข้อมูล

ชื่อ พิมพ์ คำอธิบาย
customMashupDocument

string

เอกสาร Mashup แบบกําหนดเองที่เลือกได้เพื่อแทนที่ Mashup เริ่มต้นของกระแสข้อมูล
queryName

string

ชื่อของคิวรีที่จะดําเนินการจากกระแสข้อมูล (หรือจากเอกสาร Mashup แบบกําหนดเองถ้ามีให้)