objstore

Documentation

Index

• Constants
• func NewDevice(ctx context.Context, container stow.Container, cacheDir string, ...) (usbdlib.Device, error)
• func NewStore(kind string, config stow.Config) (stow.Location, error)
• func SupportsMetaData(kind string) bool
• func ValidateConfig(kind string, config stow.Config) error
• type OptAutoflushIval
• type OptCompressRemoteObjects
• type OptConcurFlushCount
• type OptEncrypt
• type OptNoMetadataSupport
• type OptPersistCache
• type OptQuotaBytes
• type OptThickProvisionLocalFiles
• type Option

Constants

const (
	KindAzure               = azure.Kind
	KindBackBlazeB2         = b2.Kind
	KindGoogleCloudStorage  = google.Kind
	KindLocalTest           = local.Kind
	KindS3                  = s3.Kind
	KindOracleObjectStorage = oracle.Kind
	KindSFTP                = sftp.Kind
	KindSwift               = swift.Kind
)

The list of all the known ObjectStore (stow.Location) kinds without having to import the driver package for each.

Functions

func NewDevice

func NewDevice(ctx context.Context, container stow.Container, cacheDir string, totalBytes, objectBytes uint, options ...Option) (usbdlib.Device, error)

NewDevice is the constructor for ObjectStore backed devices

func NewStore

func NewStore(kind string, config stow.Config) (stow.Location, error)

NewStore dials stow storage. See stow.Dial for more info

func SupportsMetaData

func SupportsMetaData(kind string) bool

SupportsMetaData returns false if the provided ObjectStore kind is known to not support metadata

func ValidateConfig

func ValidateConfig(kind string, config stow.Config) error

ValidateConfig verifies config parameters. See stow.Validate for more info

Types

type OptAutoflushIval

type OptAutoflushIval time.Duration

OptAutoflushIval instructs an ObjectStore device to flush every interval

type OptCompressRemoteObjects

type OptCompressRemoteObjects compress.Mode

OptCompressRemoteObjects instructs an ObjectStore device to use the provided compression mode

type OptConcurFlushCount

type OptConcurFlushCount uint

OptConcurFlushCount instructs an ObjectStore device to use this many concurrent workers this has memory usage implications (workers * objectsize)

type OptEncrypt

type OptEncrypt struct {
	Mode encrypt.Mode
	Key  []byte
}

OptEncrypt instructs an ObjectStore device to use the provided AES encryption mode

type OptNoMetadataSupport

type OptNoMetadataSupport bool

OptNoMetadataSupport instructs an ObjectStore device reject configurations that require the provided stow.Location to support metadata. (ex. Compression)

type OptPersistCache

type OptPersistCache bool

OptPersistCache instructs an ObjectStore device to not clean up its local disk cache files. Primarily for debugging, but also a performance optimization if no other machines are allowed to mutate the remote objects.

type OptQuotaBytes

type OptQuotaBytes int64

OptQuotaBytes instructs an ObjectStore device to limit the cache backed local disk to an amount less than the full size of the device

type OptThickProvisionLocalFiles

type OptThickProvisionLocalFiles bool

OptThickProvisionLocalFiles instructs an ObjectStore device to not use sparse files for local caching

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is an ObjectStore device option