db

Documentation

Index

• Constants
• func FindEngramHashes() (map[uint]bool, error)
• func GetItemNameFromHash(itemHash string) (string, error)
• func GetRandomJoke() (string, string, error)
• func InitDatabase() error
• func InitEnv(url string)
• func InsertUnknownValueIntoTable(value, tableName string)
• func LoadItemMetadata() (*sql.Rows, error)
• func SaveLoadout(loadoutJSON []byte, membershipID, name string) error
• func SelectLoadout(membershipID, name string) (string, error)
• func SelectLoadouts(membershipID string) ([]string, error)
• func UpdateLoadout(loadoutJSON []byte, membershipID, name string) error
• type LookupDB
  • func GetDBConnection() (*LookupDB, error)

Constants

const (
	// UnknownClassTable is the name of the table that will hold all the unknown class values provided by Alexa
	UnknownClassTable = "unknown_classes"
	// UnknownItemTable is the name of the table that will hold the unknown item name values passed by Alexa
	UnknownItemTable = "unknown_items"
)

Functions

func FindEngramHashes

func FindEngramHashes() (map[uint]bool, error)

FindEngramHashes is responsible for querying all of the item_hash values that represent engrams and returning them in a map for quick lookup later.

func GetItemNameFromHash

func GetItemNameFromHash(itemHash string) (string, error)

GetItemNameFromHash is in charge of querying the database and reading the item name value for the given item hash.

func GetRandomJoke

func GetRandomJoke() (string, string, error)

GetRandomJoke will return a setup, punchline, and possibly an error for a random Destiny related joke.

func InitDatabase

func InitDatabase() error

InitDatabase is in charge of preparing any Statements that will be commonly used as well as setting up the database connection pool.

func InitEnv

func InitEnv(url string)

InitEnv provides a package level initialization point for any work that is environment specific

func InsertUnknownValueIntoTable

func InsertUnknownValueIntoTable(value, tableName string)

InsertUnknownValueIntoTable is a helper method for inserting a value into the specified table. This is used when a value for a slot type is not usable. For example when a class name for a character is not a valid Destiny class name.

func LoadItemMetadata

func LoadItemMetadata() (*sql.Rows, error)

LoadItemMetadata will load all rows from the database for all items loaded out of the manifest. Only the required columns will be loaded into memory that need to be used later for common operations.

func SaveLoadout

func SaveLoadout(loadoutJSON []byte, membershipID, name string) error

SaveLoadout is responsible for persisting the provided serialized loadout to the database.

func SelectLoadout

func SelectLoadout(membershipID, name string) (string, error)

SelectLoadout is responsible for querying the database for a loadout with the provided membership ID and loadout name. The return value is the JSON string for the loadout requested.

func SelectLoadouts

func SelectLoadouts(membershipID string) ([]string, error)

SelectLoadouts is responsible for querying the database for a loadout with the provided membership ID and loadout name. The return value is the JSON string for the loadout requested.

func UpdateLoadout

func UpdateLoadout(loadoutJSON []byte, membershipID, name string) error

UpdateLoadout can be used to update an existing loadout by membership ID and loadout name this should be used after confirming with the user that they want to update a loadout with a spepcific name.

Types

type LookupDB

type LookupDB struct {
	Database                *sql.DB
	HashFromNameStmt        *sql.Stmt
	NameFromHashStmt        *sql.Stmt
	EngramHashStmt          *sql.Stmt
	ItemMetadataStmt        *sql.Stmt
	RandomJokeStmt          *sql.Stmt
	InsertLoadoutStmt       *sql.Stmt
	UpdateLoadoutStmt       *sql.Stmt
	SelectLoadoutStmt       *sql.Stmt
	SelectLoadoutByNameStmt *sql.Stmt
}

LookupDB is a wrapper around the database connection pool that stores the commonly used queries as prepared statements.

func GetDBConnection

func GetDBConnection() (*LookupDB, error)

GetDBConnection is a helper for getting a connection to the DB based on environment variables or some other method.