meta

Documentation

Index

• Constants
• Variables
• func Register(name string, create func(Config) (Backend, error))
• type Backend
  • func NewBolt(cfg Config) (Backend, error)
  • func NewLocalStore(cfg Config) (Backend, error)
• type Bucket
  • func (b *Bucket) NewObject() Object
• type Config
• type Error
  • func (e Error) Error() string
  • func (e Error) IsNotfound() bool
• type Object
• type Store
  • func NewStore(cfg Config) (*Store, error)
  • func (s *Store) Bucket(name string) *Store
  • func (s *Store) Fetch(obj Object) error
  • func (s *Store) ForEach(handle func(Object) error) error
  • func (s *Store) Get(key string) (Object, error)
  • func (s *Store) GetWithPrefix(prefix string) ([]Object, error)
  • func (s *Store) Keys() ([]string, error)
  • func (s *Store) KeysWithPrefix(prefix string) ([]string, error)
  • func (s *Store) List() (map[string]Object, error)
  • func (s *Store) Path(key string) string
  • func (s *Store) Put(obj Object) error
  • func (s *Store) Remove(key string) error
  • func (s *Store) Shutdown() error

Constants

const DefaultStore = "local"

DefaultStore defines the default store backend.

Variables

var (
	// ErrObjectNotFound is returned when there is no object found.
	ErrObjectNotFound = Error{objNotFound, "Object not found"}

	// ErrBucketNotFound returns the error that no bucket found.
	ErrBucketNotFound = Error{bucketNotFound, "Bucket not found"}
)

var (
	// MetaJSONFile is the default name of json file.
	MetaJSONFile = "meta.json"
)

Functions

func Register

func Register(name string, create func(Config) (Backend, error))

Register registers a backend to be daemon's store.

Types

type Backend

type Backend interface {
	// Put write key-value into store.
	Put(bucket string, key string, value []byte) error

	// Get read object from store.
	Get(bucket string, key string) ([]byte, error)

	// Remove remove all data of the key.
	Remove(bucket string, key string) error

	// List return all objects with specify bucket.
	List(bucket string) ([][]byte, error)

	// Keys return all keys.
	Keys(bucket string) ([]string, error)

	// Path returns the path with the specified key.
	Path(key string) string

	// Close releases all resources used by the store
	// It does not make any changes to store.
	Close() error
}

Backend is an interface which describes what a store should support.

func NewBolt

func NewBolt(cfg Config) (Backend, error)

NewBolt is used to make bolt metadata store instance.

func NewLocalStore

func NewLocalStore(cfg Config) (Backend, error)

NewLocalStore is used to make local metadata store instance.

type Bucket

type Bucket struct {
	Name string
	Type reflect.Type
}

Bucket is a Bucket.

func (*Bucket) NewObject

func (b *Bucket) NewObject() Object

NewObject returns Object.

type Config

type Config struct {
	Driver  string
	Buckets []Bucket
	BaseDir string
}

Config represents the configurations used for metadata store.

type Error

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

Error is a type of error used for meta.

func (Error) Error

func (e Error) Error() string

Error returns the message in MetaError.

func (Error) IsNotfound

func (e Error) IsNotfound() bool

IsNotfound return true if code in MetaError is objNotfound.

type Object

type Object interface {
	Key() string
}

Object is an interface.

type Store

type Store struct {
	Config
	// contains filtered or unexported fields
}

Store defines what a metadata store should be like.

func NewStore

func NewStore(cfg Config) (*Store, error)

NewStore creates a backend storage.

func (*Store) Bucket

func (s *Store) Bucket(name string) *Store

Bucket returns a specific store instance. And name is used to specify the bucket's name that will be write.

func (*Store) Fetch

func (s *Store) Fetch(obj Object) error

Fetch uses to get meta data and decode it into 'obj'.

func (*Store) ForEach

func (s *Store) ForEach(handle func(Object) error) error

ForEach uses to handle every object by sequence.

func (*Store) Get

func (s *Store) Get(key string) (Object, error)

Get uses to get meta data.

func (*Store) GetWithPrefix

func (s *Store) GetWithPrefix(prefix string) ([]Object, error)

GetWithPrefix return objects matching prefix.

func (*Store) Keys

func (s *Store) Keys() ([]string, error)

Keys returns all keys only.

func (*Store) KeysWithPrefix

func (s *Store) KeysWithPrefix(prefix string) ([]string, error)

KeysWithPrefix return all keys matching prefix.

func (*Store) List

func (s *Store) List() (map[string]Object, error)

List returns all objects as map.

func (*Store) Path

func (s *Store) Path(key string) string

Path returns the path with specified key.

func (*Store) Put

func (s *Store) Put(obj Object) error

Put writes the 'obj' into backend storage.

func (*Store) Remove

func (s *Store) Remove(key string) error

Remove calls it to remove a object.

func (*Store) Shutdown

func (s *Store) Shutdown() error

Shutdown releases all resources used by the backend