riverpgxv5

package module
v0.22.0 Latest Latest
Warning

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

 Go to latest Published: May 10, 2025 License: MPL-2.0 Imports: 20 Imported by: 55

Documentation

Overview

Package riverpgxv5 provides a River driver implementation for Pgx v5.

This is currently the only supported driver for River and will therefore be used by all projects using River, but the code is organized this way so that other database packages can be supported in future River versions.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Driver 

type Driver struct {
	// contains filtered or unexported fields
}

Driver is an implementation of riverdriver.Driver for Pgx v5.

func New 

func New(dbPool *pgxpool.Pool) *Driver

New returns a new Pgx v5 River driver for use with River.

It takes a pgxpool.Pool to use for use with River. The pool should already be configured to use the schema specified in the client's Schema field. The pool must not be closed while associated River objects are running.

The database pool may be nil. If it is, a client that it's sent into will not be able to start up (calls to Start will error) and the Insert and InsertMany functions will be disabled, but the transactional-variants InsertTx and InsertManyTx continue to function. This behavior may be particularly useful in testing so that inserts can be performed and verified on a test transaction that will be rolled back.

func (*Driver) GetExecutor added in v0.0.13 

func (d *Driver) GetExecutor() riverdriver.Executor

func (*Driver) GetListener added in v0.0.23 

func (d *Driver) GetListener(params *riverdriver.GetListenenerParams) riverdriver.Listener

func (*Driver) GetMigrationDefaultLines added in v0.21.0 

func (d *Driver) GetMigrationDefaultLines() []string

func (*Driver) GetMigrationFS added in v0.10.0 

func (d *Driver) GetMigrationFS(line string) fs.FS

func (*Driver) GetMigrationLines added in v0.10.0 

func (d *Driver) GetMigrationLines() []string

func (*Driver) GetMigrationTruncateTables added in v0.21.0 

func (d *Driver) GetMigrationTruncateTables(line string) []string

func (*Driver) HasPool added in v0.0.23 

func (d *Driver) HasPool() bool

func (*Driver) SupportsListener added in v0.10.0 

func (d *Driver) SupportsListener() bool

func (*Driver) UnwrapExecutor added in v0.0.13 

func (d *Driver) UnwrapExecutor(tx pgx.Tx) riverdriver.ExecutorTx

func (*Driver) UnwrapTx 

func (d *Driver) UnwrapTx(execTx riverdriver.ExecutorTx) pgx.Tx

type Executor added in v0.0.13 

type Executor struct {
	// contains filtered or unexported fields
}

func (*Executor) Begin added in v0.0.13 

func (e *Executor) Begin(ctx context.Context) (riverdriver.ExecutorTx, error)

func (*Executor) ColumnExists added in v0.10.0 

func (e *Executor) ColumnExists(ctx context.Context, params *riverdriver.ColumnExistsParams) (bool, error)

func (*Executor) Exec added in v0.0.13 

func (e *Executor) Exec(ctx context.Context, sql string, args ...any) (struct{}, error)

func (*Executor) JobCancel added in v0.0.23 

func (e *Executor) JobCancel(ctx context.Context, params *riverdriver.JobCancelParams) (*rivertype.JobRow, error)

func (*Executor) JobCountByState added in v0.1.0 

func (e *Executor) JobCountByState(ctx context.Context, params *riverdriver.JobCountByStateParams) (int, error)

func (*Executor) JobDelete added in v0.7.0 

func (e *Executor) JobDelete(ctx context.Context, params *riverdriver.JobDeleteParams) (*rivertype.JobRow, error)

func (*Executor) JobDeleteBefore added in v0.0.23 

func (e *Executor) JobDeleteBefore(ctx context.Context, params *riverdriver.JobDeleteBeforeParams) (int, error)

func (*Executor) JobGetAvailable added in v0.0.23 

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

func (*Executor) JobGetByID added in v0.0.23 

func (e *Executor) JobGetByID(ctx context.Context, params *riverdriver.JobGetByIDParams) (*rivertype.JobRow, error)

func (*Executor) JobGetByIDMany added in v0.0.23 

