Skip to main content

duckstring window

Windows declare when an Inlet can produce new data. The Pond runs at most once per window, never between windows, and its data counts as fresh until the window ends. See Windows.

Windows are Catchment configuration and survive redeploys. A window can also be set on a Spout, as {pond}#{spout}, to limit how often it delivers.

Every command takes -c / --catchment, -m / --major and -v / --version; see CLI Overview.

window add​

duckstring window add POND --name NAME --every INTERVAL [options]
OptionDefaultDescription
--name, -nrequiredA name for the window, unique on this Pond.
--every, -erequiredHow often windows open, as a single-unit duration such as 1d, 12h or 10s.
--start, -s00:00 today (UTC)When the first window opens: ISO 8601, or HH:MM for today in UTC.
--duration, -d--everyHow long each window stays open. Omitting it gives back-to-back windows.
--on, -oevery dayOnly open on these weekdays, such as MON,WED,FRI.
--until, -unoneWhen the windows stop, in ISO 8601.

Windows on one Pond can't overlap; an overlapping window is rejected.

# A nightly export that lands between 02:00 and 03:00 UTC
duckstring window add transactions --name nightly --every 1d --start 02:00 --duration 1h

window ls​

duckstring window ls POND

Lists the Pond's windows.

window rm​

duckstring window rm POND NAME

Removes a window.