driver

package

Go to main page

Versions in this module

v0

v0.12.0

Nov 4, 2026

Changes in this version

type AttemptLog

+ Interrupted bool

type ClientRow

+ Leader bool

type Executor

+ LeaderRequestResign func(ctx context.Context, leaderID int64) (int64, error)

type JobFinalize

+ GiveBack bool

+ type LeaderResult struct

+ ElectedAt time.Time

+ Leader bool

+ ResignRequested bool

v0.11.0

Nov 2, 2026

Changes in this version

type JobDependency

+ AnyOf int

type JobEdge

+ AnyOf int

type JobFinalized

+ Cascaded bool

type WorkflowPromoteResult

+ Canceled int64

v0.10.2

Oct 31, 2026

Changes in this version

+ var ErrRowsHeld = errors.New("hopper: another transaction holds a row the statement reaches")

type JobFinalizeParams

+ BriefWait bool

v0.10.1

Oct 29, 2026

v0.10.0

Oct 29, 2026

Changes in this version

type BatchSettleParams

+ Results bool

+ type Dependency struct

+ ID JobID

+ Output json.RawMessage

+ State JobState

+ Step string

type JobDependency

+ Reads bool

type JobRow

+ Dependencies []Dependency

+ func (r *JobRow) Dependency(step string) (Dependency, bool)

type WorkflowInsertParams

+ Steps []string

type WorkflowRow

+ Steps map[JobID]string

v0.9.0

Oct 28, 2026

Changes in this version

+ var ErrJobFenced = errors.New("hopper: job is no longer running in this attempt")

+ var ErrJobNotClaimable = errors.New("hopper: job is not claimable")

type AttemptError

+ Rescue RescueReason

type Executor

+ JobClaimByID func(ctx context.Context, params JobClaimByIDParams) (*JobLeaseRow, error)

+ JobExpireLeases func(ctx context.Context, params JobExpireLeasesParams) ([]*JobRow, error)

+ JobLeaseRenew func(ctx context.Context, params JobLeaseRenewParams) (*JobLeaseStatus, error)

+ PeriodicRegister func(ctx context.Context, params PeriodicRegisterParams) error

+ PeriodicRegistrations func(ctx context.Context) ([]PeriodicRegistrationRow, error)

+ type JobClaimByIDParams struct

+ Fence int64

+ ID JobID

+ TTL time.Duration

+ type JobExpireLeasesParams struct

+ ClientID int64

+ Grace time.Duration

+ Limit int

type JobFinalize

+ Lease *LeaseFence

+ type JobFinalized struct

+ Fence int64

+ ID JobID

+ type JobLeaseRenewParams struct

+ ID JobID

+ Lease LeaseFence

+ type JobLeaseRow struct

+ ExpiresAt time.Time

+ Job *JobRow

+ Lease LeaseFence

+ type JobLeaseStatus struct

+ CancelRequested bool

+ ExpiresAt time.Time

type JobRecordProgressParams

+ Lease *LeaseFence

type JobRow

+ LeaseExpiresAt time.Time

+ type LeaseFence struct

+ Fence int64

+ Token JobID

+ type PeriodicRegisterParams struct

+ ClientID int64

+ Registrations []PeriodicRegistration

+ type PeriodicRegistration struct

+ Definition json.RawMessage

+ Digest string

+ Name string

+ type PeriodicRegistrationRow struct

+ ClientID int64

+ ClientStartedAt time.Time

+ type RescueReason string

+ const RescueClientLost

+ const RescueLeaseExpired

+ const RescueStuck

v0.8.0

Oct 26, 2026

Changes in this version

+ var ErrHistoryIndexRepair = errors.New("hopper: repair history index")

+ var ErrInvalidFilter = errors.New("hopper: invalid job filter")

+ var ErrJobLocked = errors.New("hopper: another transaction holds the job's row")

+ func Owner(ctx context.Context) fmt.Stringer

+ func WithOwner(ctx context.Context, owner fmt.Stringer) context.Context

type AttemptError

+ Fence int64

+ type AttemptLog struct

+ Attempt int

+ Log string

+ Snoozed bool

