query API | Python SDK | Teradata AppCenter - 2.0 - query API - Teradata AppCenter

Teradata® AppCenter Python SDK User Guide

prodname
Teradata AppCenter
vrm_release
2.0
created_date
September 2020
category
Programming Reference
User Guide
featnum
B035-1119-090K

Purpose

The query API queries Teradata Database, Teradata Vantage, and Aster Database and returns results as a JSON string.

Python Code Example

API Call Code
Query API call invocation
query_result = client.query(query='select issue as term , count ( * ) as tf_idf from consumer_complaints group by issue')

Result Example

In the following example, the output JSON "columns" section contains column metadata describing the name and type of every column. The "data" section contains data from the query.
{
  "queueDuration": 33,
  "queryDuration": 47646,
  "results": [
    {
      "resultSet": true,
      "columns": [
        {
          "name": "issue",
          "type": "varchar"
        },
        {
          "name": "issue_count",
          "type": "bigint"
        }
      ],
      "data": [
        {
          "issue": "APR or interest rate",
          "issue_count": 125
        },
        {
          "issue": "Account opening, closing, or management",
          "issue_count": 804
        },
        ……
      ]
    }
  ]
}