storage

Documentation

Index

• Variables
• type APIKeyStorage
• type LinkStorage
• type Storage
  • func Open(conf config.StorageConfig) (_ Storage, err error)
• type StorageInfo
• type Store
  • func (s *Store) Close() error
  • func (s *Store) Counts() (c *models.Counts, err error)
  • func (s *Store) DB() *badger.DB
  • func (s *Store) Delete(key uint64) error
  • func (s *Store) List() ([]*models.ShortURL, error)
  • func (s *Store) Load(key uint64) (string, error)
  • func (s *Store) LoadInfo(key uint64) (*models.ShortURL, error)
  • func (s *Store) Register(obj *models.APIKey) error
  • func (s *Store) Retrieve(clientID string) (*models.APIKey, error)
  • func (s *Store) Save(obj *models.ShortURL) error

Variables

var (
	ErrNotFound      = errors.New("object not found in database")
	ErrAlreadyExists = errors.New("object already exists in the database")
)

Types

type APIKeyStorage

type APIKeyStorage interface {
	Register(*models.APIKey) error
	Retrieve(string) (*models.APIKey, error)
}

type LinkStorage

type LinkStorage interface {
	Save(*models.ShortURL) error
	List() ([]*models.ShortURL, error)
	Load(uint64) (string, error)
	LoadInfo(uint64) (*models.ShortURL, error)
	Delete(uint64) error
}

type Storage

type Storage interface {
	io.Closer
	LinkStorage
	APIKeyStorage
	StorageInfo
}

func Open

func Open(conf config.StorageConfig) (_ Storage, err error)

type StorageInfo

type StorageInfo interface {
	Counts() (*models.Counts, error)
}

type Store

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

func (*Store) Close

func (s *Store) Close() error

func (*Store) Counts

func (s *Store) Counts() (c *models.Counts, err error)

func (*Store) DB

func (s *Store) DB() *badger.DB

func (*Store) Delete

func (s *Store) Delete(key uint64) error

func (*Store) List

func (s *Store) List() ([]*models.ShortURL, error)

TODO: support pagination when listing links.

func (*Store) Load

func (s *Store) Load(key uint64) (string, error)

func (*Store) LoadInfo

func (s *Store) LoadInfo(key uint64) (*models.ShortURL, error)

func (*Store) Register

func (s *Store) Register(obj *models.APIKey) error

func (*Store) Retrieve

func (s *Store) Retrieve(clientID string) (*models.APIKey, error)

func (*Store) Save

func (s *Store) Save(obj *models.ShortURL) error