type Capabilities

+ SingleWriter bool

type Executor

+ JobDelete func(ctx context.Context, id JobID) (*JobRow, error)

+ JobLogs func(ctx context.Context, id JobID) ([]AttemptLog, error)

+ JobRecordProgress func(ctx context.Context, params JobRecordProgressParams) (*Progress, error)

type HistoryIndexParams

+ LockTimeout time.Duration

+ SkipRepair []string

type HistoryIndexResult

+ Busy string

+ Deferred []string

+ Invalid []string

type HistoryMaintainResult

+ Kept []string

type JobFinalize

+ Fence int64

+ Log *AttemptLog

+ func (f JobFinalize) Archived() bool

+ func (f JobFinalize) KeepsLog() bool

type JobFinalizeParams

+ KeepLogs int

type JobInsertParams

+ Tags []string

+ UniqueFinished []JobState

type JobListParams

+ IDs []JobID

+ Metadata json.RawMessage

+ Priorities []int

+ TagsAll []string

+ TagsAny []string

+ type JobRecordProgressParams struct

+ Attempt int

+ AttemptedBy int64

+ Cursor json.RawMessage

+ Fence int64

+ ID JobID

+ KeepStep bool

+ NoWait bool

+ Step string

+ type JobRetryParams struct

+ FromStart bool

+ ID JobID

type JobRow

+ Fence int64

+ Progress *Progress

+ Tags []string

+ type MigrationScripts interface

+ Script func(version int, up bool) (string, error)

+ type Progress struct

+ Cursor json.RawMessage

+ RecordedAt time.Time

+ Step string

+ type RescueCandidate struct

+ Job *JobRow

+ Stuck bool

v0.7.0

Oct 14, 2026

Changes in this version

+ type BatchSettleParams struct

+ After JobID

+ IDs []JobID

+ Limit int

+ type BatchSettleResult struct

+ Completed int64

+ Folded int64

+ Last JobID

type Executor

+ BatchSettle func(ctx context.Context, params BatchSettleParams) (BatchSettleResult, error)

+ HistoryIndex func(ctx context.Context, params HistoryIndexParams) (HistoryIndexResult, error)

+ JobRetryOrderingKey func(ctx context.Context, params JobRetryOrderingKeyParams) (int, error)

+ WorkflowPromoteReady func(ctx context.Context, params WorkflowPromoteParams) (WorkflowPromoteResult, error)

+ type HistoryIndexParams struct

+ Skip []string

+ type HistoryIndexResult struct

+ TimedOut []string

type HistoryMaintainParams

+ LockTimeout time.Duration

type HistoryMaintainResult

+ Deferred []string

type JobFinalizeParams

+ NoBatches bool

+ SkipLocked bool

type JobListParams

+ NewestFirst bool

+ OrderingKey string

+ type JobRetryOrderingKeyParams struct

+ Limit int

+ OrderingKey string

+ Queue string

type JobState

+ const JobStateCanceled

+ type WorkflowPromoteParams struct

+ After JobID

+ DependsOn []JobID

+ Limit int

+ type WorkflowPromoteResult struct

+ Last JobID

+ Promoted int64

+ Scanned int64

v0.6.0

Oct 13, 2026

Changes in this version

type Executor

+ SchemaVersion func(ctx context.Context) (int, error)

type JobFinalize

+ SnoozeReason string

type JobRow

+ SnoozeReason string

v0.5.0

Oct 3, 2026

v0.4.0

Oct 2, 2026

v0.3.1

Oct 2, 2026

v0.3.0

Oct 1, 2026

v0.2.0

Oct 1, 2026

v0.1.2

Oct 1, 2026

v0.1.1

Sep 29, 2026

v0.1.0

Sep 29, 2026

Changes in this version

+ const ChannelControl

+ const ChannelDone

+ const ChannelInsert

+ const ChannelLeader

+ const ChannelStream

+ var ErrJobRunning = errors.New("hopper: job is running")

+ var ErrNotFound = errors.New("hopper: not found")

+ var ErrNotSupported = errors.New("hopper: not supported by this driver")

