riverdriver

package module

Go to main page

Versions in this module

v0

v0.29.0

Dec 22, 2025

Changes in this version

type Executor

+ JobUpdateFull func(ctx context.Context, params *JobUpdateFullParams) (*rivertype.JobRow, error)

+ type JobUpdateFullParams struct

+ Attempt int

+ AttemptDoUpdate bool

+ AttemptedAt *time.Time

+ AttemptedAtDoUpdate bool

+ AttemptedBy []string

+ AttemptedByDoUpdate bool

+ Errors [][]byte

+ ErrorsDoUpdate bool

+ FinalizedAt *time.Time

+ FinalizedAtDoUpdate bool

+ ID int64

+ MaxAttempts int

+ MaxAttemptsDoUpdate bool

+ Metadata []byte

+ MetadataDoUpdate bool

+ Schema string

+ State rivertype.JobState

+ StateDoUpdate bool

+ UniqueKey []byte

+ UniqueKeyDoUpdate bool

type JobUpdateParams

+ MetadataDoMerge bool

v0.29.0-rc.1

Dec 4, 2025

v0.28.0

Nov 24, 2025

v0.27.1

Nov 21, 2025

v0.27.0

Nov 17, 2025

v0.26.0

Oct 8, 2025

v0.25.0

Sep 15, 2025

Changes in this version

type JobSetStateIfRunningParams

+ Snoozed bool

type JobUpdateParams

+ MaxAttempts int

+ MaxAttemptsDoUpdate bool

+ Metadata []byte

+ MetadataDoUpdate bool

v0.24.0

Aug 16, 2025

Changes in this version

type Executor

+ IndexesExist func(ctx context.Context, params *IndexesExistParams) (map[string]bool, error)

+ JobCountByAllStates func(ctx context.Context, params *JobCountByAllStatesParams) (map[rivertype.JobState]int, error)

+ JobCountByQueueAndState func(ctx context.Context, params *JobCountByQueueAndStateParams) ([]*JobCountByQueueAndStateResult, error)

+ JobDeleteMany func(ctx context.Context, params *JobDeleteManyParams) ([]*rivertype.JobRow, error)

+ JobKindList func(ctx context.Context, params *JobKindListParams) ([]string, error)

+ QueueNameList func(ctx context.Context, params *QueueNameListParams) ([]string, error)

+ type IndexesExistParams struct

+ IndexNames []string

+ Schema string

+ type JobCountByAllStatesParams struct

+ Schema string

+ type JobCountByQueueAndStateParams struct

+ QueueNames []string

+ Schema string

+ type JobCountByQueueAndStateResult struct

+ CountAvailable int64

+ CountRunning int64

+ Queue string

type JobDeleteBeforeParams

+ CancelledDoDelete bool

+ CompletedDoDelete bool

+ DiscardedDoDelete bool

+ QueuesExcluded []string

+ QueuesIncluded []string

+ type JobDeleteManyParams struct

+ Max int32

+ NamedArgs map[string]any

+ OrderByClause string

+ Schema string

+ WhereClause string

type JobGetAvailableParams

+ MaxAttemptedBy int

+ MaxToLock int

type JobInsertFastParams

+ ID *int64

+ type JobKindListParams struct

+ After string

+ Exclude []string

+ Match string

+ Max int

+ Schema string

type QueueListParams

+ Max int

+ type QueueNameListParams struct

+ After string

+ Exclude []string

+ Match string

+ Max int

+ Schema string

v0.23.1

Jun 4, 2025

v0.23.0

Jun 4, 2025

Changes in this version

+ func MigrationLineMainTruncateTables(version int) []string

type Driver

+ ArgPlaceholder func() string

+ DatabaseName func() string

+ PoolIsSet func() bool

+ PoolSet func(dbPool any) error

+ SQLFragmentColumnIn func(column string, values any) (string, any, error)

+ SupportsListenNotify func() bool

+ TimePrecision func() time.Duration

type Executor

+ IndexDropIfExists func(ctx context.Context, params *IndexDropIfExistsParams) error

