Documentation ¶
Overview ¶
Package db contains persistence functions to store and query data for the server.
Index ¶
- type Datastore
- func (ds Datastore) AddUser(username string, p Password) error
- func (ds Datastore) ClearStat(st SportType) error
- func (ds Datastore) GetFriends(st SportType) ([]Friend, error)
- func (ds Datastore) GetPlayerTypes() (PlayerTypeMap, error)
- func (ds Datastore) GetPlayers(st SportType) ([]Player, error)
- func (ds Datastore) GetSportTypes() (SportTypeMap, error)
- func (ds Datastore) GetStat(st SportType) (*Stat, error)
- func (Datastore) GetUtcTime() time.Time
- func (ds Datastore) GetYears(st SportType) ([]Year, error)
- func (ds Datastore) IsCorrectUserPassword(username string, p Password) (bool, error)
- func (ds *Datastore) LimitPlayerTypes(playerTypesCsv string) error
- func (ds Datastore) PlayerTypes() PlayerTypeMap
- func (ds Datastore) SaveFriends(st SportType, futureFriends []Friend) error
- func (ds Datastore) SavePlayers(st SportType, futurePlayers []Player) error
- func (ds Datastore) SaveYears(st SportType, futureYears []Year) error
- func (ds Datastore) SetAdminPassword(p Password) error
- func (ds Datastore) SetStat(stat Stat) error
- func (ds Datastore) SetUserPassword(username string, p Password) error
- func (ds Datastore) SportTypes() SportTypeMap
- type Friend
- type ID
- type Password
- type Player
- type PlayerType
- type PlayerTypeInfo
- type PlayerTypeMap
- type SourceID
- type SportType
- type SportTypeInfo
- type SportTypeMap
- type Stat
- type Year
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Datastore ¶
type Datastore struct {
// contains filtered or unexported fields
}
Datastore interface can be used to access and persist data
func NewDatastore ¶
NewDatastore creates a new sqlDatastore
func (Datastore) GetFriends ¶
GetFriends gets the friends for the active year for a SportType
func (Datastore) GetPlayerTypes ¶
func (ds Datastore) GetPlayerTypes() (PlayerTypeMap, error)
GetPlayerTypes loads the PlayerTypes from the database
func (Datastore) GetPlayers ¶
GetPlayers gets the players for the active year for a SportType
func (Datastore) GetSportTypes ¶
func (ds Datastore) GetSportTypes() (SportTypeMap, error)
GetSportTypes returns the SportTypes from the database
func (Datastore) GetStat ¶
GetStat gets the Stat for the active year, nil if there is not active stat
func (Datastore) GetUtcTime ¶
GetUtcTime retrieves the current UTC time
func (Datastore) IsCorrectUserPassword ¶
IsCorrectUserPassword determines whether the password for the user is correct
func (*Datastore) LimitPlayerTypes ¶
LimitPlayerTypes reduces the player types to those in the specified csv. Also limits the sport types to those for the specified player types. Note that this function mutates the supplied maps.
func (Datastore) PlayerTypes ¶
func (ds Datastore) PlayerTypes() PlayerTypeMap
PlayerTypes implements the PlayerTypeGetter interface for Datastore
func (Datastore) SaveFriends ¶
SaveFriends saves the specified friends for the active year for a SportType
func (Datastore) SavePlayers ¶
SavePlayers saves the specified players for the active year for a SportType
func (Datastore) SaveYears ¶
SaveYears saves the specified years and sets the active year for a SportType
func (Datastore) SetAdminPassword ¶
SetAdminPassword sets the admin password If the admin user does not exist, it is created.
func (Datastore) SetStat ¶
SetStat sets the etl timestamp and json for the year (which must be active)
func (Datastore) SetUserPassword ¶
SetUserPassword gets the password for the specified user
func (Datastore) SportTypes ¶
func (ds Datastore) SportTypes() SportTypeMap
SportTypes implements the SportTypeGetter interface for Datastore
type ID ¶
type ID string
ID is used to identify an item in the database or a relation to another noun's id
type Player ¶
type Player struct { ID ID PlayerType PlayerType SourceID SourceID FriendID ID DisplayOrder int }
Player maps a player (of a a specific PlayerType) to a Friend.
type PlayerType ¶
type PlayerType int
PlayerType is an enumeration of types of players
const ( PlayerTypeMlbTeam PlayerType = 1 PlayerTypeMlbHitter PlayerType = 2 PlayerTypeMlbPitcher PlayerType = 3 PlayerTypeNflTeam PlayerType = 4 PlayerTypeNflQB PlayerType = 5 PlayerTypeNflMisc PlayerType = 6 )
The expected PlayerTypes
type PlayerTypeInfo ¶
type PlayerTypeInfo struct { SportType SportType Name string Description string ScoreType string DisplayOrder int }
PlayerTypeInfo contains supplementary information about a PlayerType
type PlayerTypeMap ¶
type PlayerTypeMap map[PlayerType]PlayerTypeInfo
PlayerTypeMap contains information about multiple PlayerTypes and their PlayerTypeInfos
type SourceID ¶
type SourceID int
SourceID is the id used to retrieve information about the player from external sources
type SportTypeInfo ¶
SportTypeInfo contains supplementary information about a SportType
type SportTypeMap ¶
type SportTypeMap map[SportType]SportTypeInfo
SportTypeMap contains information about multiple SportTypes and their SportTypeInfos