加速的查詢端點
作為Data Distiller SKU的一部分，Query Service API可讓您對加速存放區進行無狀態查詢。 傳回的結果會根據彙總的資料。 減少結果的延遲可讓您以更具互動性的方式交換資訊。 加速的查詢API也用來支援使用者定義儀表板。
繼續本指南之前，請確定您已閱讀並瞭解查詢服務API指南，以便成功使用查詢服務API。
快速入門
需要Data Distiller SKU才能使用查詢加速存放區。 請參閱封裝和護欄，以及與Data Distiller SKU相關的授權檔案。 如果您沒有Data Distiller SKU，請聯絡您的Adobe客戶服務代表以取得更多資訊。
以下幾節將詳細介紹透過查詢服務API以無狀態方式存取查詢加速存放區所需的API呼叫。 每個呼叫都包含一般API格式、顯示必要標題的範例要求以及範例回應。
執行加速查詢 run-accelerated-query
向/accelerated-queries端點發出POST要求以執行加速查詢。 查詢直接包含在請求承載中，或使用範本ID參照。
API格式
POST /accelerated-queries
請求
IMPORTANT
對
/accelerated-queries端點的要求需要SQL陳述式或範本ID，但不是兩者都需要。 在請求中提交兩者會產生錯誤。下列請求會將請求內文中的SQL查詢提交至加速存放區。
curl -X POST https://platform.adobe.io/data/foundation/query/accelerated-queries
-H 'Authorization: {ACCESS_TOKEN}'
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}'
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '
{
"dbName": "acmesbox1:acmeacceldb:accmeaggschema",
"sql": "SELECT * FROM accounts;",
"name": "Sample Accelerated Query",
"description": "A sample of an accelerated query."
}
'
此替代請求會將請求內文中的範本ID提交至加速存放區。 使用來自對應範本的SQL來查詢加速存放區。
curl -X POST https://platform.adobe.io/data/foundation/query/accelerated-queries
-H 'Authorization: {ACCESS_TOKEN}'
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}'
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '
{
"dbName": "acmesbox1:acmeacceldb:accmeaggschema",
"templateId": "5d8228e7-4200-e3de-11e9-7f27416c5f0d",
"name": "Sample Accelerated Query",
"description": "A sample of an accelerated query."
}
'
屬性
說明
dbName您對其執行加速查詢的資料庫名稱。
dbName的值應採用{SANDBOX_NAME}:{ACCELERATED_STORE_DATABASE}.{ACCELERATED_STORE_SCHEMA}格式。 提供的資料庫必須存在於加速存放區中，否則請求會導致錯誤。 您也必須確保dbName中的x-sandbox-name標頭和沙箱名稱參照相同的沙箱。sqlSQL陳述式字串。 允許的大小上限為1000000個字元。
templateId向
/templates端點發出POST請求時，建立並儲存為範本之查詢的唯一識別碼。name加速查詢的選擇性人性化描述性名稱。
description有關查詢意圖的可選評論，可幫助其他使用者瞭解其用途。 允許的大小上限為1000個位元組。
回應
成功的回應會傳回HTTP狀態200和查詢建立的臨時結構。
NOTE
為簡短起見，下列回應已截斷。
{
"queryId": "315a0a66-0fbb-4810-bc30-484cea5e0f1e",
"resultsMeta": {
"_adhoc": {
"type": "object",
"meta:xdmType": "object",
"properties": {
"Units": {
"type": "string",
"meta:xdmType": "string",
"default": null
},
"Industry_code_NZSIOC": {
"type": "string",
"meta:xdmType": "string",
"default": null
},
"Industry_name_NZSIOC": {
"type": "string",
"meta:xdmType": "string",
"default": null
},
"Variable_code": {
"type": "string",
"meta:xdmType": "string",
"default": null
},
"Variable_name": {
"type": "string",
"meta:xdmType": "string",
"default": null
},
"Industry_aggregation_NZSIOC": {
"type": "string",
"meta:xdmType": "string",
"default": null
},
"Value": {
"type": "string",
"meta:xdmType": "string",
"default": null
},
"Year": {
"type": "string",
"meta:xdmType": "string",
"default": null
},
"Variable_category": {
"type": "string",
"meta:xdmType": "string",
"default": null
},
"Industry_code_ANZSIC06": {
"type": "string",
"meta:xdmType": "string",
"default": null
}
}
}
},
"results": [
{
"Units": "Dollars (millions)",
"Industry_code_NZSIOC": "CC411",
"Industry_name_NZSIOC": "Printing",
"Variable_code": "H26",
"Variable_name": "Fixed tangible assets",
"Industry_aggregation_NZSIOC": "Level 4",
"Value": "282",
"Year": "2020",
"Variable_category": "Financial position",
"Industry_code_ANZSIC06": "ANZSIC06 groups C161 and C162"
},
{
"Units": "Dollars (millions)",
"Industry_code_NZSIOC": "CC411",
"Industry_name_NZSIOC": "Printing",
"Variable_code": "H27",
"Variable_name": "Additions to fixed assets",
"Industry_aggregation_NZSIOC": "Level 4",
"Value": "35",
"Year": "2020",
"Variable_category": "Financial position",
"Industry_code_ANZSIC06": "ANZSIC06 groups C161 and C162"
},
{
"Units": "Dollars (millions)",
"Industry_code_NZSIOC": "CC411",
"Industry_name_NZSIOC": "Printing",
"Variable_code": "H28",
"Variable_name": "Disposals of fixed assets",
"Industry_aggregation_NZSIOC": "Level 4",
"Value": "9",
"Year": "2020",
"Variable_category": "Financial position",
"Industry_code_ANZSIC06": "ANZSIC06 groups C161 and C162"
},
...
],
"request": {
"dbName": "acmesbox1:acmeacceldb:accmeaggschema",
"sql": "SELECT * FROM accounts;",
"name": "Sample Accelerated Query",
"description": "A sample of an accelerated query."
}
}
屬性
說明
queryId已建立查詢的ID值。
resultsMeta此物件包含結果中傳回之每個欄的中繼資料，讓使用者知道每個欄的名稱和型別。
resultsMeta._adhoc臨機Experience Data Model (XDM)結構描述中的欄位已命名為僅供單一資料集使用。
resultsMeta._adhoc.type臨時結構描述的資料型別。
resultsMeta._adhoc.meta:xdmType這是XDM欄位型別的系統產生值。 如需可用型別的詳細資訊，請參閱有關可用XDM型別的檔案。
resultsMeta._adhoc.properties這些是查詢資料集的欄名稱。
resultsMeta._adhoc.results這些是查詢資料集的列名稱。 它們會反映每個傳回的欄。
recommendation-more-help
ccf2b369-4031-483f-af63-a93b5ae5e3fb