+ IndexExists func(ctx context.Context, params *IndexExistsParams) (bool, error)

+ IndexReindex func(ctx context.Context, params *IndexReindexParams) error

+ JobInsertFullMany func(ctx context.Context, jobs *JobInsertFullManyParams) ([]*rivertype.JobRow, error)

+ SchemaCreate func(ctx context.Context, params *SchemaCreateParams) error

+ SchemaDrop func(ctx context.Context, params *SchemaDropParams) error

+ TableTruncate func(ctx context.Context, params *TableTruncateParams) error

+ type IndexDropIfExistsParams struct

+ Index string

+ Schema string

+ type IndexExistsParams struct

+ Index string

+ Schema string

+ type IndexReindexParams struct

+ Index string

+ Schema string

type JobCancelParams

+ Now *time.Time

+ type JobInsertFullManyParams struct

+ Jobs []*JobInsertFullParams

+ Schema string

type JobRetryParams

+ Now *time.Time

type JobSetStateIfRunningManyParams

+ Now *time.Time

type QueuePauseParams

+ Now *time.Time

type QueueResumeParams

+ Now *time.Time

+ type SchemaCreateParams struct

+ Schema string

+ type SchemaDropParams struct

+ Schema string

+ type TableTruncateParams struct

+ Schema string

+ Table []string

v0.22.0

May 10, 2025

v0.21.0

May 3, 2025

Changes in this version

+ type ColumnExistsParams struct

+ Column string

+ Schema string

+ Table string

type Driver

+ GetMigrationDefaultLines func() []string

+ GetMigrationTruncateTables func(line string) []string

type Executor

+ QueryRow func(ctx context.Context, sql string, args ...any) Row

+ SchemaGetExpired func(ctx context.Context, params *SchemaGetExpiredParams) ([]string, error)

+ type GetListenenerParams struct

+ Schema string

type JobCancelParams

+ Schema string

+ type JobCountByStateParams struct

+ Schema string

+ State rivertype.JobState

type JobDeleteBeforeParams

+ Schema string

+ type JobDeleteParams struct

+ ID int64

+ Schema string

type JobGetAvailableParams

+ Schema string

+ type JobGetByIDManyParams struct

+ ID []int64

+ Schema string

+ type JobGetByIDParams struct

+ ID int64

+ Schema string

+ type JobGetByKindManyParams struct

+ Kind []string

+ Schema string

type JobGetStuckParams

+ Schema string

+ type JobInsertFastManyParams struct

+ Jobs []*JobInsertFastParams

+ Schema string

type JobInsertFullParams

+ Schema string

type JobListParams

+ Schema string

type JobRescueManyParams

+ Schema string

+ type JobRetryParams struct

+ ID int64

+ Schema string

type JobScheduleParams

+ Schema string

type JobSetStateIfRunningManyParams

+ Schema string

type JobSetStateIfRunningParams

+ Schema string

type JobUpdateParams

+ Schema string

+ type LeaderDeleteExpiredParams struct

+ Now *time.Time

+ Schema string

type LeaderElectParams

+ Now *time.Time

+ Schema string

+ type LeaderGetElectedLeaderParams struct

+ Schema string

type LeaderInsertParams

+ Now *time.Time

+ Schema string

type LeaderResignParams

+ Schema string

type Listener

+ Schema func() string

+ SetAfterConnectExec func(sql string)

+ type MigrationDeleteAssumingMainManyParams struct

+ Schema string

+ Versions []int

+ type MigrationDeleteByLineAndVersionManyParams struct

+ Line string

+ Schema string

+ Versions []int

+ type MigrationGetAllAssumingMainParams struct

+ Schema string

+ type MigrationGetByLineParams struct

+ Line string

+ Schema string

+ type MigrationInsertManyAssumingMainParams struct

+ Schema string

+ Versions []int

+ type MigrationInsertManyParams struct

+ Line string

+ Schema string

+ Versions []int

type NotifyManyParams

+ Schema string

type ProducerKeepAliveParams

+ Schema string

type QueueCreateOrSetUpdatedAtParams

