Config -> generated EDN files, one per schema.
Config: {:schemas ["public"] ; default ["public"] :out-dir "resources/pgmalli" ; default; files are <out-dir>/<schema>.edn :overrides {constraint-name schema-or-{:skip reason}} :db {:host :port :db :user :password :sslmode :psql :dir}} ; optional; psql's environment otherwise
File contents: {:schema "public" :database-version "PostgreSQL 17.6" :registry {name schema} :unrendered [fact ...] :skipped [fact ...]}
Output is deterministic (sorted maps, pprint). Overrides that are not EDN (functions) are rejected at generation time.
Config -> generated EDN files, one per schema.
Config:
{:schemas ["public"] ; default ["public"]
:out-dir "resources/pgmalli" ; default; files are <out-dir>/<schema>.edn
:overrides {constraint-name schema-or-{:skip reason}}
:db {:host :port :db :user :password :sslmode :psql :dir}} ; optional; psql's environment otherwise
File contents:
{:schema "public" :database-version "PostgreSQL 17.6"
:registry {name schema} :unrendered [fact ...] :skipped [fact ...]}
Output is deterministic (sorted maps, pprint). Overrides that are not EDN (functions)
are rejected at generation time.(config c)Config with defaults applied. Unknown keys are an error.
Config with defaults applied. Unknown keys are an error.
(generate! c)Writes every schema's file. Returns {schema path}.
Writes every schema's file. Returns {schema path}.
(generated {:keys [db overrides]} schema)Generated data for one schema.
Generated data for one schema.
(generated-all c){schema {:path :data}} for every schema in the config.
{schema {:path :data}} for every schema in the config.
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 |