Commands

Every command, argument and option of mudab 0.5.1, read from the CLI itself.

Global options

These options work with every command.

OptionDescriptionDefault
-V, --version output the version number
--base-url <url> API base URL https://geoportal.bafg.de/mudab/rest/BaseController/FilterElements
--timeout <ms> time limit per request in ms, whole response included (0 = no timeout)
--user-agent <ua> User-Agent header value
--max-retries <n> retries for transient 429/503 responses, not network failures (0..10, default 2; a linear backoff from 200 ms, or the server's Retry-After when longer, up to 30 s)
--max-response-bytes <n> cap response body size in bytes (0 = no cap, but a reply above about 512 MiB can't be decoded; default 100 MiB)
--log-format <format> how errors, warnings and notes are written to stderr: text (log4j style: time, level, [topic], message) or jsonl (one JSON object per line: ts, level, topic, msg); default text
--compact print JSON on a single line instead of pretty-printed

mudab stations

List measurement stations (STATION_SMALL)

mudab stations [options]

Options

OptionDescriptionDefault
--from <n> skip this many rows (range.from; from + count at most 2147483647)
--count <n> max rows to return (default 100)
--all return the whole table (omit the range — can be very large; not combinable with --from/--count)

mudab project-stations

List project stations (PROJECTSTATION_SMALL)

mudab project-stations [options]

Options

OptionDescriptionDefault
--from <n> skip this many rows (range.from; from + count at most 2147483647)
--count <n> max rows to return (default 100)
--all return the whole table (omit the range — can be very large; not combinable with --from/--count)

mudab measurements

List individual station measurements (MV_STATION_MSMNT) — a very large table

mudab measurements [options]

Options

OptionDescriptionDefault
--from <n> skip this many rows (range.from; from + count at most 2147483647)
--count <n> max rows to return (default 100)
--all return the whole table (omit the range — can be very large; not combinable with --from/--count)

mudab plc-stations

List HELCOM PLC stations (V_PLC_STATION)

mudab plc-stations [options]

Options

OptionDescriptionDefault
--from <n> skip this many rows (range.from; from + count at most 2147483647)
--count <n> max rows to return (default 100)
--all return the whole table (omit the range — can be very large; not combinable with --from/--count)

mudab plc-parameters

List parameters measured at PLC stations (V_GEMESSENE_PARA_PLC)

mudab plc-parameters [options]

Options

OptionDescriptionDefault
--from <n> skip this many rows (range.from; from + count at most 2147483647)
--count <n> max rows to return (default 100)
--all return the whole table (omit the range — can be very large; not combinable with --from/--count)

mudab plc-measurements

List measured values at PLC stations (V_MESSWERTE_PLC)

mudab plc-measurements [options]

Options

OptionDescriptionDefault
--from <n> skip this many rows (range.from; from + count at most 2147483647)
--count <n> max rows to return (default 100)
--all return the whole table (omit the range — can be very large; not combinable with --from/--count)

mudab parameters

List measured parameters (MV_PARAMETER)

mudab parameters [options]

Options

OptionDescriptionDefault
--compartment <c> restrict to a compartment's parameter endpoint Choices: biologie, biota, wasser, sediment
--from <n> skip this many rows (range.from; from + count at most 2147483647)
--count <n> max rows to return (default 100)
--all return the whole table (omit the range — can be very large; not combinable with --from/--count)

mudab compartments

Print the compartment (COMPT_DS) code table — works offline, no request

mudab compartments [options]