+ Now *time.Time

+ Schema string

type QueueDeleteExpiredParams

+ Schema string

+ type QueueGetParams struct

+ Name string

+ Schema string

+ type QueueListParams struct

+ Limit int

+ Schema string

+ type QueuePauseParams struct

+ Name string

+ Schema string

+ type QueueResumeParams struct

+ Name string

+ Schema string

type QueueUpdateParams

+ Schema string

+ type Row interface

+ Scan func(dest ...any) error

+ type Schema struct

+ Name string

+ type SchemaGetExpiredParams struct

+ BeforeName string

+ Prefix string

+ type TableExistsParams struct

+ Schema string

+ Table string

v0.20.2

Apr 9, 2025

v0.20.1

Apr 6, 2025

v0.20.0

Apr 4, 2025

Changes in this version

+ var ErrRetryTransaction = errors.New("expected transaction collision, retry required")

type Executor

+ QueueUpdate func(ctx context.Context, params *QueueUpdateParams) (*rivertype.Queue, error)

type JobGetAvailableParams

+ ClientID string

+ ProducerID int64

+ type ProducerKeepAliveParams struct

+ ID int64

+ QueueName string

+ StaleUpdatedAtHorizon time.Time

+ type QueueUpdateParams struct

+ Metadata []byte

+ MetadataDoUpdate bool

+ Name string

v0.19.0

Mar 17, 2025

Changes in this version

+ type JobListParams struct

+ Max int32

+ NamedArgs map[string]any

+ OrderByClause string

+ WhereClause string

v0.18.0

Feb 20, 2025

Changes in this version

type JobSetStateIfRunningManyParams

+ MetadataDoMerge []bool

+ MetadataUpdates [][]byte

type JobSetStateIfRunningParams

+ MetadataDoMerge bool

+ MetadataUpdates []byte

type JobUpdateParams

+ AttemptedBy []string

+ AttemptedByDoUpdate bool

v0.17.0

Feb 15, 2025

Changes in this version

type JobInsertFullParams

+ AttemptedBy []string

type JobSetStateIfRunningManyParams

+ Attempt []*int

+ SnoozeDoIncrement []bool

type JobSetStateIfRunningParams

+ Attempt *int

+ SnoozeDoIncrement bool

v0.15.0

Dec 27, 2024

v0.14.3

Dec 15, 2024

v0.14.2

Nov 16, 2024

v0.14.1

Nov 4, 2024

v0.14.0

Nov 3, 2024

v0.13.0

Oct 8, 2024

Changes in this version

type JobGetAvailableParams

+ Now *time.Time

v0.13.0-rc.1

Oct 5, 2024

v0.12.1

Sep 26, 2024

Changes in this version

type Executor

+ JobSetStateIfRunningMany func(ctx context.Context, params *JobSetStateIfRunningManyParams) ([]*rivertype.JobRow, error)

+ type JobSetStateIfRunningManyParams struct

+ ErrData [][]byte

+ FinalizedAt []*time.Time

+ ID []int64

+ MaxAttempts []*int

+ ScheduledAt []*time.Time

+ State []rivertype.JobState

v0.12.0

Sep 23, 2024

Changes in this version

type Executor

+ JobInsertFastManyNoReturning func(ctx context.Context, params []*JobInsertFastParams) (int, error)

type JobInsertFastParams

+ Args rivertype.JobArgs

+ UniqueKey []byte

+ UniqueStates byte

+ type JobInsertFastResult struct

+ Job *rivertype.JobRow

+ UniqueSkippedAsDuplicate bool

type JobInsertFullParams

+ UniqueStates byte

type JobScheduleResult

+ ConflictDiscarded bool

+ Job rivertype.JobRow

v0.12.0-rc.1

Sep 22, 2024

v0.11.4

Aug 20, 2024

v0.11.3

Aug 19, 2024

v0.11.2

Aug 9, 2024

v0.11.1

Aug 6, 2024

v0.11.0

Aug 3, 2024

v0.10.2

Aug 1, 2024

v0.10.1

Jul 24, 2024

