Skip to content

Reference

Reference pages are technical descriptions to look things up in, not to read from start to finish. They state exactly what exists: names, options, defaults and schemas. They do not teach or argue; for that, see Tutorials and Explanation.

Pages

  • Command line: the ./agoranomos commands that set up, check and run the stack.
  • Configuration: every setting in the .env file, with its default.
  • System requirements: what a machine needs to run the stack, the memory that each service uses, and its memory limit.
  • Describe the marts: the rules for the descriptions of the dbt models, the display names of the marts and the semantic types of their columns, and how the tests check them.
  • Data model: the layers of the warehouse and the marts, with their grain and keys, the settings of the clients and the conversions, the currencies, days and names of the model, its tests, the demo platforms, and the upgrade from v0.1.

Planned reference pages

  • Metrics catalog: the definition of each metric, including how it is calculated and whether it is additive.

Reference pages are published together with the features they describe.