riverpro

type Client[TTx any] struct {
	*river.Client[TTx]
	// contains filtered or unexported fields
}

type Config struct {
	river.Config

	// SequenceSchedulerInterval is the amount of time to wait between runs of the sequence scheduler.
	SequenceSchedulerInterval time.Duration

	// WorkflowRescuerInterval is the amount of time to wait between runs of the workflow rescuer.
	WorkflowRescuerInterval time.Duration
}

type DependencyCycleError struct {
	DepStack []string
}

type DuplicateTaskError struct {
	TaskName string
}

type MissingDependencyError struct {
	ParentTaskName string
	TaskName       string
}

type SequenceOpts struct {
	// ByArgs indicates that the job's encoded arguments should be used to compute
	// a sequence key.
	//
	// Default is false, meaning that input arguments will not be considered for
	// sequencing.
	//
	// When set to true, the entire encoded args field will be included in the
	// sequence hash, which requires care to ensure that no irrelevant args are
	// factored into the sequence key. It is also possible to use a subset of
	// the args by indicating on the `JobArgs` struct which fields should be
	// included in the sequence using struct tags:
	//
	//  type MyJobArgs struct {
	//   CustomerID string `json:"customer_id" river:"sequence"`
	//   TraceID string `json:"trace_id"
	//  }
	//
	// In this example, only the encoded `customer_id` key will be included in the
	// sequence key and the `trace_id` key will be ignored.
	//
	// All keys are sorted alphabetically before hashing to ensure consistent
	// results.
	ByArgs bool

	// ByQueue indicates that sequences should be partitioned by queue.
	//
	// Default is false, meaning that as long as any other sequence property is
	// enabled, sequences will be constructed for a kind across all queues.
	ByQueue bool

	// ContinueOnCancelled indicates that the sequence should continue to be
	// processed even if the job is cancelled. Without this setting, the sequence
	// will be halted if any job in the sequence is cancelled.
	ContinueOnCancelled bool

	// ContinueOnDiscarded indicates that the sequence should continue to be
	// processed even if the job repeatedly errors and is discarded. Without this
	// setting, the sequence will be halted if any job in the sequence is
	// discarded.
	ContinueOnDiscarded bool

	// ExcludeKind indicates that the job kind should not be included in the
	// sequence partition key. This is useful when you want to include multiple
	// job kinds in the same sequence.
	ExcludeKind bool
}

type Workflow struct {/* contains filtered or unexported fields */}

type WorkflowCancelResult struct {
	CancelledJobs []*rivertype.JobRow
}

type WorkflowOpts struct {
	ID                  string
	IgnoreCancelledDeps bool
	IgnoreDeletedDeps   bool
	IgnoreDiscardedDeps bool
	Name                string
}

type WorkflowPrepareResult struct {
	// Jobs is a list of jobs to insert into the database. It's structured as a
	// list of InsertManyParams so the jobs can be inserted with InsertMany.
	Jobs []river.InsertManyParams
}

type WorkflowTask struct {
	// Name is the name of the workflow task.
	Name string
}

type WorkflowTaskOpts struct {
	// Deps are the names of other tasks in the workflow that this task depends
	// on. If any of the dependencies are cancelled, deleted, or discarded after
	// failing repeatedly, the task will be cancelled.
	Deps []string
	// IgnoreCancelledDeps specifies whether to ignore cancelled dependencies,
	// instead treating them as if they had completed successfully.
	//
	// If specified, this overrides the IgnoreCancelledDeps option specified in
	// the workflow.
	IgnoreCancelledDeps *bool
	// IgnoreDeletedDeps specifies whether to ignore deleted dependencies,
	// instead treating them as if they had completed successfully.
	//
	// If specified, this overrides the IgnoreDeletedDeps option specified in
	// the workflow.
	IgnoreDeletedDeps *bool
	// IgnoreDiscardedDeps specifies whether to ignore discarded dependencies,
	// instead treating them as if they had completed successfully.
	//
	// If specified, this overrides the IgnoreDiscardedDeps option specified in
	// the workflow.
	IgnoreDiscardedDeps *bool
}