db

package

v0.0.0-...-d9b7cdc Latest Latest Go to latest Published: Nov 4, 2019 License: MIT Imports: 10 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/znacol/camping

Documentation ¶

Index ¶

type API
type DB
- func New(username, password, schemaName, host, port string) (*DB, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

type API interface {
	SitesGet(ctx context.Context, id uint64) ([]*pb.Site, error)
	SiteUpsert(ctx context.Context, latitude float32, longitude float32, nationalForestID uint64, districtID uint64, altitude uint64, notes string) error
	NationalForestsGet(ctx context.Context, id uint64) ([]*pb.NationalForest, error)
	DistrictsGet(ctx context.Context, id uint64) ([]*pb.District, error)
}

API is the interface that the DB struct fulfills, with the methods to interact with DB. It exists to allow mocking of this package.

type DB ¶

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

func New ¶

func New(username, password, schemaName, host, port string) (*DB, error)

New returns an instantiated DB or an error if the database connection parameters don't work or it can not connect.

func (*DB) Close ¶

func (d *DB) Close() error

Close permanently closes the database connection

func (*DB) DistrictsGet ¶

func (d *DB) DistrictsGet(ctx context.Context, id uint64) ([]*pb.District, error)

DistrictsGet retrieves all districts

func (*DB) Migrate ¶

func (d *DB) Migrate(migrateDir string) error

Migrate will perform any necessary migrations on the database. The location of the migration directory will need to be passed to this, since it will probably be manually copied to the server

func (*DB) NationalForestsGet ¶

func (d *DB) NationalForestsGet(ctx context.Context, id uint64) ([]*pb.NationalForest, error)

NationalForestsGet retrieves all national forests

func (*DB) SiteUpsert ¶

func (d *DB) SiteUpsert(ctx context.Context, latitude float32, longitude float32, nationalForestID uint64, districtID uint64, altitude uint64, notes string) error

CreateSite saves a new site TODO: add upsert functionality

func (*DB) SitesGet ¶

func (d *DB) SitesGet(ctx context.Context, id uint64) ([]*pb.Site, error)

GetSites returns all campsites

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock_db Package mock_db is a generated GoMock package.	Package mock_db is a generated GoMock package.

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