Configuration validation and management for PgFlow.

Uses NimbleOptions to validate configuration options passed to PgFlow.start_link/1.

Options

• :repo (required) - The Ecto repository module to use for database operations.
• :flows (optional) - List of flow modules to automatically register on startup. Default: [].
• :jobs (optional) - List of job modules to automatically register on startup. Default: [].
• :worker_name (optional) - Human-readable name for workers in logs. Default: auto-generated from flow slug.
• :max_concurrency (optional) - Maximum number of parallel tasks per worker. Default: 10.
• :batch_size (optional) - Number of messages to fetch per poll cycle. Default: 10.
• :signal_strategy (optional) - Signal detection strategy. :polling (adaptive backoff) or :notify (LISTEN/NOTIFY). Default: :polling.
• :heartbeat_interval (optional) - Milliseconds between worker heartbeats. Default: 10000. Max: 20_000.
• :min_poll_interval (optional) - Minimum milliseconds between polls (fastest rate). Default: 1000. Max: 300_000 (5 minutes).
• :max_poll_interval (optional) - Maximum milliseconds between polls (slowest rate during backoff). Default: 5000. Max: 300_000 (5 minutes).
• :notify_fallback_interval (optional) - Milliseconds between fallback polls when using :notify strategy. Default: 30000. Max: 600_000 (10 minutes).
• :notify_throttle_ms (optional) - Throttle interval for pgmq LISTEN/NOTIFY trigger. Default: 250.
• :notify_trigger (optional) - :deferred recreates pgmq's notify trigger DEFERRABLE INITIALLY DEFERRED when workers boot with signal_strategy: :notify; :pgmq_default keeps the immediate trigger pgmq creates. Default: :deferred.
• :notify_lock_timeout_ms (optional) - Milliseconds the :deferred trigger install waits for the queue table lock before failing and retrying with backoff. Default: 2000.
• :recovery_interval (optional) - Milliseconds between stalled task recovery sweeps. Default: 15_000.
• :stale_threshold (optional) - Buffer in seconds added beyond a task's effective (step or flow) opt_timeout before it is considered stalled. Default: 60.
• :attach_default_logger (optional) - Whether to attach the default telemetry logger. Default: false.
• :pubsub (optional) - Phoenix.PubSub module for broadcasting telemetry events to LiveViews. Default: nil (disabled).
• :worker_options (optional) - Map of flow or job module to per-worker option keywords (:max_concurrency, :batch_size). Keys must be listed in :flows or :jobs; an entry applies whether PgFlow.FlowStarter or PgFlow.start_worker/2 starts that module's worker, and start_worker/2 options override it. Default: %{}.

Interval Constraints

• min_poll_interval must be <= max_poll_interval
• heartbeat_interval must not exceed 20 seconds (20,000 ms)
• max_poll_interval must not exceed 5 minutes (300,000 ms)
• notify_fallback_interval must not exceed 10 minutes (600,000 ms)

Examples

config = PgFlow.Config.validate!(
  repo: MyApp.Repo,
  flows: [MyApp.Flows.ProcessOrder],
  max_concurrency: 20,
  signal_strategy: :notify
)