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

couchbase

package
v1.21.2 Latest Latest
Warning

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

Go to latest
Published: Sep 11, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// MetaCASKey holds the CAS value of an entry.
	MetaCASKey = "couchbase_cas"
)

Variables

View Source
var (
	// ErrInvalidOperation specified operation is not supported.
	ErrInvalidOperation = errors.New("invalid operation")
	// ErrContentRequired content field is required.
	ErrContentRequired = errors.New("content required")
	// ErrBatchError batch error.
	ErrBatchError = errors.New("batch error")
)
View Source
var ErrInvalidTranscoder = errors.New("invalid transcoder")

ErrInvalidTranscoder specified transcoder is not supported.

Functions

func CacheConfig

func CacheConfig() *service.ConfigSpec

CacheConfig export couchbase Cache specification.

func CommonFields added in v1.15.0

func CommonFields() []*service.ConfigField

CommonFields returns the common config fields for the Couchbase client.

func OutputConfig added in v1.15.0

func OutputConfig() *service.ConfigSpec

OutputConfig export couchbase output specification.

func ProcessorConfig

func ProcessorConfig() *service.ConfigSpec

ProcessorConfig export couchbase processor specification.

Types

type Cache

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

Cache stores or retrieves data from couchbase to be used as a cache

func NewCache

func NewCache(ctx context.Context, conf *service.ParsedConfig) (*Cache, error)

NewCache returns a Couchbase cache.

func (*Cache) Add

func (c *Cache) Add(ctx context.Context, key string, value []byte, ttl *time.Duration) error

Add insert into cache.

func (Cache) Close

func (p Cache) Close(ctx context.Context) error

func (*Cache) Delete

func (c *Cache) Delete(ctx context.Context, key string) error

Delete remove from cache.

func (*Cache) Exists added in v1.21.0

func (c *Cache) Exists(ctx context.Context, key string) (data bool, err error)

Check if cache value exists.

func (*Cache) Get

func (c *Cache) Get(ctx context.Context, key string) (data []byte, err error)

Get retrieve from cache.

func (*Cache) Set

func (c *Cache) Set(ctx context.Context, key string, value []byte, ttl *time.Duration) error

Set update cache.

type Couchbase added in v1.15.0

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

Couchbase stores or retrieves data from couchbase for each message of a batch.

func New added in v1.15.0

func New(ctx context.Context, conf *service.ParsedConfig, mgr *service.Resources, outputMode bool) (*Couchbase, error)

New returns a Couchbase instance.

func NewOutput added in v1.15.0

func NewOutput(ctx context.Context, conf *service.ParsedConfig, mgr *service.Resources) (*Couchbase, error)

NewOutput returns a Couchbase output.

func NewProcessor

func NewProcessor(ctx context.Context, conf *service.ParsedConfig, mgr *service.Resources) (*Couchbase, error)

NewProcessor returns a Couchbase processor.

func (Couchbase) Close added in v1.15.0

func (p Couchbase) Close(ctx context.Context) error

func (*Couchbase) Connect added in v1.15.0

func (c *Couchbase) Connect(ctx context.Context) (err error)

Connect connects to the couchbase cluster

func (*Couchbase) ProcessBatch added in v1.15.0

func (c *Couchbase) ProcessBatch(ctx context.Context, inBatch service.MessageBatch) ([]service.MessageBatch, error)

ProcessBatch applies the processor to a message batch, either creating >0 resulting messages or a response to be sent back to the message source.

func (*Couchbase) WriteBatch added in v1.15.0

func (c *Couchbase) WriteBatch(ctx context.Context, inBatch service.MessageBatch) error

WriteBatch writes a batch of messages to couchbase.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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