Endpoint de consultas aceleradas
Como parte da SKU do Data Distiller, a API de Serviço de Consulta permite fazer consultas sem estado ao repositório acelerado. Os resultados retornados são baseados em dados agregados. A redução da latência dos resultados permite uma troca de informações mais interativa. As APIs de consultas aceleradas também são usadas para habilitar painéis definidos pelo usuário.
Antes de continuar com este guia, leia e compreenda o Guia da API do Serviço de Consulta para usar com êxito a API do Serviço de Consulta.
Introdução
O SKU do Data Distiller é necessário para usar o armazenamento acelerado de consulta. Consulte a documentação de empacotamento e medidas de proteção e licenciamento relacionada à SKU do Data Distiller. Se você não tiver o Data Distiller SKU, entre em contato com o representante do serviço de atendimento ao cliente da Adobe para obter mais informações.
As seções a seguir detalham as chamadas de API necessárias para acessar o armazenamento acelerado de consulta de forma sem estado por meio da API do Serviço de consulta. Cada chamada inclui o formato da API geral, uma solicitação de amostra mostrando os cabeçalhos necessários e uma resposta de amostra.
Executar uma consulta acelerada run-accelerated-query
Faça uma solicitação POST ao ponto de extremidade /accelerated-queries para executar uma consulta acelerada. A consulta está contida diretamente na carga da solicitação ou é referenciada com uma ID de modelo.
Formato da API
POST /accelerated-queries
Solicitação
/accelerated-queries exigem uma instrução SQL OU uma ID de modelo, mas não ambas. O envio de ambos em uma solicitação causa um erro.A solicitação a seguir envia uma consulta SQL no corpo da solicitação para o armazenamento acelerado.
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."
}
'
Essa solicitação alternativa envia uma ID de modelo no corpo da solicitação para o armazenamento acelerado. O SQL do modelo correspondente é usado para consultar o armazenamento acelerado.
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."
}
'
dbNamedbName deve ter o formato de {SANDBOX_NAME}:{ACCELERATED_STORE_DATABASE}.{ACCELERATED_STORE_SCHEMA}. O banco de dados fornecido deve existir no repositório acelerado ou a solicitação resultará em um erro. Você também deve garantir que o cabeçalho x-sandbox-name e o nome da sandbox em dbName façam referência à mesma sandbox.sqltemplateId/templates.namedescriptionResposta
Uma resposta bem-sucedida retorna o status HTTP 200 com o esquema ad hoc criado pela consulta.
{
"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."
}
}
queryIdresultsMetaresultsMeta._adhocresultsMeta._adhoc.typeresultsMeta._adhoc.meta:xdmTyperesultsMeta._adhoc.propertiesresultsMeta._adhoc.results