Help us shape the future of Go! Take the 2026 Go Developer Survey

redisdb

package
v1.1.5 Latest Latest
Warning

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

 Go to latest Published: Oct 22, 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 the root module. It requires Go 1.27.0 or later.

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

Continue with the parent documentation index or the versioned Golib ecosystem index.

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 (
	// ErrManagementControlDisabled retains the successor control-disabled sentinel.
	//
	// Deprecated: use redisstream.ErrManagementControlDisabled.
	ErrManagementControlDisabled = redisstream.ErrManagementControlDisabled
	// ErrManagementStatusDisabled retains the successor status-disabled sentinel.
	//
	// Deprecated: use redisstream.ErrManagementStatusDisabled.
	ErrManagementStatusDisabled = redisstream.ErrManagementStatusDisabled
	// ErrInvalidManagementStatus retains the successor invalid-status sentinel.
	//
	// 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

WithAddr forwards the Redis standalone or comma-separated cluster addresses.

Deprecated: use redisstream.WithAddr.

func WithBlockTime deprecated 

func WithBlockTime(value time.Duration) Option

WithBlockTime forwards the preferred blocking read duration.

Deprecated: use redisstream.WithBlockTime.

func WithCluster deprecated 

func WithCluster() Option

WithCluster selects the successor's cluster client.

Deprecated: use redisstream.WithCluster.

func WithCommandTimeout deprecated 

func WithCommandTimeout(value time.Duration) Option

WithCommandTimeout forwards the record/settlement command bound.

Deprecated: use redisstream.WithCommandTimeout.

func WithConnectTimeout deprecated 

func WithConnectTimeout(value time.Duration) Option

WithConnectTimeout forwards initial connection validation timeout.

Deprecated: use redisstream.WithConnectTimeout.

func WithConnectionString deprecated 

func WithConnectionString(value string) Option

WithConnectionString forwards the Redis URL; URL options take precedence in the successor.

Deprecated: use redisstream.WithConnectionString.

func WithConsumer deprecated 

func WithConsumer(value string) Option

WithConsumer forwards the reclaim/read owner identity.

Deprecated: use redisstream.WithConsumer.

func WithDB deprecated 

func WithDB(value int) Option

WithDB forwards standalone database selection.

Deprecated: use redisstream.WithDB.

func WithDeadLetter deprecated 

func WithDeadLetter(stream string, attempts int64) Option

WithDeadLetter forwards terminal destination and delivery-attempt policy.

Deprecated: use redisstream.WithDeadLetter.

func WithFailureStream deprecated 

func WithFailureStream(value string) Option

WithFailureStream forwards failed-attempt record storage.

Deprecated: use redisstream.WithFailureStream.

func WithGroup deprecated 

func WithGroup(value string) Option

WithGroup forwards consumer-group identity.

Deprecated: use redisstream.WithGroup.

func WithLogger deprecated 

func WithLogger(value queue.Logger) Option

WithLogger forwards the borrowed logging implementation.

Deprecated: use redisstream.WithLogger.

func WithManagementStatus deprecated 

func WithManagementStatus(value management.StatusMetadata) Option

WithManagementStatus forwards explicit status identity and protocol metadata.

Deprecated: use redisstream.WithManagementStatus.

func WithMaxLength deprecated 

func WithMaxLength(value int64) Option

WithMaxLength forwards direct-enqueue source capacity; zero is unbounded.

Deprecated: use redisstream.WithMaxLength.

func WithPassword deprecated 

func WithPassword(value string) Option

WithPassword forwards caller-owned credentials.

Deprecated: use redisstream.WithPassword.

func WithReclaim deprecated 

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

WithReclaim forwards stale pending-entry recovery bounds.

Deprecated: use redisstream.WithReclaim.

func WithRecordRetention deprecated 

func WithRecordRetention(value int64) Option

WithRecordRetention forwards optional exact maximum-count record retention.

Deprecated: use redisstream.WithRecordRetention.

func WithReplayDestinations deprecated 

func WithReplayDestinations(values ...string) Option

WithReplayDestinations forwards the explicit replay destination allowlist.

Deprecated: use redisstream.WithReplayDestinations.

func WithRequestTimeout deprecated 

func WithRequestTimeout(value time.Duration) Option

WithRequestTimeout forwards the request wait duration.

Deprecated: use redisstream.WithRequestTimeout.

func WithRunFunc deprecated 

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

WithRunFunc forwards synchronous handler code that must honor its context.

Deprecated: use redisstream.WithRunFunc.

func WithSkipTLSVerify deprecated 

func WithSkipTLSVerify() Option

WithSkipTLSVerify forwards explicit certificate verification opt-out.

Deprecated: use redisstream.WithSkipTLSVerify.

func WithStreamName deprecated 

func WithStreamName(value string) Option

WithStreamName forwards source stream identity.

Deprecated: use redisstream.WithStreamName.

func WithTLS deprecated 

func WithTLS() Option

WithTLS forwards TLS configuration with a TLS1.2 minimum.

Deprecated: use redisstream.WithTLS.

func WithUsername deprecated 

func WithUsername(value string) Option

WithUsername forwards caller-owned ACL identity.

Deprecated: use redisstream.WithUsername.

type Stats deprecated 

type Stats struct {
	// Depth is Pending plus Lag, or -1 when Lag is unknown.
	Depth int64
	// Pending counts delivered entries still pending for this consumer group.
	Pending int64
	// Lag counts entries not yet delivered to the group when known.
	Lag int64
	// LagKnown distinguishes determinate depth from unsupported group lag.
	LagKnown bool
	// OldestJobAge is the oldest inspected pending/undelivered age; zero may be unavailable.
	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

NewWorker constructs the successor worker and panics on error.

Deprecated: use redisstream.NewWorker.

func NewWorkerE deprecated 

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

NewWorkerE constructs the successor worker and returns its construction error.

Deprecated: use redisstream.NewWorkerE.

func (*Worker) BackendName 

func (worker *Worker) BackendName() string

BackendName returns the successor backend label.

func (*Worker) Execute 

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

Execute applies a command under provider-owned deduplication/outcome rules. Authorization remains caller-owned.

func (*Worker) Inspect 

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

Inspect returns one record with no more disclosure than requested; authorization is caller-owned.

func (*Worker) ListDeadLetters 

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

ListDeadLetters lists bounded terminal metadata with payload and diagnostics hidden.

func (*Worker) ListFailures 

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

ListFailures lists bounded metadata with payload and diagnostics hidden.

func (*Worker) ObserveQueue 

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

ObserveQueue reports native queue support flags and values, not invented metrics.

func (*Worker) ObserveWorker 

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

ObserveWorker reports native worker state; the provider owns context handling and concurrency.

func (*Worker) Queue 

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

Queue forwards one task admission, not a handler-completion guarantee.

func (*Worker) QueueName 

func (worker *Worker) QueueName() string

QueueName returns the successor source stream name.

func (*Worker) Request 

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

Request forwards one bounded intake attempt.

func (*Worker) Run 

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

Run forwards one synchronous handler call using ctx.

func (*Worker) Shutdown 

func (worker *Worker) Shutdown() error

Shutdown releases successor resources with its native lifecycle policy.

func (*Worker) Stats 

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

Stats returns successor consumer-group observations, with unknown lag preserved.

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.