meta

README

Meta layer

Storage metadata manipulation helper functions for YIG, including a cache layer for HBase, build on Redis.

Move more methods into this package as more patterns emerge

Documentation

Index

• Constants
• func LifeCycleFromBucket(b Bucket) (lc LifeCycle)
• type CacheType
• type Meta
  • func New(logger *log.Logger, myCacheType CacheType) *Meta
  • func (m *Meta) AddBucketForUser(bucketName string, userId string) (err error)
  • func (m *Meta) DeleteObjMapEntry(objMap *ObjMap) error
  • func (m *Meta) DeleteObjectEntry(object *Object) error
  • func (m *Meta) GetAllObject(bucketName string, objectName string) (object []*Object, err error)
  • func (m *Meta) GetBucket(bucketName string, willNeed bool) (bucket Bucket, err error)
  • func (m *Meta) GetBucketInfo(bucketName string) (Bucket, error)
  • func (m *Meta) GetCluster(fsid string, pool string) (cluster Cluster, err error)
  • func (m *Meta) GetMultipart(bucketName, objectName, uploadId string) (multipart Multipart, err error)
  • func (m *Meta) GetObject(bucketName string, objectName string, willNeed bool) (object *Object, err error)
  • func (m *Meta) GetObjectMap(bucketName, objectName string) (objMap *ObjMap, err error)
  • func (m *Meta) GetObjectVersion(bucketName, objectName, version string, willNeed bool) (object *Object, err error)
  • func (m *Meta) GetUsage(bucketName string) (int64, error)
  • func (m *Meta) GetUserBuckets(userId string, willNeed bool) (buckets []string, err error)
  • func (m *Meta) GetUserInfo(uid string) ([]string, error)
  • func (m *Meta) PutBucketToLifeCycle(bucket Bucket) error
  • func (m *Meta) PutObjMapEntry(objMap *ObjMap) error
  • func (m *Meta) PutObjectEntry(object *Object) error
  • func (m *Meta) PutObjectToGarbageCollection(object *Object) error
  • func (m *Meta) RemoveBucketForUser(bucketName string, userId string) (err error)
  • func (m *Meta) RemoveBucketFromLifeCycle(bucket Bucket) error
  • func (m *Meta) RemoveGarbageCollection(garbage GarbageCollection) error
  • func (m *Meta) ScanGarbageCollection(limit int, startRowKey string) ([]GarbageCollection, error)
  • func (m *Meta) ScanLifeCycle(limit int, marker string) (result ScanLifeCycleResult, err error)
  • func (m *Meta) UpdateObjectAcl(object *Object) error
  • func (m *Meta) UpdateUsage(bucketName string, size int64)
• type MetaCache

Constants

const (
	BUCKET_NUMBER_LIMIT = 100
)

const (
	ENCRYPTION_KEY_LENGTH = 32 // 32 bytes for AES-"256"
)

Functions

func LifeCycleFromBucket

func LifeCycleFromBucket(b Bucket) (lc LifeCycle)

Types

type CacheType

type CacheType int

const (
	NoCache CacheType = iota
	EnableCache
	SimpleCache
)

type Meta

type Meta struct {
	Client client.Client
	Logger *log.Logger
	Cache  MetaCache
}

func New

func New(logger *log.Logger, myCacheType CacheType) *Meta

func (*Meta) AddBucketForUser

func (m *Meta) AddBucketForUser(bucketName string, userId string) (err error)

func (*Meta) DeleteObjMapEntry

func (m *Meta) DeleteObjMapEntry(objMap *ObjMap) error

func (*Meta) DeleteObjectEntry

func (m *Meta) DeleteObjectEntry(object *Object) error

func (*Meta) GetAllObject

func (m *Meta) GetAllObject(bucketName string, objectName string) (object []*Object, err error)

func (*Meta) GetBucket

func (m *Meta) GetBucket(bucketName string, willNeed bool) (bucket Bucket, err error)

Note the usage info got from this method is possibly not accurate because we don't invalid cache when updating usage. For accurate usage info, use `GetUsage()`

func (*Meta) GetBucketInfo

func (m *Meta) GetBucketInfo(bucketName string) (Bucket, error)

func (*Meta) GetCluster

func (m *Meta) GetCluster(fsid string, pool string) (cluster Cluster, err error)

func (*Meta) GetMultipart

func (m *Meta) GetMultipart(bucketName, objectName, uploadId string) (multipart Multipart, err error)

func (*Meta) GetObject

func (m *Meta) GetObject(bucketName string, objectName string, willNeed bool) (object *Object, err error)

func (*Meta) GetObjectMap

func (m *Meta) GetObjectMap(bucketName, objectName string) (objMap *ObjMap, err error)

func (*Meta) GetObjectVersion

func (m *Meta) GetObjectVersion(bucketName, objectName, version string, willNeed bool) (object *Object, err error)

func (*Meta) GetUsage

func (m *Meta) GetUsage(bucketName string) (int64, error)

func (*Meta) GetUserBuckets

func (m *Meta) GetUserBuckets(userId string, willNeed bool) (buckets []string, err error)

func (*Meta) GetUserInfo

func (m *Meta) GetUserInfo(uid string) ([]string, error)

func (*Meta) PutBucketToLifeCycle

func (m *Meta) PutBucketToLifeCycle(bucket Bucket) error

func (*Meta) PutObjMapEntry

func (m *Meta) PutObjMapEntry(objMap *ObjMap) error

func (*Meta) PutObjectEntry

func (m *Meta) PutObjectEntry(object *Object) error

func (*Meta) PutObjectToGarbageCollection

func (m *Meta) PutObjectToGarbageCollection(object *Object) error

Insert object to `garbageCollection` table

func (*Meta) RemoveBucketForUser

func (m *Meta) RemoveBucketForUser(bucketName string, userId string) (err error)

func (*Meta) RemoveBucketFromLifeCycle

func (m *Meta) RemoveBucketFromLifeCycle(bucket Bucket) error

func (*Meta) RemoveGarbageCollection

func (m *Meta) RemoveGarbageCollection(garbage GarbageCollection) error

func (*Meta) ScanGarbageCollection

func (m *Meta) ScanGarbageCollection(limit int, startRowKey string) ([]GarbageCollection, error)

func (*Meta) ScanLifeCycle

func (m *Meta) ScanLifeCycle(limit int, marker string) (result ScanLifeCycleResult, err error)

func (*Meta) UpdateObjectAcl

func (m *Meta) UpdateObjectAcl(object *Object) error

func (*Meta) UpdateUsage

func (m *Meta) UpdateUsage(bucketName string, size int64)

type MetaCache

type MetaCache interface {
	Get(table redis.RedisDatabase, key string,
		onCacheMiss func() (interface{}, error),
		unmarshaller func([]byte) (interface{}, error), willNeed bool) (value interface{}, err error)
	Remove(table redis.RedisDatabase, key string)
	GetCacheHitRatio() float64
}