database

Documentation

Overview

Package database provides a wrapper around the sqlx package.

Index

• Variables
• func Connect(i Info, connectDatabase bool) error
• func Create(ci MySQLInfo) error
• func Disconnect() error
• func ResetConfig()
• type Info
  • func Config() Info
• type MySQLInfo
• type Type

Variables

var (
	// SQL wrapper
	SQL *sqlx.DB
)

Functions

func Connect

func Connect(i Info, connectDatabase bool) error

Connect to the database.

func Create

func Create(ci MySQLInfo) error

Create a new database with the charset and collation

func Disconnect

func Disconnect() error

Disconnect closes the MySQL connection.

func ResetConfig

func ResetConfig()

ResetConfig removes the config.

Types

type Info

type Info struct {
	// FileStorage is the path to the folder where uploaded files are stored
	FileStorage string
	// Type of database
	Type Type
	// MySQL info if used
	MySQL MySQLInfo
}

Info contains the database configurations.

func Config

func Config() Info

Config returns the config.

type MySQLInfo

type MySQLInfo struct {
	Username  string
	Password  string
	Database  string
	Charset   string
	Collation string
	Hostname  string
	Port      int
	Parameter string
}

MySQLInfo holds the details for the database connection.

type Type

type Type string

Type is the type of database.

const (
	// TypeMySQL is MySQL
	TypeMySQL Type = "MySQL"
)