settings

Documentation

Index

• Variables
• type ExampleSettings
  • func (*ExampleSettings) Descriptor() ([]byte, []int)
  • func (x *ExampleSettings) GetExampleInt() int32
  • func (x *ExampleSettings) GetExampleMap() map[string]int32
  • func (x *ExampleSettings) GetExampleStr() string
  • func (*ExampleSettings) ProtoMessage()
  • func (x *ExampleSettings) ProtoReflect() protoreflect.Message
  • func (x *ExampleSettings) Reset()
  • func (x *ExampleSettings) String() string
• type KVManager
  • func NewManager(refManager graveler.RefManager, store kv.StoreMessage, ...) *KVManager
  • func (m *KVManager) Get(ctx context.Context, repository *graveler.RepositoryRecord, key string, ...) (proto.Message, error)
  • func (m *KVManager) GetLatest(ctx context.Context, repository *graveler.RepositoryRecord, key string, ...) (proto.Message, error)
  • func (m *KVManager) Save(ctx context.Context, repository *graveler.RepositoryRecord, key string, ...) error
  • func (m *KVManager) Update(ctx context.Context, repository *graveler.RepositoryRecord, key string, ...) error
  • func (m *KVManager) WithCache(cache cache.Cache)
• type ManagerOption
  • func WithCache(cache cache.Cache) ManagerOption

Variables

var File_test_settings_proto protoreflect.FileDescriptor

Types

type ExampleSettings

type ExampleSettings struct {
	ExampleInt int32            `protobuf:"varint,1,opt,name=example_int,json=exampleInt,proto3" json:"example_int,omitempty"`
	ExampleStr string           `protobuf:"bytes,2,opt,name=example_str,json=exampleStr,proto3" json:"example_str,omitempty"`
	ExampleMap map[string]int32 `` /* 180-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ExampleSettings) Descriptor

func (*ExampleSettings) Descriptor() ([]byte, []int)

Deprecated: Use ExampleSettings.ProtoReflect.Descriptor instead.

func (*ExampleSettings) GetExampleInt

func (x *ExampleSettings) GetExampleInt() int32

func (*ExampleSettings) GetExampleMap

func (x *ExampleSettings) GetExampleMap() map[string]int32

func (*ExampleSettings) GetExampleStr

func (x *ExampleSettings) GetExampleStr() string

func (*ExampleSettings) ProtoMessage

func (*ExampleSettings) ProtoMessage()

func (*ExampleSettings) ProtoReflect

func (x *ExampleSettings) ProtoReflect() protoreflect.Message

func (*ExampleSettings) Reset

func (x *ExampleSettings) Reset()

func (*ExampleSettings) String

func (x *ExampleSettings) String() string

type KVManager

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

KVManager is a key-value store for Graveler repository-level settings. Each setting is stored under a key, and can be any proto.Message. Fetched settings are cached using cache.Cache with a default expiry time of 1 second. Hence, the store is eventually consistent.

func NewManager

func NewManager(refManager graveler.RefManager, store kv.StoreMessage, options ...ManagerOption) *KVManager

func (*KVManager) Get

func (m *KVManager) Get(ctx context.Context, repository *graveler.RepositoryRecord, key string, settingTemplate proto.Message) (proto.Message, error)

Get fetches the setting under the given repository and key, and returns the result. The result is eventually consistent: it is not guaranteed to be the most up-to-date setting. The cache expiry period is 1 second. The settingTemplate parameter is used to determine the returned type.

func (*KVManager) GetLatest

func (m *KVManager) GetLatest(ctx context.Context, repository *graveler.RepositoryRecord, key string, settingTemplate proto.Message) (proto.Message, error)

func (*KVManager) Save

func (m *KVManager) Save(ctx context.Context, repository *graveler.RepositoryRecord, key string, setting proto.Message) error

Save persists the given setting under the given repository and key. Overrides settings key in KV Store

func (*KVManager) Update

func (m *KVManager) Update(ctx context.Context, repository *graveler.RepositoryRecord, key string, settingTemplate proto.Message, update updateFunc) error

Update atomically gets a setting, performs the update function, and persists the setting to the store. The settingTemplate parameter is used to determine the type passed to the update function.

func (*KVManager) WithCache

func (m *KVManager) WithCache(cache cache.Cache)

type ManagerOption

type ManagerOption func(m *KVManager)

func WithCache

func WithCache(cache cache.Cache) ManagerOption