Suspend a schedule

Suspend(ctx context.Context) error
Unsuspend(ctx context.Context) error

Suspend stops future automatic production for the named schedule. It does not retract produced messages or cancel their consumer handlers.

Unsuspend resumes at the expression’s next occurrence after the database’s current time. Occurrences missed while suspended are dropped.

Example

Using an initialized client, suspend the payment-reminder schedule:

if err := client.Scheduler("payment-reminder").Suspend(ctx); err != nil {
  return err
}

Resume it when automatic production should continue:

if err := client.Scheduler("payment-reminder").Unsuspend(ctx); err != nil {
  return err
}

Parameters

Returns

Repeated Suspend calls leave the schedule suspended. Unsuspend recalculates the next occurrence even when the schedule was already active. A running manager is required to produce automatic occurrences.

Run remains available while suspended.

CLI

sqlstreams scheduler suspend payment-reminder
sqlstreams scheduler unsuspend payment-reminder

Each command reports the new state and exits with status 0 on success. An absent schedule exits with status 1. --output json includes schedule, suspended, and next_scheduled_at. The last field is null on suspension.

Errors

Related topics

• Retrieve a schedule — Read suspension and scheduled times.
• Delete a schedule — Permanently remove the registration.