redisdb

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: Sep 5, 2026 License: MIT, MIT Imports: 6 Imported by: 0

README

Redis Streams compatibility facade

This package preserves github.com/faustbrian/go-queue/redisstream and its historical redisdb package identifier for existing v1 consumers.

Deprecated: new code should install and import github.com/faustbrian/go-queue/adapters/redisstream. All exported types and functions delegate to that target-oriented semantic owner; no worker or mutable runtime state is copied.

Status and requirements

This is a deprecated stable-v1 compatibility package in root module v1.1.0. It requires Go 1.26.6 or later.

See the successor README and migration guide. The compatibility path remains supported for the documented v1 deprecation interval.

Documentation

Overview

Package redisdb preserves the released Redis Streams import path.

Deprecated: use github.com/faustbrian/go-queue/adapters/redisstream. This compatibility facade delegates runtime behavior and state to that semantic owner.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// Deprecated: use redisstream.ErrManagementControlDisabled.
	ErrManagementControlDisabled = redisstream.ErrManagementControlDisabled
	// Deprecated: use redisstream.ErrManagementStatusDisabled.
	ErrManagementStatusDisabled = redisstream.ErrManagementStatusDisabled
	// Deprecated: use redisstream.ErrInvalidManagementStatus.
	ErrInvalidManagementStatus = redisstream.ErrInvalidManagementStatus
)

Functions

This section is empty.

Types

type Option deprecated 

type Option func(*options)

Option preserves the released configuration function type.

Deprecated: use redisstream.Option.

func WithAddr deprecated 

func WithAddr(value string) Option

Deprecated: use redisstream.WithAddr.

func WithBlockTime deprecated 

func WithBlockTime(value time.Duration) Option

Deprecated: use redisstream.WithBlockTime.

func WithCluster deprecated 

func WithCluster() Option

Deprecated: use redisstream.WithCluster.

func WithCommandTimeout deprecated 

func WithCommandTimeout(value time.Duration) Option

Deprecated: use redisstream.WithCommandTimeout.

func WithConnectTimeout deprecated 

func WithConnectTimeout(value time.Duration) Option

Deprecated: use redisstream.WithConnectTimeout.

func WithConnectionString deprecated 

func WithConnectionString(value string) Option

Deprecated: use redisstream.WithConnectionString.

func WithConsumer deprecated 

func WithConsumer(value string) Option

Deprecated: use redisstream.WithConsumer.

func WithDB deprecated 

func WithDB(value int) Option

Deprecated: use redisstream.WithDB.

func WithDeadLetter deprecated 

func WithDeadLetter(stream string, attempts int64) Option

Deprecated: use redisstream.WithDeadLetter.

func WithFailureStream deprecated 

func WithFailureStream(value string) Option

Deprecated: use redisstream.WithFailureStream.

func WithGroup deprecated 

func WithGroup(value string) Option

Deprecated: use redisstream.WithGroup.

func WithLogger deprecated 

func WithLogger(value queue.Logger) Option

Deprecated: use redisstream.WithLogger.

func WithManagementStatus deprecated 

func WithManagementStatus(value management.StatusMetadata) Option

Deprecated: use redisstream.WithManagementStatus.

func WithMaxLength deprecated 

func WithMaxLength(value int64) Option

Deprecated: use redisstream.WithMaxLength.

func WithPassword deprecated 

func WithPassword(value string) Option

Deprecated: use redisstream.WithPassword.

func WithReclaim deprecated 

func WithReclaim(idle, interval time.Duration, batch int64) Option

Deprecated: use redisstream.WithReclaim.

func WithRecordRetention deprecated 

func WithRecordRetention(value int64) Option

Deprecated: use redisstream.WithRecordRetention.

func WithReplayDestinations deprecated 

func WithReplayDestinations(values ...string) Option

Deprecated: use redisstream.WithReplayDestinations.

func WithRequestTimeout deprecated 

func WithRequestTimeout(value time.Duration) Option

Deprecated: use redisstream.WithRequestTimeout.

func WithRunFunc deprecated 

func WithRunFunc(value func(context.Context, core.TaskMessage) error) Option

Deprecated: use redisstream.WithRunFunc.

func WithSkipTLSVerify deprecated 

func WithSkipTLSVerify() Option

Deprecated: use redisstream.WithSkipTLSVerify.

func WithStreamName deprecated 

func WithStreamName(value string) Option

Deprecated: use redisstream.WithStreamName.

func WithTLS deprecated 

func WithTLS() Option

Deprecated: use redisstream.WithTLS.

func WithUsername deprecated 

func WithUsername(value string) Option

Deprecated: use redisstream.WithUsername.

type Stats deprecated 

type Stats struct {
	Depth        int64
	Pending      int64
	Lag          int64
	LagKnown     bool
	OldestJobAge time.Duration
}

Stats describes outstanding work for this worker's Redis consumer group.

Deprecated: use redisstream.Stats.

type Worker deprecated 

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

Worker preserves the released worker type while delegating all runtime state and behavior to the successor adapter.

Deprecated: use redisstream.Worker.

func NewWorker deprecated 

func NewWorker(options ...Option) *Worker

Deprecated: use redisstream.NewWorker.

func NewWorkerE deprecated 

func NewWorkerE(optionValues ...Option) (*Worker, error)

Deprecated: use redisstream.NewWorkerE.

func (*Worker) BackendName 

func (worker *Worker) BackendName() string

func (*Worker) Execute 

func (worker *Worker) Execute(ctx context.Context, command management.Command) (management.CommandResult, error)

func (*Worker) Inspect 

func (worker *Worker) Inspect(ctx context.Context, request management.InspectRequest) (management.JobRecord, error)

func (*Worker) ListDeadLetters 

func (worker *Worker) ListDeadLetters(ctx context.Context, request management.PageRequest) (management.RecordPage, error)

func (*Worker) ListFailures 

func (worker *Worker) ListFailures(ctx context.Context, request management.PageRequest) (management.RecordPage, error)

func (*Worker) ObserveQueue 

func (worker *Worker) ObserveQueue(ctx context.Context) (management.QueueStatus, error)

func (*Worker) ObserveWorker 

func (worker *Worker) ObserveWorker(ctx context.Context) (management.WorkerStatus, error)

func (*Worker) Queue 

func (worker *Worker) Queue(task core.TaskMessage) error

func (*Worker) QueueName 

func (worker *Worker) QueueName() string

func (*Worker) Request 

func (worker *Worker) Request() (core.TaskMessage, error)

func (*Worker) Run 

func (worker *Worker) Run(ctx context.Context, task core.TaskMessage) error

func (*Worker) Shutdown 

func (worker *Worker) Shutdown() error

func (*Worker) Stats 

func (worker *Worker) Stats(ctx context.Context) (Stats, error)

Source Files

View all Source files

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.