加速查询端点

作为Data Distiller SKU的一部分, 查询服务API 允许您对加速存储进行无状态查询。 返回的结果基于聚合数据。 结果的延迟减少允许更具交互性的信息交换。 加速的查询API还可用于提供支持 用户定义的功能板.

在继续阅读本指南之前,请确保您已阅读并理解 查询服务API指南 以成功使用查询服务API。

快速入门

要使用查询加速存储,需要Data Distiller SKU。 请参阅 包装, 护栏许可 与数据Distiller SKU相关的文档。 如果您没有Data Distiller SKU,请联系您的Adobe客户服务代表以了解更多信息。

以下各节详细介绍通过查询服务API以无状态方式访问查询加速存储所需的API调用。 每个调用都包含常规API格式、显示所需标头的示例请求以及示例响应。

运行加速查询

向发出POST请求 /accelerated-queries 运行加速查询的端点。 查询直接包含在请求有效负载中,或者使用模板ID引用。

API格式

POST /accelerated-queries

请求

重要

请求 /accelerated-queries 端点需要SQL语句或模板ID,但不需要同时使用两者。 在请求中同时提交这两个报表会导致错误。

以下请求将请求正文中的SQL查询提交到加速存储。

curl -X POST https://platform.adobe.io/data/foundation/query/acceleated-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/acceleated-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}. 提供的数据库必须存在于加速存储中,否则请求将导致错误。 您还必须确保 x-sandbox-name 标头和沙盒名称(位于 dbName 引用同一沙盒。
sql SQL语句字符串。 允许的最大大小为1000000个字符。
templateId 在向提出POST请求时,创建并另存为模板的查询的唯一标识符 /templates 端点。
name 用于加速查询的可选人性化描述性名称。
description 关于查询意图的可选注释,以帮助其他用户了解其目的。 允许的最大大小为1000字节。

响应

成功响应会通过查询创建的临时架构返回HTTP状态200。

注意

为简短起见,以下响应已被截断。

{
  "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 临时体验数据模型(XDM)架构,其中的字段名称仅由单个数据集使用。
resultsMeta._adhoc.type 临时架构的数据类型。
resultsMeta._adhoc.meta:xdmType 这是系统为XDM字段类型生成的值。 有关可用类型的更多信息,请参阅 可用的XDM类型.
resultsMeta._adhoc.properties 这些是查询的数据集的列名称。
resultsMeta._adhoc.results 这些是查询的数据集的行名称。 它们反映每个返回的列。

在此页面上