rivercommon

package
v0.28.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 24, 2025 License: MPL-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// AllQueuesString is a special string that can be used to indicate all
	// queues in some operations, particularly pause and resume.
	AllQueuesString    = "*"
	MaxAttemptsDefault = 25
	PriorityDefault    = 1
	QueueDefault       = "default"
)

These constants are made available in rivercommon so that they're accessible by internal packages, but the top-level river package re-exports them, and all user code must use that set instead.

View Source
const (
	// MetadataKeyPeriodicJobID is a metadata key inserted with a periodic job
	// when a configured periodic job has its ID property set. This lets
	// inserted jobs easily be traced back to the periodic job that created
	// them.
	MetadataKeyPeriodicJobID = "river:periodic_job_id"

	// MetadataKeyRescueCount records how many times the job has been rescued.
	MetadataKeyRescueCount = "river:rescue_count"

	// MetadataKeyUniqueNonce is a special metadata key used by the SQLite driver to
	// determine whether an upsert is was skipped or not because the `(xmax != 0)`
	// trick we use in Postgres doesn't work in SQLite.
	MetadataKeyUniqueNonce = "river:unique_nonce"
)

Variables

View Source
var ErrStop = errors.New("stop initiated")

ErrStop is a special error injected by the client into its fetch and work CancelCauseFuncs when it's stopping. It may be used by components for such cases like avoiding logging an error during a normal shutdown procedure.

View Source
var UserSpecifiedIDOrKindRE = regexp.MustCompile(`\A[\w][\w\-\[\]<>\/.·:+]+\z`)

UserSpecifiedIDOrKindRE is a regular expression to which the format of job kinds and some other user-specified IDs (e.g. periodic job names) must comply. Mainly, minimal special characters, and excluding spaces and commas which are problematic for the search UI.

Functions

This section is empty.

Types

type ContextKeyClient added in v0.12.0

type ContextKeyClient struct{}

Jump to

Keyboard shortcuts

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