River

riverworkflow

package
v0.19.0 Latest
Published: Oct 8, 2025 License: Proprietary

Package riverworkflow provides workflow helpers for River Pro's workflow engine.

Most of the core workflow functionality is exposed through the [riverpro.Workflow] type and in the [riverpro] package. See homepage and docs.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DepsFromJobRow

func DepsFromJobRow(job *rivertype.JobRow) []string

DepsFromJobRow extracts the dependency task names from a job row.

func DepsFromMetadata

func DepsFromMetadata(metadata []byte) []string

DepsFromMetadata extracts the dependency task names directly from a job's metadata.

func IDFromJobRow

func IDFromJobRow(job *rivertype.JobRow) string

IDFromJobRow extracts the workflow ID from a job row.

func IDFromMetadata

func IDFromMetadata(metadata []byte) string

IDFromMetadata extracts the workflow ID directly from a job's metadata.

func JobListParams

func JobListParams(job *rivertype.JobRow, params *river.JobListParams) (*river.JobListParams, error)

JobListParams extracts the workflow ID from a job row and returns a river.JobListParams with the workflow ID set in order to filter the job list by workflow.

func JobListParamsByID

func JobListParamsByID(workflowID string, params *river.JobListParams) (*river.JobListParams, error)

JobListParamsByID returns a river.JobListParams with the workflow ID set in order to filter the job list by workflow.

func NameFromJobRow

func NameFromJobRow(job *rivertype.JobRow) string

NameFromJobRow extracts the workflow's name from a job row.

func NameFromMetadata

func NameFromMetadata(metadata []byte) string

NameFromMetadata extracts the workflow's name directly from a job's metadata.

func TaskFromJobRow

func TaskFromJobRow(job *rivertype.JobRow) string

TaskFromJobRow extracts the workflow task's name from a job row.

func TaskFromMetadata

func TaskFromMetadata(metadata []byte) string

TaskFromMetadata extracts the workflow task's name directly from a job's metadata.

Types

This section is empty.