Column Metadata

Add column descriptions to a table registered as a Rasgo Dataset

Endpoint type

POST

Endpoint name

/public/column-metadata

Parameters

None

Request Body

application/json

{
  "fqtn": "DATABASE.SCHEMA.TABLE",
  "columnDescriptions": {
    "COLUMN_NAME": "...description...",
  }
}

Responses

200 - Successful Response

application/json

"Sent {n} column descriptions to Table {fqtn}. View these changes in the Rasgo WebApp: app.rasgoml.com/datasets/{dataset}"

Code Sample

curl -X 'POST' \
  'http://localhost/public/column-metadata' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "fqtn": "DATABASE.SCHEMA.TABLE",
  "columnDescriptions": {
    "COLUMN_A": "description",
    "COLUMN_B": "also description",
    "column_c": "third description"
  }
}'

Usage Notes

• Endpoint accepts a json dict of 1 or many column : description mappings

• Endpoint performs a case in-sensitive column match

• Endpoint will overwrite/replace existing descriptions on columns

• Endpoint does not handle deleting descriptions. Handle this through the Rasgo WebApp