v0.10.0

Jul 19, 2024

Changes in this version

+ const MigrationLineMain

type Driver

+ GetMigrationFS func(line string) fs.FS

+ GetMigrationLines func() []string

+ SupportsListener func() bool

type Executor

+ ColumnExists func(ctx context.Context, tableName, columnName string) (bool, error)

+ JobInsertUnique func(ctx context.Context, params *JobInsertUniqueParams) (*JobInsertUniqueResult, error)

+ MigrationDeleteAssumingMainMany func(ctx context.Context, versions []int) ([]*Migration, error)

+ MigrationDeleteByLineAndVersionMany func(ctx context.Context, line string, versions []int) ([]*Migration, error)

+ MigrationGetAllAssumingMain func(ctx context.Context) ([]*Migration, error)

+ MigrationGetByLine func(ctx context.Context, line string) ([]*Migration, error)

+ MigrationInsertManyAssumingMain func(ctx context.Context, versions []int) ([]*Migration, error)

type JobInsertFullParams

+ UniqueKey []byte

+ type JobInsertUniqueParams struct

+ UniqueKey []byte

+ type JobInsertUniqueResult struct

+ Job *rivertype.JobRow

+ UniqueSkippedAsDuplicate bool

type JobUpdateParams

+ UniqueKey []byte

+ UniqueKeyDoUpdate bool

type Migration

+ Line string

v0.9.0

Jul 4, 2024

Changes in this version

+ const AllQueuesString

v0.8.0

Jun 26, 2024

Changes in this version

type JobInsertFastParams

+ CreatedAt *time.Time

v0.7.0

Jun 14, 2024

Changes in this version

type Executor

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

v0.6.1

May 21, 2024

v0.6.0

May 9, 2024

v0.5.0

May 3, 2024

Changes in this version

type Executor

+ NotifyMany func(ctx context.Context, params *NotifyManyParams) error

+ QueueCreateOrSetUpdatedAt func(ctx context.Context, params *QueueCreateOrSetUpdatedAtParams) (*rivertype.Queue, error)

+ QueueDeleteExpired func(ctx context.Context, params *QueueDeleteExpiredParams) ([]string, error)

+ QueueGet func(ctx context.Context, name string) (*rivertype.Queue, error)

+ QueueList func(ctx context.Context, limit int) ([]*rivertype.Queue, error)

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

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

type JobCancelParams

+ ControlTopic string

+ type JobScheduleResult struct

+ Queue string

+ ScheduledAt time.Time

+ type NotifyManyParams struct

+ Payload []string

+ Topic string

+ type QueueCreateOrSetUpdatedAtParams struct

+ Metadata []byte

+ Name string

+ PausedAt *time.Time

+ UpdatedAt *time.Time

+ type QueueDeleteExpiredParams struct

+ Max int

+ UpdatedAtHorizon time.Time

v0.4.1

Apr 23, 2024

v0.4.0

Apr 21, 2024

v0.3.0

Apr 16, 2024

v0.2.0

Mar 29, 2024

v0.1.0

Mar 17, 2024

Changes in this version

+ var ErrClosedPool = errors.New("underlying driver pool is closed")

type Executor

+ JobCountByState func(ctx context.Context, state rivertype.JobState) (int, error)

+ JobSetCompleteIfRunningMany func(ctx context.Context, params *JobSetCompleteIfRunningManyParams) ([]*rivertype.JobRow, error)

+ type JobSetCompleteIfRunningManyParams struct

+ FinalizedAt []time.Time

+ ID []int64

v0.0.25

Mar 2, 2024

v0.0.24

Mar 1, 2024

v0.0.23

Feb 29, 2024

Changes in this version

type Driver

+ GetListener func() Listener

+ HasPool func() bool

type Executor

+ JobCancel func(ctx context.Context, params *JobCancelParams) (*rivertype.JobRow, error)

+ JobDeleteBefore func(ctx context.Context, params *JobDeleteBeforeParams) (int, error)

+ JobGetAvailable func(ctx context.Context, params *JobGetAvailableParams) ([]*rivertype.JobRow, error)

