Scanning

Collect metadata about SQL query

It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query

post/api/v1/actions/dataSources/{dataSourceId}/scanSql

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Path parameters

dataSourceIdstring required

Data source id

Request body

sqlstring required

SQL query to be analyzed.

Example request

{
  "sql": "SELECT a.special_value as result FROM tableA a"
}

Response

The result of the scan.

Example response

{
  "columns": [
    {
      "dataType": "STRING",
      "description": "Customer unique identifier",
      "name": "ABC",
      "nullValue": "_"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.