SQLStreams

the messaging platform that is just Postgres

You last visited on 9999-99-99 Show what's new since then

List schedules

Edit this page
Schedule · Related pages
Posted: 2026-09-16 · Report this thread
brandon Site Admin brandon profile Posts: 96
Schedulers(ctx context.Context) ([]*Schedule, error)

Lists every schedule in the client’s installation, ordered by name. The list includes suspended schedules and SQLStreams’ built-in schedules.

Example

Using an initialized client:

schedules, err := client.Schedulers(ctx)
if err != nil {
return err
}
for _, schedule := range schedules {
fmt.Println(schedule.Name, schedule.Expression, schedule.Suspended)
}

Parameters

Parameter Type Required Description
ctx context.Context Yes Cancellation or its deadline interrupts the database read.

Returns

Condition Return value
Schedules exist (schedules, nil), containing schedule objects.
No schedules exist (nil, nil).
Read fails, including absent schedule tables (nil, err).

There is no pagination or stream filter.

CLI

sqlstreams scheduler list

Prints registered schedules. A successful read exits with status 0, including an empty list. See schedule commands for output formats and flags.

Errors

Error When
Database or decoding error A registration cannot be read or decoded.
Context cancellation or deadline error The read is interrupted.