+ var ErrUniqueConflict = errors.New("hopper: a live job with the same unique key exists")

+ type AttemptError struct

+ At time.Time

+ Attempt int

+ Error string

+ Trace string

+ type BatchInsertParams struct

+ Metadata json.RawMessage

+ OnComplete *JobInsertParams

+ OnFailure *JobInsertParams

+ OnSuccess *JobInsertParams

+ Total int

+ type BatchRow struct

+ CompletedAt time.Time

+ CreatedAt time.Time

+ Failed int

+ ID JobID

+ Metadata json.RawMessage

+ Name string

+ Pending int

+ Total int

+ type Capabilities struct

+ Copy bool

+ Listen bool

+ type ClientRegisterParams struct

+ Hostname string

+ Info json.RawMessage

+ TTL time.Duration

+ type ClientRenewParams struct

+ ClientID int64

+ TTL time.Duration

+ type ClientRenewResult struct

+ CancelRequested []JobID

+ LimitedQueues []string

+ PausedQueues []string

+ Renewed bool

+ type ClientRow struct

+ ExpiresAt time.Time

+ Hostname string

+ ID int64

+ Info json.RawMessage

+ StartedAt time.Time

+ type ConflictAction int

+ const ConflictReplace

+ const ConflictSkip

+ type DependencyFailure string

+ const DependencyCancel

+ const DependencyIgnore

+ type Driver interface

+ Capabilities func() Capabilities

+ Executor func() Executor

+ Listener func(ctx context.Context) (Listener, error)

+ Migrator func() Migrator

+ UnwrapTx func(tx TTx) Executor

+ type Executor interface

+ BatchGet func(ctx context.Context, id JobID) (*BatchRow, error)

+ BatchInsert func(ctx context.Context, params BatchInsertParams) (JobID, error)

+ ClientDelete func(ctx context.Context, clientID int64) error

+ ClientList func(ctx context.Context) ([]*ClientRow, error)

+ ClientPruneExpired func(ctx context.Context) (int64, error)

+ ClientRegister func(ctx context.Context, params ClientRegisterParams) (int64, error)

+ ClientRenew func(ctx context.Context, params ClientRenewParams) (ClientRenewResult, error)

+ HistoryMaintain func(ctx context.Context, params HistoryMaintainParams) (HistoryMaintainResult, error)

+ JobAge func(ctx context.Context, queue string, after time.Duration) (int64, error)

+ JobCancel func(ctx context.Context, id JobID) (*JobRow, error)

+ JobClaim func(ctx context.Context, params JobClaimParams) (JobClaimResult, error)

+ JobDiscardExpired func(ctx context.Context, limit int) ([]*JobRow, error)

+ JobFinalizeMany func(ctx context.Context, params JobFinalizeParams) ([]JobID, error)

+ JobGet func(ctx context.Context, id JobID) (*JobRow, error)

+ JobInsertCopy func(ctx context.Context, params []JobInsertParams, opts JobInsertOpts) ([]JobInsertResult, error)

+ JobInsertMany func(ctx context.Context, params []JobInsertParams, opts JobInsertOpts) ([]JobInsertResult, error)

+ JobList func(ctx context.Context, params JobListParams) ([]*JobRow, error)

+ JobRescueCandidates func(ctx context.Context, params JobRescueParams) ([]*JobRow, error)

+ JobRetry func(ctx context.Context, id JobID) (*JobRow, error)

+ JobsMaintain func(ctx context.Context) (JobsMaintainResult, error)

+ LeaderAttempt func(ctx context.Context, params LeaderParams) (bool, error)

+ LeaderResign func(ctx context.Context, clientID int64) error

+ MessagePublish func(ctx context.Context, params MessagePublishParams) ([]JobInsertResult, error)

+ Notify func(ctx context.Context, channel string, payloads []string) error

+ Now func(ctx context.Context) (time.Time, error)

+ PeriodicInsert func(ctx context.Context, params PeriodicInsertParams) (*JobRow, bool, error)

+ PeriodicLastSlots func(ctx context.Context) (map[string]time.Time, error)

+ QueueEnsure func(ctx context.Context, names []string) error

