Point d’entrée de requêtes accélérées
Dans le cadre du SKU Data Distiller, l’API Query Service vous permet d’effectuer des requêtes sans état vers la boutique accélérée. Les résultats renvoyés sont basés sur des données agrégées. La diminution de la latence des résultats permet un échange plus interactif d’informations. Les API de requêtes accélérées sont également utilisées pour alimenter les tableaux de bord définis par l’utilisateur.
Avant de poursuivre avec ce guide, assurez-vous d’avoir lu et compris le guide de l’API Query Service pour utiliser correctement l’API Query Service.
Prise en main
Le SKU Data Distiller est requis pour utiliser la boutique de requêtes accélérées. Veuillez consulter la documentation packaging et guardrails, ainsi que la documentation licensing relative au SKU de Data Distiller. Si vous ne disposez pas du SKU de Data Distiller, contactez votre représentant du service client Adobe pour plus d’informations.
Les sections suivantes détaillent les appels d’API nécessaires pour accéder sans état à la boutique de requêtes accélérées via l’API Query Service. Chaque appel inclut le format général d’API, un exemple de requête présentant les en-têtes requis et un exemple de réponse.
Exécuter une requête accélérée run-accelerated-query
Envoyez une requête POST au point d’entrée /accelerated-queries pour exécuter une requête accélérée. La requête est contenue directement dans la payload de la requête ou référencée avec un identifiant de modèle.
Format d’API
POST /accelerated-queries
Requête
/accelerated-queries nécessitent une instruction SQL OU un identifiant de modèle, mais pas les deux. L’envoi des deux dans une requête provoque une erreur.La requête suivante envoie une requête SQL dans le corps de la requête à la boutique accélérée.
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."
}
'
Cette autre requête envoie un identifiant de modèle dans le corps de la requête à la boutique accélérée. Le code SQL du modèle correspondant est utilisé pour envoyer une requête à la boutique accélérée.
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 doit prendre le format {SANDBOX_NAME}:{ACCELERATED_STORE_DATABASE}.{ACCELERATED_STORE_SCHEMA}. La base de données fournie doit exister dans la boutique accélérée, sinon la requête entraînera une erreur. Vous devez également vous assurer que l’en-tête x-sandbox-name et le nom du sandbox dans dbName se rapportent au même sandbox.sqltemplateId/templates.namedescriptionRéponse
Une réponse réussie renvoie un statut HTTP 200 avec le schéma ad hoc créé par la requête.
{
"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