Ponto de extremidade de consultas aceleradas

Como parte da SKU do Data Distiller, a variável API do serviço de consulta permite fazer consultas sem estado para o armazenamento acelerado. Os resultados retornados são baseados em dados agregados. A menor latência de resultados permite uma troca de informações mais interativa. As APIs de consultas aceleradas também são usadas para alimentar painéis definidos pelo usuário.

Antes de continuar com este guia, leia e entenda o Guia da API do Serviço de query para usar com êxito a API do Serviço de query.

Introdução

O SKU do Data Distiller é necessário para usar o armazenamento acelerado do query. Consulte a embalagem, medidas de proteçãoe licenciamento documentação relacionada ao SKU do Data Distiller. Se você não tiver a SKU do Data Distiller, entre em contato com o representante de serviço ao cliente do Adobe para obter mais informações.

As seções a seguir detalham as chamadas de API necessárias para acessar o armazenamento acelerado da consulta de maneira sem estado por meio da API do Serviço de query. Cada chamada inclui o formato da API geral, uma solicitação de amostra que mostra os cabeçalhos necessários e uma resposta de amostra.

Executar uma consulta acelerada

Faça uma solicitação de POST para o /accelerated-queries endpoint para executar uma consulta acelerada. A consulta é contida diretamente na carga da solicitação ou referenciada com uma ID de modelo.

Formato da API

POST /accelerated-queries

Solicitação

IMPORTANTE

Pedidos à /accelerated-queries O endpoint requer 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/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."
 }
'

Essa solicitação alternativa envia uma ID de modelo no corpo da solicitação para o armazenamento acelerado. O SQL do template correspondente é usado para consultar o armazenamento acelerado.

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."
 }
'
Propriedade Descrição
dbName O nome do banco de dados para o qual você está fazendo uma consulta acelerada. O valor de dbName deve assumir o formato de {SANDBOX_NAME}:{ACCELERATED_STORE_DATABASE}.{ACCELERATED_STORE_SCHEMA}. O banco de dados fornecido deve existir no armazenamento acelerado ou a solicitação resultará em um erro. Você também deve garantir que a variável x-sandbox-name cabeçalho e nome da sandbox em dbName consulte a mesma sandbox.
sql Uma string de instrução SQL. O tamanho máximo permitido é de 1000000 caracteres.
templateId O identificador exclusivo de um query criado e salvo como template quando uma solicitação de POST é feita à variável /templates endpoint .
name Um nome descritivo e amigável opcional para a consulta acelerada.
description Um comentário opcional sobre a intenção do query para ajudar outros usuários a entender sua finalidade. O tamanho máximo permitido é de 1000 bytes.

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com o schema ad hoc criado pela query.

OBSERVAÇÃO

A resposta a seguir foi truncada por motivos de brevidade.

{
  "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."
  }
}
Propriedade Descrição
queryId O valor da ID da consulta criada.
resultsMeta Esse objeto contém os metadados de cada coluna retornada nos resultados para que os usuários saibam o nome e o tipo de cada coluna.
resultsMeta._adhoc Um esquema do Modelo de dados ad-hoc (XDM) com campos que são namespacados para uso somente por um único conjunto de dados.
resultsMeta._adhoc.type O tipo de dados do schema ad hoc.
resultsMeta._adhoc.meta:xdmType Esse é um valor gerado pelo sistema para o tipo de campo XDM. Para obter mais informações sobre os tipos disponíveis, consulte a documentação em tipos XDM disponíveis.
resultsMeta._adhoc.properties Esses são os nomes das colunas do conjunto de dados consultado.
resultsMeta._adhoc.results Esses são os nomes de linha do conjunto de dados consultado. Elas refletem cada uma das colunas retornadas.

Nesta página