Describe call

Description of the data source is a process of gathering information on the available data and building its schema for further use during execution. One can call description on the /collections/actions/describe path. The response consists of a list of Collections.

Example POST payload:

{
  "host": "oracle",
  "port": 1521,
  "username": "test",
  "password": "test",
  "database": "test.localdomain"
}

Example response payload:

[ 
  {
    "uid": "test.customer",
    "attributes_schema": {
      "attributes": [
        {
          "uid": "id",
          "type": "crystal.topics.data.attribute-types.categorical"
        },
        {
          "uid": "name",
          "type": "crystal.topics.data.attribute-types.categorical"
        },
        {
          "uid": "creation",
          "type": "crystal.topics.data.attribute-types.datetime"
        },
        {
          "uid": "country",
          "type": "crystal.topics.data.attribute-types.categorical"
        },
        {
          "uid": "points",
          "type": "crystal.topics.data.attribute-types.numeric"
        }
      ]
    }
  }
]

Untangling this response: our test.localdomain oracle database has one table named test.customer that has columns: id, name, creation, country, and points.

Also, creation column is some sort of datetime field - exacts are Datasource dependant.

---

Last update: November 30, 2020