Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cache

package

Go to main page

Versions in this module

v2

v2.0.5

Feb 11, 2026

v2.0.4

Feb 11, 2026

v2.0.3

Feb 11, 2026

v2.0.2

Feb 4, 2026

v2.0.1

Jan 31, 2026

Changes in this version

+ func MustRegisterSubsection(name string, cfg config.Config) config.Section

+ func NewRedisClient(ctx context.Context, cfg RedisOptions, secretManager SecretManager, ...) (*redis.Client, error)

+ func New[T any](name string, cacheType Type, f Factory, loadFunc cache.LoadFunction[T], ...) (cache.CacheInterface[T], error)

+ type Config struct

+ InMemoryFixedSize InMemoryFixedSizeConfig

+ Redis RedisConfig

+ Type Type

+ func GetConfig() *Config

+ type Factory struct

+ func NewFactory(ctx context.Context, c *Config, secretManager SecretManager, ...) (Factory, error)

+ func (f Factory) Type() Type

+ type InMemoryFixedSizeConfig struct

+ DefaultExpiration config.Duration

+ Size *resource.Quantity

+ type Marshaler struct

+ func NewMsgPackMarshaler(cache cache.CacheInterface[any]) *Marshaler

+ func NewProtoMarshaler(cache cache.CacheInterface[any]) *Marshaler

+ func (c *Marshaler) Get(ctx context.Context, key any, returnObj any) (any, error)

+ func (c *Marshaler) Set(ctx context.Context, key, object any, options ...store.Option) (err error)

+ type NamespacedCache struct

+ func NewNamespacedCache[T any](namespace string, underlying cache.CacheInterface[T]) NamespacedCache[T]

+ func (n NamespacedCache[T]) Delete(ctx context.Context, key any) error

+ func (n NamespacedCache[T]) Get(ctx context.Context, key any) (T, error)

+ func (n NamespacedCache[T]) GetType() string

+ func (n NamespacedCache[T]) Set(ctx context.Context, key any, object T, options ...store.Option) error

+ type RedisConfig struct

+ DefaultExpiration config.Duration

+ Options RedisOptions

+ type RedisInstrumentationHook struct

+ func NewRedisInstrumentationHook(scope promutils.Scope) *RedisInstrumentationHook

+ func (hook RedisInstrumentationHook) DialHook(next redis.DialHook) redis.DialHook

+ func (hook RedisInstrumentationHook) ProcessHook(next redis.ProcessHook) redis.ProcessHook

+ func (hook RedisInstrumentationHook) ProcessPipelineHook(next redis.ProcessPipelineHook) redis.ProcessPipelineHook

+ type RedisOptions struct

+ Addr string

+ ClientName string

+ ConnMaxIdleTime config.Duration

+ ConnMaxLifetime config.Duration

+ ContextTimeoutEnabled bool

+ DB int

+ DialTimeout config.Duration

+ DisableIndentity bool

+ MaxActiveConns int

+ MaxIdleConns int

+ MaxRetries int

+ MaxRetryBackoff config.Duration

+ MinIdleConns int

+ MinRetryBackoff config.Duration

+ Network string

+ Password string

+ PasswordSecretName string

+ PoolFIFO bool

+ PoolSize int

+ PoolTimeout config.Duration

+ Protocol int

+ ReadTimeout config.Duration

+ TLSConfig *tls.Config

+ Username string

+ WriteTimeout config.Duration

+ func (r *RedisOptions) GetOptions(ctx context.Context, secretManager SecretManager) (*redis.Options, error)

+ type SecretManager interface

+ Get func(ctx context.Context, key string) (string, error)

+ type StringCache = cache.CacheInterface[string]

+ type Type uint8

+ const TypeInMemoryFixedSize

+ const TypeRedis

+ func TypeString(s string) (Type, error)

+ func TypeValues() []Type

+ func (i *Type) UnmarshalJSON(data []byte) error

+ func (i *Type) UnmarshalYAML(unmarshal func(interface{}) error) error

+ func (i Type) IsAType() bool

+ func (i Type) MarshalJSON() ([]byte, error)

+ func (i Type) MarshalYAML() (interface{}, error)

+ func (i Type) String() string

+ type TypedMarshaler struct

+ func NewTypedMarshaler[T any](marshaler *Marshaler) *TypedMarshaler[T]

+ func (t *TypedMarshaler[T]) Get(ctx context.Context, key any) (T, error)

+ func (t *TypedMarshaler[T]) Set(ctx context.Context, key any, object T, options ...store.Option) error

+ type UInt64Cache = cache.CacheInterface[uint64]

v2.0.0

Dec 22, 2025

Changes in this version

+ const ErrNotFound

+ type AutoRefresh interface

+ DeleteDelayed func(id ItemID) error

+ Get func(id ItemID) (Item, error)

+ GetOrCreate func(id ItemID, item Item) (Item, error)

+ Start func(ctx context.Context) error

+ func NewAutoRefreshBatchedCache(name string, createBatches CreateBatchesFunc, syncCb SyncFunc, ...) (AutoRefresh, error)

+ func NewAutoRefreshCache(name string, syncCb SyncFunc, syncRateLimiter workqueue.RateLimiter, ...) (AutoRefresh, error)

+ type Batch = []ItemWrapper

+ func SingleItemBatches(_ context.Context, snapshot []ItemWrapper) (batches []Batch, err error)

+ type CreateBatchesFunc func(ctx context.Context, snapshot []ItemWrapper) (batches []Batch, err error)

+ type InMemoryAutoRefresh struct

+ func NewInMemoryAutoRefresh(name string, syncCb SyncFunc, syncRateLimiter workqueue.RateLimiter, ...) (*InMemoryAutoRefresh, error)

+ func (w *InMemoryAutoRefresh) Delete(key interface{})

+ func (w *InMemoryAutoRefresh) DeleteDelayed(id ItemID) error

+ func (w *InMemoryAutoRefresh) Get(id ItemID) (Item, error)

+ func (w *InMemoryAutoRefresh) GetOrCreate(id ItemID, item Item) (Item, error)

+ func (w *InMemoryAutoRefresh) Start(ctx context.Context) error

+ func (w *InMemoryAutoRefresh) Update(id ItemID, item Item) (ok bool)

+ type Item interface

+ IsTerminal func() bool

+ type ItemID = string

+ type ItemSyncResponse struct

+ Action SyncAction

+ ID ItemID

+ Item Item

+ type ItemWrapper interface

+ GetID func() ItemID

+ GetItem func() Item

+ type Option func(*Options)

+ func WithClock(clock clock.WithTicker) Option

+ func WithCreateBatchesFunc(createBatchesCb CreateBatchesFunc) Option

+ func WithSyncOnCreate(syncOnCreate bool) Option

+ type Options struct

+ type SyncAction int

+ const Unchanged

+ const Update

+ type SyncFunc func(ctx context.Context, batch Batch) (updatedBatch []ItemSyncResponse, err error)

v2.0.0-alpha16

Dec 11, 2025

v2.0.0-alpha15

Dec 2, 2025

v2.0.0-alpha14

Nov 7, 2025

Other modules containing this package

github.com/flyteorg/flyte/flytestdlib