connection

Documentation

Overview

Package connection is a cache which may be used by the plugin to store connection specific data, for example credentials and hydrate function results

Index

• type Cache
  • func NewCache(connectionCache *ConnectionCache) *Cache
  • func (c *Cache) Delete(key string)
  • func (c *Cache) Get(key string) (interface{}, bool)
  • func (c *Cache) Set(key string, value interface{}) bool
  • func (c *Cache) SetWithTTL(key string, value interface{}, ttl time.Duration) bool
• type ConnectionCache
  • func NewConnectionCache(connectionName string, connectionCache *cache.Cache[any]) *ConnectionCache
  • func (c *ConnectionCache) Clear(ctx context.Context)
  • func (c *ConnectionCache) Delete(ctx context.Context, key string)
  • func (c *ConnectionCache) Get(ctx context.Context, key string) (interface{}, bool)
  • func (c *ConnectionCache) Set(ctx context.Context, key string, value interface{}) error
  • func (c *ConnectionCache) SetWithTTL(ctx context.Context, key string, value interface{}, ttl time.Duration) error
• type ForceImport
• type Manager
  • func NewManager(connectionCache *ConnectionCache) *Manager

Types

type Cache

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

deprecated use ConnectionCache

func NewCache

func NewCache(connectionCache *ConnectionCache) *Cache

func (*Cache) Delete

func (c *Cache) Delete(key string)

func (*Cache) Get

func (c *Cache) Get(key string) (interface{}, bool)

func (*Cache) Set

func (c *Cache) Set(key string, value interface{}) bool

func (*Cache) SetWithTTL

func (c *Cache) SetWithTTL(key string, value interface{}, ttl time.Duration) bool

type ConnectionCache

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

ConnectionCache is a simple cache wrapper - multiple connections use the same underlying cache (owned by the plugin) ConnectionCache modifies the cache keys to include the connection name and uses the underlying shared cache

func NewConnectionCache

func NewConnectionCache(connectionName string, connectionCache *cache.Cache[any]) *ConnectionCache

func (*ConnectionCache) Clear

func (c *ConnectionCache) Clear(ctx context.Context)

Clear deletes all cache items for this connection

func (*ConnectionCache) Delete

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

func (*ConnectionCache) Get

func (c *ConnectionCache) Get(ctx context.Context, key string) (interface{}, bool)

func (*ConnectionCache) Set

func (c *ConnectionCache) Set(ctx context.Context, key string, value interface{}) error

func (*ConnectionCache) SetWithTTL

func (c *ConnectionCache) SetWithTTL(ctx context.Context, key string, value interface{}, ttl time.Duration) error

type ForceImport

type ForceImport string

ForceImport is a mechanism to ensure godoc can reference all required packages

type Manager

type Manager struct {
	Cache *Cache
}

deprecated use ConnectionCache

func NewManager

func NewManager(connectionCache *ConnectionCache) *Manager