Delete a schedule

Destroy(ctx context.Context) error

Deletes the schedule and its scheduled-time cursor. Already produced messages remain in the target stream and can still be processed. The client must have ClientConfig.AllowDestroy enabled.

Example

Using a client configured with AllowDestroy: true, delete the payment-reminder schedule:

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

Parameters

Returns

A later Register call can recreate the name. Remove its declaration from application startup if the schedule should stay deleted. There is no force option or requirement to empty the target stream.

CLI

sqlstreams scheduler destroy payment-reminder --yes

Without --yes, an interactive terminal must confirm by typing the schedule name. Non-interactive use and --output json require --yes. Success exits with status 0. An absent schedule exits with status 1. JSON output contains schedule, schedule_id, and destroyed: true.

Errors

Related topics

• Suspend a schedule — Pause automatic production without removing its registration.
• Create a client — Enable administrative destruction.