base

Documentation

Overview

Package base defines the names and variables that have global scope throughout which can be used in other subpackages

Index

• Constants
• Variables

Constants

const APIVersion = "v1"

APIVersion sets the version of API in paths

const CEEMSDBName = "ceems.db"

CEEMSDBName is the name of CEEMS DB file

const CEEMSServerAppName = "ceems_api_server"

CEEMSServerAppName is kingpin app name

Variables

var (
	UnitsDBTableName      = models.Unit{}.TableName()
	UsageDBTableName      = models.Usage{}.TableName()
	ProjectsDBTableName   = models.Project{}.TableName()
	UsersDBTableName      = models.User{}.TableName()
	AdminUsersDBTableName = models.AdminUsers{}.TableName()
)

DB table names

var (
	UnitsDBTableColNames      = models.Unit{}.TagNames("sql")
	UsageDBTableColNames      = models.Usage{}.TagNames("sql")
	ProjectsDBTableColNames   = models.Project{}.TagNames("sql")
	UsersDBTableColNames      = models.User{}.TagNames("sql")
	AdminUsersDBTableColNames = models.AdminUsers{}.TagNames("sql")
)

Slice of all field names of Unit struct

var (
	UnitsDBTableStructFieldColNameMap      = models.Unit{}.TagMap("", "sql")
	UsageDBTableStructFieldColNameMap      = models.Usage{}.TagMap("", "sql")
	ProjectsDBTableStructFieldColNameMap   = models.Project{}.TagMap("", "sql")
	UsersDBTableStructFieldColNameMap      = models.User{}.TagMap("", "sql")
	AdminUsersDBTableStructFieldColNameMap = models.AdminUsers{}.TagMap("", "sql")
)

Map of struct field name to DB column name

var (
	UnitsDBTableColTypeMap      = models.Unit{}.TagMap("sql", "sqlitetype")
	UsageDBTableColTypeMap      = models.Usage{}.TagMap("sql", "sqlitetype")
	ProjectsDBTableColTypeMap   = models.Project{}.TagMap("sql", "sqlitetype")
	UsersDBTableColTypeMap      = models.User{}.TagMap("sql", "sqlitetype")
	AdminUsersDBTableColTypeMap = models.AdminUsers{}.TagMap("sql", "sqlitetype")
)

Map of DB column names to DB column type

var CEEMSServerApp = *kingpin.New(
	CEEMSServerAppName,
	"API server for reporting usage statistics for batchjobs/VMs/Pods.",
)

CEEMSServerApp is kinpin app

var (
	ConfigFilePath string
)

CLI args with global scope

var DatetimeLayout = fmt.Sprintf("%sT%s", time.DateOnly, time.TimeOnly)

DatetimeLayout to be used in the package

var (
	InvalidIDRegex = regexp.MustCompile("[^a-zA-Z0-9-_]")
)

Cluster and Updater ID valid regex