dblayer

package

v0.0.0-...-1876e9c Latest Latest Go to latest Published: Dec 17, 2023 License: AGPL-3.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/barrettj12/chords

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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) ([]SongMeta, 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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL