Skip to main content
Version: 4.10.1

Data Dictionary

The Data Dictionary is an extension of the DataStore (https://docs.ckan.org/en/2.9/maintaining/datastore.html#data-dictionary). The Data dictionary is a table with column names, type, terms and descriptions.

What can I do with the Data Dictionary?​

The Data Dictionary can be used to describe the content of a dataset more explicitely using labels and descriptions.

The Data Dictionary form allows entering the following values for each column:

  • Type Override: the type to be used the next time DataPusher is run to load data into this column
  • Label: a human-friendly label for this column
  • Description: a full description for this column in markdown format

Data Dictionary table in CKAN:​

Title

Does every datasource have a Data Dictionary?​

No, only certain file types support Data Dictionary functionality. Currently supported file formats for datasources in Dataplatform are:

  • CSV
  • DGN
  • GeoJSON
  • GPKG
  • Shapefile/ZIP
  • XLS, XLSX

If the datasource is uploaded to the DataStore correctly, the Data Dictionary table will be added.

Where can I find the Data Dictionary?​

The Data Dictionary can be viewed in CKAN as well as on the Portal.

CKAN:​

Click on a dataset -> click on a datasource

Portal​

Click on a dataset -> Click on the tab Table -> Click on Data dictionary

How to edit the Data Dictionary of a datasource​

The Data Dictionary can be edited within your CKAN instance

1. Within a dataset, click on the Explore button of the datasource you want to edit and then click on Edit​

Data_dict

2. Go to the tab Data dictionary​

Data_dict_go_to

3. Edit Type/Label/Description​

Data_dict_edit

4. Lastly, click the save button shown below​

Data_dict_save

Changes as shown in the Portal:​

Data_dict_portal