riverdatabasesql

package module
v0.16.0 Latest Latest
Warning

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

 Go to latest Published: Jan 28, 2025 License: MPL-2.0 Imports: 20 Imported by: 3

Documentation

Overview

Package riverdatabasesql bundles a River driver for Go's built-in database/sql, making it interoperable with ORMs like Bun and GORM. It's generally still powered under the hood by Pgx because it's the only maintained, fully functional Postgres driver in the Go ecosystem, but it uses some lib/pq constructs internally by virtue of being implemented with Sqlc.

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 database/sql.

func New 

func New(dbPool *sql.DB) *Driver

New returns a new database/sql River driver for use with River.

It takes an sql.DB 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.

func (*Driver) GetExecutor 

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

func (*Driver) GetListener added in v0.0.23 

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

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) 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 

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

type Executor 

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

func (*Executor) Begin 

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, tableName, columnName string) (bool, error)

func (*Executor) Exec 

func (e *Executor) Exec(ctx context.Context, sql string) (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, state rivertype.JobState) (int, error)

func (*Executor) JobDelete added in v0.7.0 

func (e *Executor) JobDelete(ctx context.Context, id int64) (*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, id int64) (*rivertype.JobRow, error)

func (*Executor) JobGetByIDMany added in v0.0.23 

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

func (*Executor) JobGetByKindAndUniqueProperties added in v0.0.23 

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

func (*Executor) JobGetByKindMany added in v0.0.23 

func (e *Executor) JobGetByKindMany(ctx context.Context, kind []string) ([]*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.JobInsertFastParams) ([]*riverdriver.JobInsertFastResult, error)

func (*Executor) JobInsertFastManyNoReturning added in v0.12.0 

func (e *Executor) JobInsertFastManyNoReturning(ctx context.Context, params []*riverdriver.JobInsertFastParams) (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, query string, namedArgs map[string]any) ([]*rivertype.JobRow, error)

func (*Executor) JobListFields added in v0.0.23 

func (e *Executor) JobListFields() string

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, id int64) (*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) JobSetCompleteIfRunningMany added in v0.1.0 

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

func (*Executor) JobSetStateIfRunning added in v0.0.23 

func (e *Executor) JobSetStateIfRunning(ctx context.Context, params *riverdriver.JobSetStateIfRunningParams) (*rivertype.JobRow, 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) (int, error)

func (*Executor) LeaderGetElectedLeader added in v0.0.23 

func (e *Executor) LeaderGetElectedLeader(ctx context.Context) (*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, versions []int) ([]*riverdriver.Migration, error)

func (*Executor) MigrationDeleteByLineAndVersionMany added in v0.10.0 

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

func (*Executor) MigrationGetAllAssumingMain added in v0.10.0 

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

func (*Executor) MigrationGetByLine added in v0.10.0 

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

func (*Executor) MigrationInsertMany 

func (e *Executor) MigrationInsertMany(ctx context.Context, line string, versions []int) ([]*riverdriver.Migration, error)

func (*Executor) MigrationInsertManyAssumingMain added in v0.10.0 

func (e *Executor) MigrationInsertManyAssumingMain(ctx context.Context, versions []int) ([]*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) 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, name string) (*rivertype.Queue, error)

func (*Executor) QueueList added in v0.5.0 

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

func (*Executor) QueuePause added in v0.5.0 

func (e *Executor) QueuePause(ctx context.Context, name string) error

func (*Executor) QueueResume added in v0.5.0 

func (e *Executor) QueueResume(ctx context.Context, name string) error

func (*Executor) TableExists 

func (e *Executor) TableExists(ctx context.Context, tableName string) (bool, error)

type ExecutorSubTx added in v0.10.0 

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

func (*ExecutorSubTx) Begin added in v0.10.0 

func (t *ExecutorSubTx) Begin(ctx context.Context) (riverdriver.ExecutorTx, error)

func (*ExecutorSubTx) Commit added in v0.10.0 

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

func (*ExecutorSubTx) Rollback added in v0.10.0 

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

type ExecutorTx 

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

func (*ExecutorTx) Begin added in v0.10.0 

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

func (*ExecutorTx) Commit 

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

func (*ExecutorTx) Rollback 

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

Source Files

View all Source files

Directories

Path Synopsis
internal
dbsqlc
pgtypealias
package pgtypealias exists to work around sqlc bugs with being able to reference v5 the pgtype package from within a dbsql package.
 package pgtypealias exists to work around sqlc bugs with being able to reference v5 the pgtype package from within a dbsql package.

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.