Query Execution - Execute Query

Hizmet:: Dataflow

API Sürümü:: v1

Veri akışında sorgu yürütür ve sonucu döndürür.
Veri akışında belirtilen bir sorguyu yürütür ve sonucu çağırana geri akışla gönderir. Gelişmiş senaryolar için özel karma belgelerinin kullanılmasını destekler.

Bu API, uzun süre çalışan işlemleri (LRO)destekler.

Permissions

Çağıranın veri akışı için yürütme izinlerine sahip olması gerekir.

Gerekli Temsilci Kapsamları

Dataflow.Execute.All veya Item.Execute.All.

Sınırlamalar

Sorgular en fazla 90 saniye çalıştırılabilir.

Microsoft Entra destekli kimlikler

Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.

Kimlik	Support
User	Yes
Hizmet sorumlusu ve yönetilen kimlikler	Yes

Yanıt biçimleri

Accept Yanıt medya türüyle anlaşmak için üst bilgiyi kullanın. Bugün apache ok akış biçimi kullanılabilir tek yanıt biçimidir; gelecekte ek biçimler sunulabilir.

Apache Arrow akış biçimi

Medya türü:application/vnd.apache.arrow.stream

Bu medya türünü gönderirken, pq-arrow-version medya türü parametresi gereklidir ve Ok kodlama sürümünü seçer:

pq-arrow-version=1 — Özgün Apache Arrow kodlaması. Şirket içi veri ağ geçidi üzerinden bağlananlar da dahil olmak üzere tüm veri akışlarıyla uyumludur.
pq-arrow-version=2 — Geliştirilmiş akış performansı ile daha yeni Apache Arrow kodlaması. Şirket içi veri ağ geçidi üzerinden bağlanan veri akışları için desteklenmez.

Örneğin: Accept: application/vnd.apache.arrow.stream;pq-arrow-version=2

Accept Üst bilgi tamamen atlanırsa (veya */* gönderilirse), yanıt varsayılan olarak olurapplication/vnd.apache.arrow.stream;pq-arrow-version=1.

Arayüz

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
dataflowId	path	True	string (uuid)	Veri Akışı Kimliği.
workspaceId	path	True	string (uuid)	Çalışma alanı kimliği.

İstek Başlığı

Name	Gerekli	Tür	Description
Accept		string	Yanıtın istenen medya türü. Desteklenen yanıt biçimleri listesi için işlem açıklamasına bakın. Bugün, yalnızca `application/vnd.apache.arrow.stream` desteklenir; bu medya türü `pq-arrow-version` gönderilirken parametre gereklidir ve veya `2` (örneğin`application/vnd.apache.arrow.stream;pq-arrow-version=1`) olmalıdır`1`. Üst bilgi tamamen atlanırsa, varsayılan `application/vnd.apache.arrow.stream;pq-arrow-version=1` kullanılır.

İstek Gövdesi

Name	Gerekli	Tür	Description
queryName	True	string	Veri akışından yürütülecek sorgunun adı (veya varsa özel karma belgesinden).
customMashupDocument		string	Veri akışının varsayılan karmasını geçersiz kılmak için isteğe bağlı özel karma belgesi.

Yanıtlar

Name	Tür	Description
200 OK	file	Sorgu sonucu başarıyla akışla aktarıldı. Yanıt gövdesi, isteğin `Accept` üst bilgisi aracılığıyla anlaşılan medya türünde kodlanır (desteklenen yanıt biçimleri listesi için işlem açıklamasına bakın). Yanıt Apache Ok akış biçiminde olduğunda (`application/vnd.apache.arrow.stream`bugün kullanılabilen tek biçim), sonuçlar Apache Ok IPC olarak akışa alınır; döndürülen Ok kodlama sürümü isteğin `pq-arrow-versionAccept` üst bilgisinde (varsayılan `1`) gönderilen parametreyle eşleşir. Python'da ve diğer dillerde akışın nasıl okunduğuna ilişkin Ok belgelerine bakın. Sorgu yürütme veya akış sırasında karşılaşılan hatalar, sonundaki 'PQ Ok Meta Verileri' adlı ek bir sütunda bildirilir.
202 Accepted		İstek kabul edildi, sorgu yürütme devam ediyor. Üst Bilgiler Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir `Retry-After` üst bilgi döndürür. Üst Bilgiler Retry-After: integer
Other Status Codes	ErrorResponse	Yaygın hata kodları: DataflowExecuteQueryError - Sorgu yürütme başarısız oldu. Bazı olası nedenler şunlardır: belirtilen sorgu adı geçersiz veya boş, özel karma belgesi geçersiz veya belirtilen sorgu adı veri akışında (veya varsa özel karma belgesinde) bulunamadı.

Tanımlar

Name	Description
ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse	Hata yanıtı.
ErrorResponseDetails	Hata yanıtı ayrıntıları.
ExecuteQueryRequest	Veri akışında sorgu yürütmek için istek yükü.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name	Tür	Description
resourceId	string	Hataya dahil olan kaynak kimliği.
resourceType	string	Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
isRetriable	boolean	True olduğunda istek yeniden denenebilir. Varsa gecikmeyi `Retry-After` belirlemek için yanıt üst bilgisini kullanın.
message	string	Hatanın okunabilir bir gösterimi.
moreDetails	ErrorResponseDetails[]	Ek hata ayrıntılarının listesi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.
requestId	string (uuid)	Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Name	Tür	Description
errorCode	string	Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message	string	Hatanın okunabilir bir gösterimi.
relatedResource	ErrorRelatedResource	Hatayla ilgili kaynak ayrıntıları.

ExecuteQueryRequest

Nesne

Veri akışında sorgu yürütmek için istek yükü.

Name	Tür	Description
customMashupDocument	string	Veri akışının varsayılan karmasını geçersiz kılmak için isteğe bağlı özel karma belgesi.
queryName	string	Veri akışından yürütülecek sorgunun adı (veya varsa özel karma belgesinden).