func (e *Executor) JobGetByIDMany(ctx context.Context, params *riverdriver.JobGetByIDManyParams) ([]*rivertype.JobRow, error)

func (*Executor) JobGetByKindMany added in v0.0.23 

func (e *Executor) JobGetByKindMany(ctx context.Context, params *riverdriver.JobGetByKindManyParams) ([]*rivertype.JobRow, error)

func (*Executor) JobGetStuck added in v0.0.23 

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

func (*Executor) JobInsertFastMany added in v0.0.23 

func (e *Executor) JobInsertFastMany(ctx context.Context, params *riverdriver.JobInsertFastManyParams) ([]*riverdriver.JobInsertFastResult, error)

func (*Executor) JobInsertFastManyNoReturning added in v0.12.0 

func (e *Executor) JobInsertFastManyNoReturning(ctx context.Context, params *riverdriver.JobInsertFastManyParams) (int, error)

func (*Executor) JobInsertFull added in v0.0.23 

func (e *Executor) JobInsertFull(ctx context.Context, params *riverdriver.JobInsertFullParams) (*rivertype.JobRow, error)

func (*Executor) JobList added in v0.0.23 

func (e *Executor) JobList(ctx context.Context, params *riverdriver.JobListParams) ([]*rivertype.JobRow, error)

func (*Executor) JobRescueMany added in v0.0.23 

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

func (*Executor) JobRetry added in v0.0.23 

func (e *Executor) JobRetry(ctx context.Context, params *riverdriver.JobRetryParams) (*rivertype.JobRow, error)

func (*Executor) JobSchedule added in v0.0.23 

func (e *Executor) JobSchedule(ctx context.Context, params *riverdriver.JobScheduleParams) ([]*riverdriver.JobScheduleResult, error)

func (*Executor) JobSetStateIfRunningMany added in v0.12.1 

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

func (*Executor) JobUpdate added in v0.0.23 

func (e *Executor) JobUpdate(ctx context.Context, params *riverdriver.JobUpdateParams) (*rivertype.JobRow, error)

func (*Executor) LeaderAttemptElect added in v0.0.23 

func (e *Executor) LeaderAttemptElect(ctx context.Context, params *riverdriver.LeaderElectParams) (bool, error)

func (*Executor) LeaderAttemptReelect added in v0.0.23 

func (e *Executor) LeaderAttemptReelect(ctx context.Context, params *riverdriver.LeaderElectParams) (bool, error)

func (*Executor) LeaderDeleteExpired added in v0.0.23 

func (e *Executor) LeaderDeleteExpired(ctx context.Context, params *riverdriver.LeaderDeleteExpiredParams) (int, error)

func (*Executor) LeaderGetElectedLeader added in v0.0.23 

func (e *Executor) LeaderGetElectedLeader(ctx context.Context, params *riverdriver.LeaderGetElectedLeaderParams) (*riverdriver.Leader, error)

func (*Executor) LeaderInsert added in v0.0.23 

func (e *Executor) LeaderInsert(ctx context.Context, params *riverdriver.LeaderInsertParams) (*riverdriver.Leader, error)

func (*Executor) LeaderResign added in v0.0.23 

func (e *Executor) LeaderResign(ctx context.Context, params *riverdriver.LeaderResignParams) (bool, error)

func (*Executor) MigrationDeleteAssumingMainMany added in v0.10.0 

func (e *Executor) MigrationDeleteAssumingMainMany(ctx context.Context, params *riverdriver.MigrationDeleteAssumingMainManyParams) ([]*riverdriver.Migration, error)

func (*Executor) MigrationDeleteByLineAndVersionMany added in v0.10.0 

func (e *Executor) MigrationDeleteByLineAndVersionMany(ctx context.Context, params *riverdriver.MigrationDeleteByLineAndVersionManyParams) ([]*riverdriver.Migration, error)

func (*Executor) MigrationGetAllAssumingMain added in v0.10.0 

func (e *Executor) MigrationGetAllAssumingMain(ctx context.Context, params *riverdriver.MigrationGetAllAssumingMainParams) ([]*riverdriver.Migration, error)

