Liking cljdoc? Tell your friends :D

pgmalli.impl.files

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.6" :diagnostics [...] :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. The config is documented on pgmalli.generate.

File contents, in this order:
  {:schema "public" :database-version "PostgreSQL 17.6" :diagnostics [...]
   :registry {name schema} :unrendered [fact ...] :skipped [fact ...]}

Output is deterministic (sorted maps, pprint). Overrides that are not EDN (functions)
are rejected at generation time.
raw docstring

assembleclj

(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.
sourceraw docstring

configclj

(config c)

Config with defaults applied. Unknown keys are an error.

Config with defaults applied. Unknown keys are an error.
sourceraw docstring

default-configclj

source

edn-stringclj

(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.
sourceraw docstring

from-databaseclj

(from-database {:keys [db overrides]} schema)

Generated data for one schema, read from the database.

Generated data for one schema, read from the database.
sourceraw docstring

generate!clj

(generate! c)

Writes every schema's file. Returns {schema path}.

Writes every schema's file. Returns {schema path}.
sourceraw docstring

generated-allclj

(generated-all c)

{schema {:path :data}} for every schema in the config.

{schema {:path :data}} for every schema in the config.
sourceraw docstring

path-forclj

(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.
sourceraw docstring

read-ednclj

(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).
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close