+ QueueList func(ctx context.Context) ([]*QueueRow, error)

+ QueuePause func(ctx context.Context, name string) error

+ QueueResume func(ctx context.Context, name string) error

+ QueueSetLimits func(ctx context.Context, limits QueueLimits) error

+ Stats func(ctx context.Context) (*Stats, error)

+ StreamAppend func(ctx context.Context, params StreamAppendParams) (*StreamEvent, error)

+ StreamConsumerList func(ctx context.Context) ([]*StreamConsumerRow, error)

+ StreamConsumerSeek func(ctx context.Context, name string, params StreamSeekParams) error

+ StreamConsumerUpsert func(ctx context.Context, consumers []StreamConsumerRow) error

+ StreamPump func(ctx context.Context, name string, limit int) (StreamPumpResult, error)

+ StreamRead func(ctx context.Context, params StreamReadParams) ([]*StreamEvent, error)

+ SubscriptionList func(ctx context.Context) ([]*SubscriptionRow, error)

+ SubscriptionUpsert func(ctx context.Context, subs []SubscriptionRow) error

+ WorkflowGet func(ctx context.Context, id JobID) (*WorkflowRow, error)

+ WorkflowInsert func(ctx context.Context, params WorkflowInsertParams) (*WorkflowInsertResult, error)

+ type HistoryMaintainParams struct

+ CompletedRetention time.Duration

+ FailedRetention time.Duration

+ StreamRetention time.Duration

+ type HistoryMaintainResult struct

+ Created []string

+ Dropped []string

+ Pruned int64

+ type JobClaimParams struct

+ ClientID int64

+ Limit int

+ Limited bool

+ Queue string

+ type JobClaimResult struct

+ Jobs []*JobRow

+ Wait time.Duration

+ type JobDependency struct

+ DependsOn int

+ Job int

+ OnFailure DependencyFailure

+ type JobEdge struct

+ DependsOn JobID

+ Job JobID

+ type JobFinalize struct

+ Archive bool

+ AttemptedBy int64

+ Delay time.Duration

+ Error *AttemptError

+ ID JobID

+ Output json.RawMessage

+ Snooze bool

+ State JobState

+ type JobFinalizeParams struct

+ Jobs []JobFinalize

+ type JobID [16]byte

+ func ParseJobID(s string) (JobID, error)

+ func (id *JobID) Scan(src any) error

+ func (id *JobID) UnmarshalText(text []byte) error

+ func (id JobID) IsZero() bool

+ func (id JobID) MarshalText() ([]byte, error)

+ func (id JobID) String() string

+ func (id JobID) Value() (driver.Value, error)

+ type JobInsertOpts struct

+ Notify bool

+ OnConflict ConflictAction

+ type JobInsertParams struct

+ Args json.RawMessage

+ Await bool

+ BatchID JobID

+ Kind string

+ MaxAttempts int

+ Metadata json.RawMessage

+ OrderingKey string

+ PartitionKey string

+ Priority int

+ Queue string

+ ScheduledAt time.Time

+ TTL time.Duration

+ UniqueKey string

+ type JobInsertResult struct

+ Duplicate bool

+ Job *JobRow

+ type JobListParams struct

+ After JobID

+ Kinds []string

+ Limit int

+ Queue string

+ States []JobState

+ type JobRescueParams struct

+ Limit int

+ StuckAfter time.Duration

+ type JobRow struct

+ Args json.RawMessage

+ Attempt int

+ AttemptedAt time.Time

+ AttemptedBy int64

+ Await bool

+ BatchID JobID

+ CancelRequestedAt time.Time

+ CreatedAt time.Time

+ Errors []AttemptError

+ ExpiresAt time.Time

+ FinalizedAt time.Time

+ ID JobID

+ Kind string

+ MaxAttempts int

+ Metadata json.RawMessage

+ OrderingKey string

+ Output json.RawMessage

+ PartitionKey string

+ Priority int

+ Queue string

+ ScheduledAt time.Time

+ State JobState

+ UniqueKey string

+ type JobState string

+ const JobStateAvailable

+ const JobStateCancelled