func (*Executor) MigrationGetByLine added in v0.10.0 

func (e *Executor) MigrationGetByLine(ctx context.Context, params *riverdriver.MigrationGetByLineParams) ([]*riverdriver.Migration, error)

func (*Executor) MigrationInsertMany added in v0.0.13 

func (e *Executor) MigrationInsertMany(ctx context.Context, params *riverdriver.MigrationInsertManyParams) ([]*riverdriver.Migration, error)

func (*Executor) MigrationInsertManyAssumingMain added in v0.10.0 

func (e *Executor) MigrationInsertManyAssumingMain(ctx context.Context, params *riverdriver.MigrationInsertManyAssumingMainParams) ([]*riverdriver.Migration, error)

func (*Executor) NotifyMany added in v0.5.0 

func (e *Executor) NotifyMany(ctx context.Context, params *riverdriver.NotifyManyParams) error

func (*Executor) PGAdvisoryXactLock added in v0.0.23 

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

func (*Executor) QueryRow added in v0.21.0 

func (e *Executor) QueryRow(ctx context.Context, sql string, args ...any) riverdriver.Row

func (*Executor) QueueCreateOrSetUpdatedAt added in v0.5.0 

func (e *Executor) QueueCreateOrSetUpdatedAt(ctx context.Context, params *riverdriver.QueueCreateOrSetUpdatedAtParams) (*rivertype.Queue, error)

func (*Executor) QueueDeleteExpired added in v0.5.0 

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

func (*Executor) QueueGet added in v0.5.0 

func (e *Executor) QueueGet(ctx context.Context, params *riverdriver.QueueGetParams) (*rivertype.Queue, error)

func (*Executor) QueueList added in v0.5.0 

func (e *Executor) QueueList(ctx context.Context, params *riverdriver.QueueListParams) ([]*rivertype.Queue, error)

func (*Executor) QueuePause added in v0.5.0 

func (e *Executor) QueuePause(ctx context.Context, params *riverdriver.QueuePauseParams) error

func (*Executor) QueueResume added in v0.5.0 

func (e *Executor) QueueResume(ctx context.Context, params *riverdriver.QueueResumeParams) error

func (*Executor) QueueUpdate added in v0.20.0 

func (e *Executor) QueueUpdate(ctx context.Context, params *riverdriver.QueueUpdateParams) (*rivertype.Queue, error)

func (*Executor) SchemaGetExpired added in v0.21.0 

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

func (*Executor) TableExists added in v0.0.13 

func (e *Executor) TableExists(ctx context.Context, params *riverdriver.TableExistsParams) (bool, error)

type ExecutorTx added in v0.0.13 

type ExecutorTx struct {
	Executor
	// contains filtered or unexported fields
}

func (*ExecutorTx) Commit added in v0.0.13 

func (t *ExecutorTx) Commit(ctx context.Context) error

func (*ExecutorTx) Rollback added in v0.0.13 

func (t *ExecutorTx) Rollback(ctx context.Context) error

type Listener added in v0.0.23 

type Listener struct {
	// contains filtered or unexported fields
}

func (*Listener) Close added in v0.0.23 

func (l *Listener) Close(ctx context.Context) error

func (*Listener) Connect added in v0.0.23 

func (l *Listener) Connect(ctx context.Context) error

func (*Listener) Listen added in v0.0.23 

func (l *Listener) Listen(ctx context.Context, topic string) error

func (*Listener) Ping added in v0.0.23 

func (l *Listener) Ping(ctx context.Context) error

func (*Listener) Schema added in v0.21.0 

func (l *Listener) Schema() string

func (*Listener) SetAfterConnectExec added in v0.21.0 

func (l *Listener) SetAfterConnectExec(sql string)

func (*Listener) Unlisten added in v0.0.23 

func (l *Listener) Unlisten(ctx context.Context, topic string) error

func (*Listener) WaitForNotification added in v0.0.23 

func (l *Listener) WaitForNotification(ctx context.Context) (*riverdriver.Notification, error)

Source Files

View all Source files

Directories

Path Synopsis
internal
dbsqlc

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.