db

Documentation

Index

• Variables
• func CloseDB() error
• func ConfigurePath()
• func ConfigurePathErr() error
• func EmptyCatalogue() error
• func GetDB() *gorm.DB
• func InitDB() error
• func PutInGame(id int, title, data string) error
• func Shutdown()
• func UpsertTokenRecord(token *Token) error
• type Game
  • func GetCatalogue() ([]Game, error)
  • func GetGameByID(id int) (*Game, error)
  • func SearchGamesByName(name string) ([]Game, error)
• type GameRepository
  • func NewGameRepository(db *gorm.DB) GameRepository
• type Token
  • func GetTokenRecord() (*Token, error)
• type TokenRepository
  • func NewTokenRepository(db *gorm.DB) TokenRepository

Variables

var (
	Db   *gorm.DB
	Path string
)

Database variables

Functions

func CloseDB

func CloseDB() error

CloseDB closes the database connection. It returns an error if the database connection fails to close.

func ConfigurePath

func ConfigurePath()

ConfigurePath determines and sets the database path based on environment variables. It is public to allow for re-evaluation during testing.

func ConfigurePathErr

func ConfigurePathErr() error

ConfigurePathErr is like ConfigurePath but returns an error instead of calling log.Fatal.

func EmptyCatalogue

func EmptyCatalogue() error

EmptyCatalogue removes all records from the game catalogue. It returns an error if the operation fails. Deprecated: Use GameRepository.Clear with context for better cancellation support.

func GetDB

func GetDB() *gorm.DB

GetDB provides read-only access to the underlying *gorm.DB reference.

func InitDB

func InitDB() error

InitDB initializes the database and creates the tables if they don't exist. It returns an error if any step in the initialization process fails.

func PutInGame

func PutInGame(id int, title, data string) error

PutInGame inserts or updates a game record in the catalogue. It takes the game ID, title, and data as parameters and returns an error if the operation fails. Deprecated: Use GameRepository.Put with context for better cancellation support.

func Shutdown

func Shutdown()

Shutdown closes the database ignoring the error (for interrupt handling).

func UpsertTokenRecord

func UpsertTokenRecord(token *Token) error

UpsertTokenRecord inserts or updates the token record in the database. Deprecated: Use TokenRepository.Upsert with context for better cancellation support.

Types

type Game

type Game struct {
	ID    int    `gorm:"primaryKey" json:"id"`
	Title string `gorm:"index" json:"title"` // Indexed for faster queries
	Data  string `json:"data"`
}

Game represents a game record in the catalogue.

func GetCatalogue

func GetCatalogue() ([]Game, error)

GetCatalogue retrieves all games in the catalogue. It returns a slice of Game objects and an error if the operation fails. Deprecated: Use GameRepository.List with context for better cancellation support.

func GetGameByID

func GetGameByID(id int) (*Game, error)

GetGameByID retrieves a game from the catalogue by its ID. It takes the game ID as a parameter and returns a pointer to the Game object and an error if the operation fails. Deprecated: Use GameRepository.GetByID with context for better cancellation support.

func SearchGamesByName

func SearchGamesByName(name string) ([]Game, error)

SearchGamesByName searches for games in the catalogue by name. It takes the game name as a parameter and returns a slice of Game objects and an error if the operation fails. Deprecated: Use GameRepository.SearchByTitle with context for better cancellation support.

type GameRepository

type GameRepository interface {
	Put(ctx context.Context, g Game) error
	GetByID(ctx context.Context, id int) (*Game, error)
	List(ctx context.Context) ([]Game, error)
	SearchByTitle(ctx context.Context, titleSubstr string) ([]Game, error)
	Clear(ctx context.Context) error
}

GameRepository defines decoupled operations for game persistence.

func NewGameRepository

func NewGameRepository(db *gorm.DB) GameRepository

NewGameRepository creates a GameRepository. Accepts *gorm.DB to avoid global access.

type Token

type Token struct {
	ID           uint   `gorm:"primaryKey;uniqueIndex"`
	AccessToken  string `json:"access_token,omitempty"`
	RefreshToken string `json:"refresh_token,omitempty"`
	ExpiresAt    string `json:"expires_at,omitempty"`
}

Token represents the persisted auth tokens. Currently we enforce a single-row table by always upserting record with ID=1. A unique index on ID is implicit via primary key. Future multi-user support could drop this constraint and add a user scoping column.

func GetTokenRecord

func GetTokenRecord() (*Token, error)

GetTokenRecord retrieves the token record from the database. Deprecated: Use TokenRepository.Get with context for better cancellation support.

type TokenRepository

type TokenRepository interface {
	Get(ctx context.Context) (*Token, error)
	Upsert(ctx context.Context, token *Token) error
}

TokenRepository defines decoupled operations for token persistence.

func NewTokenRepository

func NewTokenRepository(db *gorm.DB) TokenRepository

NewTokenRepository creates a TokenRepository. Accepts *gorm.DB to avoid global access.