db

Documentation

Index

• func Init() error
• type Database
  • func New() *Database
  • func (DB *Database) AddEvents(events *ctftime.Events) error
  • func (DB *Database) Close()
  • func (DB *Database) DeleteEventByID(eventID int) error
  • func (DB *Database) GetEvents() (ctftime.Events, error)
  • func (DB *Database) GetEventsByStatus(status utils.Status) (ctftime.Events, error)
  • func (DB *Database) GetRegisteredChannels() ([]string, error)
  • func (DB *Database) ModifyEventStatus(eventID int, status utils.Status) error
  • func (DB *Database) Ping()
  • func (DB *Database) RegisterForNotifs(ChannelID string) error

Functions

func Init

func Init() error

Init is used to initialize the SQL Database

Types

type Database

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

Database is a wrapper around the SQL database to allow addition of methods

func New

func New() *Database

New returns an instance of Database Use this when you don't want to clear the DB

func (*Database) AddEvents

func (DB *Database) AddEvents(events *ctftime.Events) error

AddEvents adds a slice of Events in the database

func (*Database) Close

func (DB *Database) Close()

Close closes the connetion to the database, can call this with defer in main

func (*Database) DeleteEventByID

func (DB *Database) DeleteEventByID(eventID int) error

DeleteEventByID deletes the event with ID eventID

func (*Database) GetEvents

func (DB *Database) GetEvents() (ctftime.Events, error)

GetEvents returns Events from the database

func (*Database) GetEventsByStatus

func (DB *Database) GetEventsByStatus(status utils.Status) (ctftime.Events, error)

GetEventsByStatus returns events depending upon the Status attribute

func (*Database) GetRegisteredChannels

func (DB *Database) GetRegisteredChannels() ([]string, error)

GetRegisteredChannels returns all ChannelIDs from the notify table

func (*Database) ModifyEventStatus

func (DB *Database) ModifyEventStatus(eventID int, status utils.Status) error

ModifyEventStatus modifies the status of the event identified by the eventID

func (*Database) Ping

func (DB *Database) Ping()

Ping allows you to ping the database and check if connection is possible

func (*Database) RegisterForNotifs

func (DB *Database) RegisterForNotifs(ChannelID string) error

RegisterForNotifs adds a Channel to the notify table