+ JobGetByID func(ctx context.Context, id int64) (*rivertype.JobRow, error)

+ JobGetByIDMany func(ctx context.Context, id []int64) ([]*rivertype.JobRow, error)

+ JobGetByKindAndUniqueProperties func(ctx context.Context, params *JobGetByKindAndUniquePropertiesParams) (*rivertype.JobRow, error)

+ JobGetByKindMany func(ctx context.Context, kind []string) ([]*rivertype.JobRow, error)

+ JobGetStuck func(ctx context.Context, params *JobGetStuckParams) ([]*rivertype.JobRow, error)

+ JobInsertFast func(ctx context.Context, params *JobInsertFastParams) (*rivertype.JobRow, error)

+ JobInsertFastMany func(ctx context.Context, params []*JobInsertFastParams) (int64, error)

+ JobInsertFull func(ctx context.Context, params *JobInsertFullParams) (*rivertype.JobRow, error)

+ JobList func(ctx context.Context, sql string, namedArgs map[string]any) ([]*rivertype.JobRow, error)

+ JobListFields func() string

+ JobRescueMany func(ctx context.Context, params *JobRescueManyParams) (*struct{}, error)

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

+ JobSchedule func(ctx context.Context, params *JobScheduleParams) (int, error)

+ JobSetStateIfRunning func(ctx context.Context, params *JobSetStateIfRunningParams) (*rivertype.JobRow, error)

+ JobUpdate func(ctx context.Context, params *JobUpdateParams) (*rivertype.JobRow, error)

+ LeaderAttemptElect func(ctx context.Context, params *LeaderElectParams) (bool, error)

+ LeaderAttemptReelect func(ctx context.Context, params *LeaderElectParams) (bool, error)

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

+ LeaderGetElectedLeader func(ctx context.Context, name string) (*Leader, error)

+ LeaderInsert func(ctx context.Context, params *LeaderInsertParams) (*Leader, error)

+ LeaderResign func(ctx context.Context, params *LeaderResignParams) (bool, error)

+ Notify func(ctx context.Context, topic string, payload string) error

+ PGAdvisoryXactLock func(ctx context.Context, key int64) (*struct{}, error)

+ type JobCancelParams struct

+ CancelAttemptedAt time.Time

+ ID int64

+ JobControlTopic string

+ type JobDeleteBeforeParams struct

+ CancelledFinalizedAtHorizon time.Time

+ CompletedFinalizedAtHorizon time.Time

+ DiscardedFinalizedAtHorizon time.Time

+ Max int

+ type JobGetAvailableParams struct

+ AttemptedBy string

+ Max int

+ Queue string

+ type JobGetByKindAndUniquePropertiesParams struct

+ Args []byte

+ ByArgs bool

+ ByCreatedAt bool

+ ByQueue bool

+ ByState bool

+ CreatedAtBegin time.Time

+ CreatedAtEnd time.Time

+ Kind string

+ Queue string

+ State []string

+ type JobGetStuckParams struct

+ Max int

+ StuckHorizon time.Time

+ type JobInsertFastParams struct

+ EncodedArgs []byte

+ Kind string

+ MaxAttempts int

+ Metadata []byte

+ Priority int

+ Queue string

+ ScheduledAt *time.Time

+ State rivertype.JobState

+ Tags []string

+ type JobInsertFullParams struct

+ Attempt int

+ AttemptedAt *time.Time

+ CreatedAt *time.Time

+ EncodedArgs []byte

+ Errors [][]byte

+ FinalizedAt *time.Time

+ Kind string

+ MaxAttempts int

+ Metadata []byte

+ Priority int

+ Queue string

+ ScheduledAt *time.Time

+ State rivertype.JobState

+ Tags []string

+ type JobRescueManyParams struct

+ Error [][]byte

+ FinalizedAt []time.Time

+ ID []int64

+ ScheduledAt []time.Time

+ State []string

+ type JobScheduleParams struct

+ InsertTopic string

+ Max int

+ Now time.Time

