Skip to content

YAML reference

A DRE project is YAML and SQL files. Each kind of YAML file has a reference page that lists every key with its type, default and meaning. The pages are generated from the same JSON Schemas that give editors autocomplete, so they can’t miss a key.

File What it holds Reference
dre_project.yml The project: default profile and output, variables, week settings, folder config dre_project.yml
reports/**/*.yml A report: queries, output, destinations, Sets, templates Report YAML
sets.yml Named variants a report can run as sets.yml
schedules.yml Named schedules your orchestrator fires schedules.yml
timings.yml Named timings that schedules share timings.yml
profiles.yml Connections: sources and destinations (kept outside the project) profiles.yml
dependencies.yml Plugin packages and macro packages dependencies.yml
lookups/<name>.yml The config of a lookup file Lookup config

The options of each format and destination (for example delimiter, or an email’s to) are documented with their plugins in Plugins; that reference comes from the plugins themselves.

For editor autocomplete and validation, see Editor setup.