block_store_redis

package
v0.51.4 Latest Latest
Warning

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

 Go to latest Published: May 9, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const ConfigID = ControllerID

ConfigID is the string used to identify this config object.

View Source 
const ControllerID = "hydra/block/store/redis"

ControllerID identifies the redis block store controller.

Variables

View Source 
var Version = semver.MustParse("0.0.1")

Version is the version of the block store implementation.

Functions

func NewBlockStoreBuilder 

func NewBlockStoreBuilder(le *logrus.Entry, conf *Config) block_store_controller.BlockStoreBuilder

NewBlockStoreBuilder constructs a new block store builder from config.

Types

type Config 

type Config struct {

	// BlockStoreId is the block store id to use on the bus.
	BlockStoreId string `protobuf:"bytes,1,opt,name=block_store_id,json=blockStoreId,proto3" json:"blockStoreId,omitempty"`
	// Client configures the redis client.
	Client *redis.ClientConfig `protobuf:"bytes,2,opt,name=client,proto3" json:"client,omitempty"`
	// KvKeyOpts are key/value key constants.
	// Optional.
	KvKeyOpts *kvkey.Config `protobuf:"bytes,3,opt,name=kv_key_opts,json=kvKeyOpts,proto3" json:"kvKeyOpts,omitempty"`
	// ForceHashType forces writing the given hash type to the store.
	// If unset, accepts any hash type.
	ForceHashType hash.HashType `protobuf:"varint,4,opt,name=force_hash_type,json=forceHashType,proto3" json:"forceHashType,omitempty"`
	// DisableHashGet disables hashing values for Get requests.
	// This improves performance if the underlying store is trusted & consistent.
	//
	// If the store may return invalid data or mismatch the requested block ref,
	// do not enable this option. It is important to hash the data for each read.
	DisableHashGet bool `protobuf:"varint,8,opt,name=disable_hash_get,json=disableHashGet,proto3" json:"disableHashGet,omitempty"`
	// BucketIds is a list of bucket ids to serve LookupBlockFromNetwork directives.
	BucketIds []string `protobuf:"bytes,5,rep,name=bucket_ids,json=bucketIds,proto3" json:"bucketIds,omitempty"`
	// SkipNotFound skips returning a value if the block was not found.
	SkipNotFound bool `protobuf:"varint,6,opt,name=skip_not_found,json=skipNotFound,proto3" json:"skipNotFound,omitempty"`
	// Verbose enables verbose logging of the block store.
	Verbose bool `protobuf:"varint,7,opt,name=verbose,proto3" json:"verbose,omitempty"`
	// contains filtered or unexported fields
}

Config configures the Redis block store controller.

func NewConfig 

func NewConfig(blockStoreId string, clientConfig *store_kvtx_redis.ClientConfig) *Config

NewConfig constructs a new config.

func (*Config) CloneMessageVT 

func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Config) CloneVT 

func (m *Config) CloneVT() *Config

func (*Config) EqualMessageVT 

func (this *Config) EqualMessageVT(thatMsg any) bool

func (*Config) EqualVT 

func (this *Config) EqualVT(that *Config) bool

func (*Config) EqualsConfig 

func (c *Config) EqualsConfig(other config.Config) bool

EqualsConfig checks if the config is equal to another.

func (*Config) GetBlockStoreId 

func (x *Config) GetBlockStoreId() string

func (*Config) GetBucketIds 

func (x *Config) GetBucketIds() []string

func (*Config) GetClient 

func (x *Config) GetClient() *redis.ClientConfig

func (*Config) GetConfigID 

func (c *Config) GetConfigID() string

GetConfigID returns the unique string for this configuration type.

func (*Config) GetDisableHashGet 

func (x *Config) GetDisableHashGet() bool

func (*Config) GetForceHashType 

func (x *Config) GetForceHashType() hash.HashType

func (*Config) GetKvKeyOpts 

func (x *Config) GetKvKeyOpts() *kvkey.Config

func (*Config) GetSkipNotFound 

func (x *Config) GetSkipNotFound() bool

func (*Config) GetVerbose 

func (x *Config) GetVerbose() bool

func (*Config) MarshalJSON 

func (x *Config) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Config to JSON.

func (*Config) MarshalProtoJSON 

func (x *Config) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Config message to JSON.

func (*Config) MarshalProtoText 

func (x *Config) MarshalProtoText() string

func (*Config) MarshalToSizedBufferVT 

func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Config) MarshalToVT 

func (m *Config) MarshalToVT(dAtA []byte) (int, error)

func (*Config) MarshalVT 

func (m *Config) MarshalVT() (dAtA []byte, err error)

func (*Config) ProtoMessage 

func (*Config) ProtoMessage()

func (*Config) Reset 

func (x *Config) Reset()

func (*Config) SizeVT 

func (m *Config) SizeVT() (n int)

func (*Config) String 

func (x *Config) String() string

func (*Config) UnmarshalJSON 

func (x *Config) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Config from JSON.

func (*Config) UnmarshalProtoJSON 

func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Config message from JSON.

func (*Config) UnmarshalVT 

func (m *Config) UnmarshalVT(dAtA []byte) error

func (*Config) Validate 

func (c *Config) Validate() error

Validate validates the configuration.

type Controller 

type Controller = block_store_controller.Controller

Controller implements the redis block store controller.

func NewController 

func NewController(le *logrus.Entry, conf *Config) *Controller

NewController builds a new redis block store controller.

type Factory 

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

Factory constructs the redis block store.

func NewFactory 

func NewFactory(bus bus.Bus) *Factory

NewFactory builds the factory.

func (*Factory) Construct 

func (t *Factory) Construct(
	ctx context.Context,
	conf config.Config,
	opts controller.ConstructOpts,
) (controller.Controller, error)

Construct constructs the associated controller given configuration.

func (*Factory) ConstructConfig 

func (t *Factory) ConstructConfig() config.Config

ConstructConfig constructs an instance of the controller configuration.

func (*Factory) GetConfigID 

func (t *Factory) GetConfigID() string

GetConfigID returns the configuration ID for the controller.

func (*Factory) GetControllerID 

func (t *Factory) GetControllerID() string

GetControllerID returns the unique ID for the controller.

func (*Factory) GetVersion 

func (t *Factory) GetVersion() semver.Version

GetVersion returns the version of this controller.

type RedisBlock 

type RedisBlock = block_store_kvtx.KVTxBlock

RedisBlock is a block store on top of a Redis database. Stores blocks at {objectPrefix}/{block ref}

func NewRedisBlock 

func NewRedisBlock(
	kvk *kvkey.KVKey,
	st *store_kvtx_redis.Store,
	forceHashType hash.HashType,
	hashGet bool,
) *RedisBlock

NewRedisBlock builds a new block store on top of a redis db.

forceHashType can be 0 to use the default hash type. hashGet hashes Get requests for integrity, use if the storage is unreliable or untrusted.

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.