+ type JobSetStateIfRunningParams struct

+ ErrData []byte

+ FinalizedAt *time.Time

+ ID int64

+ MaxAttempts *int

+ ScheduledAt *time.Time

+ State rivertype.JobState

+ func JobSetStateCancelled(id int64, finalizedAt time.Time, errData []byte) *JobSetStateIfRunningParams

+ func JobSetStateCompleted(id int64, finalizedAt time.Time) *JobSetStateIfRunningParams

+ func JobSetStateDiscarded(id int64, finalizedAt time.Time, errData []byte) *JobSetStateIfRunningParams

+ func JobSetStateErrorAvailable(id int64, scheduledAt time.Time, errData []byte) *JobSetStateIfRunningParams

+ func JobSetStateErrorRetryable(id int64, scheduledAt time.Time, errData []byte) *JobSetStateIfRunningParams

+ func JobSetStateSnoozed(id int64, scheduledAt time.Time, maxAttempts int) *JobSetStateIfRunningParams

+ func JobSetStateSnoozedAvailable(id int64, scheduledAt time.Time, maxAttempts int) *JobSetStateIfRunningParams

+ type JobUpdateParams struct

+ Attempt int

+ AttemptDoUpdate bool

+ AttemptedAt *time.Time

+ AttemptedAtDoUpdate bool

+ Errors [][]byte

+ ErrorsDoUpdate bool

+ FinalizedAt *time.Time

+ FinalizedAtDoUpdate bool

+ ID int64

+ State rivertype.JobState

+ StateDoUpdate bool

+ type Leader struct

+ ElectedAt time.Time

+ ExpiresAt time.Time

+ LeaderID string

+ Name string

+ type LeaderElectParams struct

+ LeaderID string

+ Name string

+ TTL time.Duration

+ type LeaderInsertParams struct

+ ElectedAt *time.Time

+ ExpiresAt *time.Time

+ LeaderID string

+ Name string

+ TTL time.Duration

+ type LeaderResignParams struct

+ LeaderID string

+ LeadershipTopic string

+ Name string

+ type Listener interface

+ Close func(ctx context.Context) error

+ Connect func(ctx context.Context) error

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

+ Ping func(ctx context.Context) error

+ Unlisten func(ctx context.Context, topic string) error

+ WaitForNotification func(ctx context.Context) (*Notification, error)

+ type Notification struct

+ Payload string

+ Topic string

v0.0.22

Feb 19, 2024

v0.0.21

Feb 19, 2024

v0.0.20

Feb 15, 2024

v0.0.19

Feb 11, 2024

v0.0.18

Jan 26, 2024

v0.0.17

Jan 23, 2024

v0.0.16

Jan 6, 2024

v0.0.15

Dec 22, 2023

v0.0.14

Dec 13, 2023

v0.0.13

Dec 13, 2023

Changes in this version

+ var ErrNoRows = errors.New("no rows found")

+ var ErrNotImplemented = errors.New("driver does not implement this functionality")

+ var ErrSubTxNotSupported = errors.New("subtransactions not supported for this driver")

+ type Driver interface

+ GetDBPool func() *pgxpool.Pool

+ GetExecutor func() Executor

+ UnwrapExecutor func(tx TTx) Executor

+ UnwrapTx func(tx TTx) pgx.Tx

+ type Executor interface

+ Begin func(ctx context.Context) (ExecutorTx, error)

+ Exec func(ctx context.Context, sql string) (struct{}, error)

+ MigrationDeleteByVersionMany func(ctx context.Context, versions []int) ([]*Migration, error)

+ MigrationGetAll func(ctx context.Context) ([]*Migration, error)

+ MigrationInsertMany func(ctx context.Context, versions []int) ([]*Migration, error)

+ TableExists func(ctx context.Context, tableName string) (bool, error)

+ type ExecutorTx interface

+ Commit func(ctx context.Context) error

+ Rollback func(ctx context.Context) error

+ type Migration struct

+ CreatedAt time.Time

+ ID int

+ Version int

Other modules containing this package

github.com/riverqueue/river

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