Config -> generated EDN files, one per schema. The config is documented on pgmalli.generate.
File contents, in this order: {:schema "public" :database-version "PostgreSQL 17" :diagnostics [...] :registry {name schema} :unrendered [entry ...] :skipped [entry ...]}
An :unrendered or :skipped entry is {:kind :table or :domain :column :constraint :sql :type}, the keys that apply.
Output is deterministic (sorted maps, pprint). Overrides that are not EDN (functions) are rejected at generation time.
Config -> generated EDN files, one per schema. The config is documented on pgmalli.generate.
File contents, in this order:
{:schema "public" :database-version "PostgreSQL 17" :diagnostics [...]
:registry {name schema} :unrendered [entry ...] :skipped [entry ...]}
An :unrendered or :skipped entry is {:kind :table or :domain :column :constraint :sql :type},
the keys that apply.
Output is deterministic (sorted maps, pprint). Overrides that are not EDN (functions)
are rejected at generation time.(assemble schema database-version facts overrides)The file's data from the rendering of a schema's facts, in reading order: what it is, then what deserves a look, then the schemas, then what was left out.
The file's data from the rendering of a schema's facts, in reading order: what it is, then what deserves a look, then the schemas, then what was left out.
(config c)Config with defaults applied. A key or value config-schema does not take is an error.
Config with defaults applied. A key or value config-schema does not take is an error.
(edn-string data)The file's text: a deterministic pprint of the data behind the do-not-edit header. Data that does not read back as EDN is an error.
The file's text: a deterministic pprint of the data behind the do-not-edit header. Data that does not read back as EDN is an error.
(from-database {:keys [db overrides]} schema)Generated data for one schema, read from the database.
Generated data for one schema, read from the database.
(generate! c)Writes every schema's file. Returns {schema path}.
Writes every schema's file. Returns {schema path}.
(generated-all c){schema {:path :data}} for every schema in the config.
{schema {:path :data}} for every schema in the config.
(path-for c schema)Where a schema's file goes: <out-dir>/<schema>.edn; the config as given or with its defaults applied.
Where a schema's file goes: <out-dir>/<schema>.edn; the config as given or with its defaults applied.
(read-edn path)The generated data in a file, by path (pgmalli.impl.registry reads the classpath instead).
The generated data in a file, by path (pgmalli.impl.registry reads the classpath instead).
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |