Documentation
¶
Index ¶
- Constants
- Variables
- func GetBoltDB(vol volume.Volume) *bdb.DB
- type Bolt
- type Config
- func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *Config) CloneVT() *Config
- func (this *Config) EqualMessageVT(thatMsg any) bool
- func (this *Config) EqualVT(that *Config) bool
- func (c *Config) EqualsConfig(other config.Config) bool
- func (x *Config) GetBatchSize() uint32
- func (c *Config) GetConfigID() string
- func (x *Config) GetFreelistSync() bool
- func (x *Config) GetKvKeyOpts() *kvkey.Config
- func (x *Config) GetNoGenerateKey() bool
- func (x *Config) GetNoWriteKey() bool
- func (x *Config) GetPath() string
- func (x *Config) GetStoreConfig() *kvtx.Config
- func (x *Config) GetSync() bool
- func (x *Config) GetVerbose() bool
- func (x *Config) GetVolumeConfig() *controller.Config
- func (x *Config) MarshalJSON() ([]byte, error)
- func (x *Config) MarshalProtoJSON(s *json.MarshalState)
- func (x *Config) MarshalProtoText() string
- func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Config) MarshalToVT(dAtA []byte) (int, error)
- func (m *Config) MarshalVT() (dAtA []byte, err error)
- func (*Config) ProtoMessage()
- func (x *Config) Reset()
- func (m *Config) SizeVT() (n int)
- func (x *Config) String() string
- func (x *Config) UnmarshalJSON(b []byte) error
- func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *Config) UnmarshalVT(dAtA []byte) error
- func (c *Config) Validate() error
- type Factory
- func (t *Factory) Construct(ctx context.Context, conf config.Config, opts controller.ConstructOpts) (controller.Controller, error)
- func (t *Factory) ConstructConfig() config.Config
- func (t *Factory) GetConfigID() string
- func (t *Factory) GetControllerID() string
- func (t *Factory) GetVersion() controller.Version
Constants ¶
const ControllerID = "hydra/volume/bolt"
ControllerID identifies the Bolt volume controller.
Variables ¶
var ConfigID = ControllerID
ConfigID is the id attached to the config objects.
var Version = controller.MustParseVersion("0.0.1")
Version is the version of the bolt implementation.
Functions ¶
Types ¶
type Config ¶
type Config struct {
// Path is the file to store the data in.
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// KvKeyOpts are key/value options..
KvKeyOpts *kvkey.Config `protobuf:"bytes,2,opt,name=kv_key_opts,json=kvKeyOpts,proto3" json:"kvKeyOpts,omitempty"`
// Verbose indicates we should log every operation.
Verbose bool `protobuf:"varint,3,opt,name=verbose,proto3" json:"verbose,omitempty"`
// VolumeConfig is the volume controller config.
VolumeConfig *controller.Config `protobuf:"bytes,5,opt,name=volume_config,json=volumeConfig,proto3" json:"volumeConfig,omitempty"`
// StoreConfig is the store configuration for kvtx.
StoreConfig *kvtx.Config `protobuf:"bytes,6,opt,name=store_config,json=storeConfig,proto3" json:"storeConfig,omitempty"`
// NoGenerateKey indicates to skip generating a private key.
// This has no effect if a key already exists.
NoGenerateKey bool `protobuf:"varint,7,opt,name=no_generate_key,json=noGenerateKey,proto3" json:"noGenerateKey,omitempty"`
// NoWriteKey indicates the controller should not write a private key to
// storage if it generates one. This results in an ephemeral volume peer
// identity if there is no key present in the store already.
//
// Has no effect if the store has a peer private key.
NoWriteKey bool `protobuf:"varint,10,opt,name=no_write_key,json=noWriteKey,proto3" json:"noWriteKey,omitempty"`
// Sync indicates to sync after every write.
// Reduces write performance but increases data safety.
Sync bool `protobuf:"varint,8,opt,name=sync,proto3" json:"sync,omitempty"`
// FreelistSync enables syncing the freelist to disk.
// Reduces write performance but increases recovery performance.
FreelistSync bool `protobuf:"varint,9,opt,name=freelist_sync,json=freelistSync,proto3" json:"freelistSync,omitempty"`
// BatchSize coalesces this many write transactions into one BoltDB commit.
// Dramatically reduces fsync overhead for bulk write workloads.
// 0 or 1 disables batching (default). Typical value: 100-1000.
BatchSize uint32 `protobuf:"varint,11,opt,name=batch_size,json=batchSize,proto3" json:"batchSize,omitempty"`
// contains filtered or unexported fields
}
Config is the bolt volume controller config.
func (*Config) CloneMessageVT ¶
func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*Config) EqualMessageVT ¶
func (*Config) EqualsConfig ¶
EqualsConfig checks if the config is equal to another.
func (*Config) GetBatchSize ¶
func (*Config) GetConfigID ¶
GetConfigID returns the unique string for this configuration type. This string is stored with the encoded config.
func (*Config) GetFreelistSync ¶
func (*Config) GetKvKeyOpts ¶
func (*Config) GetNoGenerateKey ¶
func (*Config) GetNoWriteKey ¶
func (*Config) GetStoreConfig ¶
func (*Config) GetVerbose ¶
func (*Config) GetVolumeConfig ¶
func (x *Config) GetVolumeConfig() *controller.Config
func (*Config) MarshalJSON ¶
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 (*Config) MarshalToSizedBufferVT ¶
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) UnmarshalJSON ¶
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 ¶
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
Factory constructs a Bolt volume.
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 ¶
ConstructConfig constructs an instance of the controller configuration.
func (*Factory) GetConfigID ¶
GetConfigID returns the unique ID for the config.
func (*Factory) GetControllerID ¶
GetControllerID returns the unique ID for the controller.
func (*Factory) GetVersion ¶
func (t *Factory) GetVersion() controller.Version
GetVersion returns the version of this controller.