core

package

v2.1.0 Latest Latest Go to latest Published: Oct 27, 2026 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/zerodha/dungbeetle

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Core
- func New(o Opt, srcDBs dbpool.Pool, res ResultBackends, lo *slog.Logger) *Core
type Opt
type ResultBackends
type Task
type Tasks

Constants ¶

View Source

const (
	StatusPending = "PENDING"
	StatusStarted = "STARTED"
	StatusFailure = "FAILURE"
	StatusSuccess = "SUCCESS"
	StatusRetry   = "RETRY"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Core ¶

type Core struct {
	// contains filtered or unexported fields
}

func New ¶

func New(o Opt, srcDBs dbpool.Pool, res ResultBackends, lo *slog.Logger) *Core

New returns a new instance of Core.

func (*Core) CancelJob ¶

func (co *Core) CancelJob(jobID string, purge bool) error

CancelJob cancels a given pending/processing job.

func (*Core) CancelJobGroup ¶

func (co *Core) CancelJobGroup(groupID string, purge bool) error

CancelJobGroup cancels a pending group job by individually cancelling all pending jobs in it.

func (*Core) GetJobGroupStatus ¶

func (co *Core) GetJobGroupStatus(groupID string) (models.GroupStatusResp, error)

GetJobGroupStatus returns the status of a job group including statuses of individual jobs in it.

func (*Core) GetJobStatus ¶

func (co *Core) GetJobStatus(jobID string) (models.JobStatusResp, error)

GetJobStatus returns the status of a job.

func (*Core) GetPendingJobs ¶

func (co *Core) GetPendingJobs(queue string) ([]tasqueue.JobMessage, error)

GetPendingJobs returns jobs pending execution.

func (*Core) GetTasks ¶

func (co *Core) GetTasks() Tasks

GetTasks returns the registered tasks map.

func (*Core) LoadTasks ¶

func (co *Core) LoadTasks(dirs []string) error

LoadTasks loads SQL queries from all the .sql files in a given directory.

func (*Core) Metrics ¶ added in v2.1.0

func (co *Core) Metrics() *metrics.Set

Metrics returns the core's Prometheus/VictoriaMetrics metrics set.

func (*Core) NewJob ¶

func (co *Core) NewJob(j models.JobReq, taskName string) (models.JobResp, error)

NewJob creates a new job out of a given task and registers it.

func (*Core) NewJobGroup ¶

func (co *Core) NewJobGroup(req models.GroupReq) (models.GroupResp, error)

func (*Core) Start ¶

func (co *Core) Start(ctx context.Context, workerName string, concurrency int) error

Start is a blocking function that spawns the queue workers and starts processing jobs. This should be invoked last after all other initializations are done.

type Opt ¶

type Opt struct {
	DefaultQueue            string
	DefaultGroupConcurrency int
	DefaultJobTTL           time.Duration

	// DSNs for connecting to the broker backend and the broker state backend.
	Broker  tasqueue.Broker
	Results tasqueue.Results
}

Opt represents core options.

type ResultBackends ¶

type ResultBackends map[string]models.ResultBackend

ResultBackends represents a map of result writing backends (sql DBs).

func (ResultBackends) Get ¶

func (r ResultBackends) Get(name string) models.ResultBackend

Get returns an *sql.DB from the DBs map by name.

func (ResultBackends) GetNames ¶

func (r ResultBackends) GetNames() []string

GetNames returns the list of available DB names.

func (ResultBackends) GetRandom ¶

func (r ResultBackends) GetRandom() (string, models.ResultBackend)

GetRandom returns a random results backend from the map.

type Task ¶

type Task struct {
	Name           string         `json:"name"`
	Queue          string         `json:"queue"`
	Conc           int            `json:"concurrency"`
	Raw            string         `json:"raw,omitempty"`
	DBs            dbpool.Pool    `json:"-"`
	ResultBackends ResultBackends `json:"-"`
}

Task represents an SQL query task.

type Tasks ¶

type Tasks map[string]Task

Tasks maps names to SQL query tasks.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL