dblayer

Documentation

Index

• func Fill(db ChordsDB) error
• func NewLocalfs(basedir string, logger *log.Logger) *localfs
• func NewPostgres(url string) (*postgres, error)
• func NewTempDB() *tempDB
• type Chords
• type ChordsDB
  • func GetDB(url string, logger *log.Logger) (ChordsDB, error)
• type SongMeta

Functions

func Fill

func Fill(db ChordsDB) error

Fill fills a ChordsDB with some sample data - good for demonstration and/or testing.

func NewLocalfs

func NewLocalfs(basedir string, logger *log.Logger) *localfs

func NewPostgres

func NewPostgres(url string) (*postgres, error)

NewPostgres creates and initialises a Postgres DB at the given URL.

func NewTempDB

func NewTempDB() *tempDB

Return a correctly initialised tempDB.

Types

type Chords

type Chords []byte

type ChordsDB

type ChordsDB interface {
	GetArtists() ([]string, error)
	GetSongs(artist, id, query string) ([]SongMeta, error)
	NewSong(SongMeta) (SongMeta, error)
	UpdateSong(id string, meta SongMeta) (SongMeta, error)
	DeleteSong(id string) error
	GetChords(id string) (Chords, error)
	UpdateChords(id string, chords Chords) (Chords, error)
	SeeAlso(artist string) ([]string, error)
	Search(query string) ([]types.SearchResult, error)
}

ChordsDB is the data abstraction used for the chords v0 API.

func GetDB

func GetDB(url string, logger *log.Logger) (ChordsDB, error)

type SongMeta

type SongMeta = types.SongMeta