Skip to content

Latest commit

 

History

History
27 lines (23 loc) · 932 Bytes

conventions.md

File metadata and controls

27 lines (23 loc) · 932 Bytes
Raw

Data Supply Conventions

Metadata

Data supply will associate certain files together. If it finds a source data file, it will look for a correspondingly named metadata file to provide information about that data. e.g. if data supply finds population.csv it will look for population.meta.json.

Metadata files allow you to specify the types of data columns in your source data and extera parsing/ formatting information as well as any other metadata your project might need to consume alongside the data.

Continuing the previous example if a row of data in population.csv looks like this...

{
  "city":"London",
  "population":"8982000",
  "date":"2019"
}

population.yml might look like this

__Title: The populations of cities in the UK
city: String
population: Number
date:
 - Date
 - "%Y"

at the moment data supply doesn't make use of this metadata but it does get attached to the