Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

gorun

package module

Go to main page

Versions in this module

v0

v0.4.1

Oct 16, 2024

v0.3.2

Sep 23, 2024

v0.3.1

Sep 10, 2024

v0.3.0

Sep 10, 2024

Changes in this version

type Option

+ func OnJobComplete(...) Option

+ func OnJobInit(f func(ctx context.Context, jobType string, jobId string) context.Context) Option

+ func WithArgProcessor(f func(ctx context.Context, jobType string, jobId string, args any) error) Option

v0.2.2

Aug 31, 2024

v0.2.1

Aug 31, 2024

v0.2.0

Aug 30, 2024

v0.1.0

Aug 30, 2024

Changes in this version

+ const StatusCompleted

+ const StatusFailed

+ const StatusRunning

+ const StatusScheduled

+ var ErrGorunInternalError = errors.Sentinel("internal gorun job service error", 500)

+ var ErrUnregisteredJobType = errors.Sentinel("unregistered job type", 500)

+ var MarkIncompleteJobsHandler = Handler[MarkIncompleteJobs]

+ var ProcessTriggersHandler = Handler[ProcessTriggers]

+ func RegisterHandler[T JobData](h *Handler[T])

+ type GoRunService interface

+ Close func()

+ DeleteTrigger func(ctx context.Context, triggerId string) error

+ GetJob func(ctx context.Context, jobId string) (*gorundb.JobData, error)

+ ListJobs func(ctx context.Context, start, end time.Time) ([]*gorundb.JobData, error)

+ ListTriggers func(ctx context.Context) ([]*gorundb.JobTrigger, error)

+ ScheduleAfter func(ctx context.Context, delay time.Duration, job JobData) (jobId string, err error)

+ ScheduleCron func(ctx context.Context, cronExpr string, loc *time.Location, job JobData) (triggerId string, err error)

+ ScheduleCronWithKey func(ctx context.Context, triggerId string, cronExpr string, loc *time.Location, ...) error

+ ScheduleImmediately func(ctx context.Context, job JobData) (jobId string, err error)

+ ScheduleRepeated func(ctx context.Context, interval time.Duration, job JobData) (triggerId string, err error)

+ ScheduleRepeatedWithKey func(ctx context.Context, triggerId string, interval time.Duration, job JobData) error

+ Start func(ctx context.Context) error

+ func New(db *sql.DB, opts ...Option) (GoRunService, error)

+ func NewFromEnv(opts ...Option) (GoRunService, error)

+ type Handler struct

+ Execute func(ctx context.Context, args *T) (string, error)

+ type JobData interface

+ JobType func() string

+ type JobTracer func(ctx context.Context, jobId string) (context.Context, ...)

+ type MarkIncompleteJobs struct

+ func (a MarkIncompleteJobs) JobType() string

+ type Option func(*options)

+ func DisableLogging() Option

+ func WithBatchFreq(freq time.Duration) Option

+ func WithBatchSize(size int) Option

+ func WithJobTimeout(jobTimeout time.Duration) Option

+ func WithJobTracing(tracer JobTracer) Option

+ type ProcessTriggers struct

+ func (a ProcessTriggers) JobType() string

+ type Trigger = triggers.Trigger

+ type Validateable interface

+ Validate func() error