+ const JobStateCompleted

+ const JobStateDiscarded

+ const JobStatePending

+ const JobStateRetryable

+ const JobStateRunning

+ const JobStateScheduled

+ func (s JobState) Terminal() bool

+ type JobsMaintainResult struct

+ Analyzed bool

+ Vacuumed bool

+ type LeaderParams struct

+ ClientID int64

+ TTL time.Duration

+ type Listener interface

+ Close func(ctx context.Context) error

+ Listen func(ctx context.Context, channels ...string) error

+ Next func(ctx context.Context) (Notification, error)

+ type MessagePublishParams struct

+ Await bool

+ DedupKey string

+ Delay time.Duration

+ Headers map[string]string

+ Notify bool

+ OrderingKey string

+ Payload json.RawMessage

+ Priority int

+ TTL time.Duration

+ Topic string

+ type MigrationExecutor interface

+ Apply func(ctx context.Context, version int, script string, up bool) error

+ Close func(ctx context.Context) error

+ Versions func(ctx context.Context) ([]int, error)

+ type Migrator interface

+ Lock func(ctx context.Context) (MigrationExecutor, error)

+ type Notification struct

+ Channel string

+ Payload string

+ type PeriodicInsertParams struct

+ Job JobInsertParams

+ Name string

+ Slot time.Time

+ type QueueLimits struct

+ Aging time.Duration

+ GlobalLimit int

+ Name string

+ PartitionLimit int

+ RateBurst int

+ RatePerSec float64

+ func (l QueueLimits) Limited() bool

+ type QueueRow struct

+ Limits QueueLimits

+ Name string

+ PausedAt time.Time

+ UpdatedAt time.Time

+ type QueueStats struct

+ Available int

+ CompletedLastMinute int

+ OldestAvailable time.Duration

+ Paused bool

+ Retryable int

+ Running int

+ Scheduled int

+ type Stats struct

+ Leader int64

+ LiveClients int

+ Queues map[string]*QueueStats

+ RunningByClient map[int64]int

+ type StreamAppendParams struct

+ Headers map[string]string

+ Key string

+ Notify bool

+ Payload json.RawMessage

+ Topic string

+ type StreamConsumerRow struct

+ CreatedAt time.Time

+ DeliveredAt time.Time

+ Kind string

+ MaxAttempts int

+ Metadata json.RawMessage

+ Name string

+ Pattern string

+ Position StreamPosition

+ Queue string

+ Snapshot string

+ Start StreamStart

+ type StreamEvent struct

+ CreatedAt time.Time

+ Headers map[string]string

+ Key string

+ MessageID string

+ Payload json.RawMessage

+ Position StreamPosition

+ Topic string

+ type StreamPosition struct

+ Seq int64

+ Xid uint64

+ func ParseStreamPosition(s string) (StreamPosition, error)

+ func (p StreamPosition) IsZero() bool

+ func (p StreamPosition) Less(q StreamPosition) bool

+ func (p StreamPosition) String() string

+ type StreamPumpResult struct

+ Delivered int

+ Position StreamPosition

+ Queues []string

+ type StreamReadParams struct

+ After StreamPosition

+ Limit int

+ Pattern string

+ type StreamSeekParams struct

+ Earliest bool

+ Latest bool

+ Position StreamPosition

+ Time time.Time

+ type StreamStart string

+ const StreamStartEarliest

+ const StreamStartLatest

+ type SubscriptionRow struct

+ CreatedAt time.Time

+ Kind string

+ MaxAttempts int

+ Metadata json.RawMessage

+ Name string

+ Pattern string

+ Queue string

+ type WorkflowInsertParams struct

+ Deps []JobDependency

+ Jobs []JobInsertParams

+ Metadata json.RawMessage

+ Name string

+ Notify bool

+ OnComplete *JobInsertParams

+ OnFailure *JobInsertParams

+ OnSuccess *JobInsertParams

+ type WorkflowInsertResult struct

+ ID JobID

+ Jobs []JobInsertResult

+ type WorkflowRow struct

+ Batch BatchRow

+ Edges []JobEdge

+ Jobs []*JobRow

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