db

README

db

This package is used internally to make working with the database feel less painful.

Documentation

Overview

db sets up our database connection and exposes functions and methods to make working with data easier

Index

• Variables
• func LoadSQLite(filename string) error
• func NewOutfit(Name, CID, LeaderSlack string, c *census.Census)
• func NewReport(reporter, player, PSN, info string, c *census.Census) error
• type Outfit
  • func GetOutfit(CID string) *Outfit
• type Report
  • func GetReport(ID int) *Report
  • func (r *Report) ToggleClear()

Variables

var DB *gorm.DB

Functions

func LoadSQLite

func LoadSQLite(filename string) error

LoadSQLite loads the database as SQLite this should be used for local testing

func NewOutfit

func NewOutfit(Name, CID, LeaderSlack string, c *census.Census)

func NewReport

func NewReport(reporter, player, PSN, info string, c *census.Census) error

NewReport creates a new report with the provided information

Additionally, it creates an outfit instance if possible to reference if we need to.

Types

type Outfit

type Outfit struct {
	gorm.Model
	Name        string
	CID         string // CID is the ID given to it by census.
	LeaderSlack string // This is the username of the user in Slack

}

Outfit...

func GetOutfit

func GetOutfit(CID string) *Outfit

type Report

type Report struct {
	gorm.Model
	Reporter       string
	Name           string
	PSNName        string `gorm:"column:psn_name"`
	AdditionalInfo string
	OutfitCID      string `gorm:"column:outfit_cid"` // The outfit the user was in at the time of the report
	Cleared        bool
}

Report ...

func GetReport

func GetReport(ID int) *Report

GetReport gets a report by the ID

func (*Report) ToggleClear

func (r *Report) ToggleClear()

ToggleClear toggles the Cleared value in the database.