database

type Event string

type Result = map[string]interface{} // One dynamically shaped database result

type ResultSeries = []Result // Ordered set of database results

type ResultSeriesStats = map[string]ResultSeries // Result series grouped by a handler-defined statistic

type T_event struct {
	// - Set the JSON ignore flag (json:"-") for sensitive columns that may NEVER be leaked by a JSON response.
	// - Make columns "not null" if possible. Otherwise, use null-types (e.g. sql.NullString).
	// - Avoid 'default' constraints or gorm will replace empty values (0, "", false) with set default values on CREATE!
	// - Define a lower-snake-case json name for every attribute.
	Id          uint64    `gorm:"column:id;primaryKey" json:"-"`
	IdTUser     uint64    `gorm:"column:id_t_user;type:int" json:"-"`
	Email       string    `gorm:"column:email;not null" json:"email"`
	Timestamp   time.Time `gorm:"column:timestamp;default:CURRENT_TIMESTAMP" json:"timestamp"`
	Event       Event     `gorm:"column:event;not null" json:"event"`
	EventDetail string    `gorm:"column:event_detail;default:''" json:"event_detail"`

	User *T_user `gorm:"foreignKey:IdTUser;constraint:OnUpdate:CASCADE,OnDelete:SET NULL" json:"user"` // User must be pointer *T_user, because it can be null OnDelete
}

type T_group struct {
	// - Set the JSON ignore flag (json:"-") for sensitive columns that may NEVER be leaked by a JSON response.
	// - Make columns "not null" if possible. Otherwise, use null-types (e.g. sql.NullString).
	// - Avoid 'default' constraints or gorm will replace empty values (0, "", false) with set default values on CREATE!
	// - Define a lower-snake-case json name for every attribute.
	Id         uint64    `gorm:"column:id;primaryKey" json:"id"`
	Name       string    `gorm:"column:name;not null" json:"name"`
	Created    time.Time `gorm:"column:created;not null;default:CURRENT_TIMESTAMP" json:"created"`
	CreatedBy  string    `gorm:"column:created_by;not null" json:"created_by"`
	DbServerId uint64    `gorm:"column:db_server_id;not null;default:1" json:"db_server_id"`
	MaxScopes  int       `gorm:"column:max_scopes;not null" json:"max_scopes"`
	MaxViews   int       `gorm:"column:max_views;not null" json:"max_views"`
	MaxTargets int       `gorm:"column:max_targets;not null" json:"max_targets"`
	MaxOwners  int       `gorm:"column:max_owners;not null" json:"max_owners"`

	AllowCustom  bool `gorm:"column:allow_custom;not null;default:true" json:"allow_custom"`
	AllowNetwork bool `gorm:"column:allow_network;not null;default:false" json:"allow_network"`
	AllowAsset   bool `gorm:"column:allow_asset;not null;default:false" json:"allow_asset"`

	Ownerships []T_ownership `gorm:"foreignKey:IdTGroup;constraint:OnUpdate:CASCADE,OnDelete:CASCADE" json:"ownerships"`
}

type T_ownership struct {
	// "uniqueIndex" is a workaround to introduce a "unique" mechanism across multiple columns (group id and user id)
	Id       uint64 `gorm:"column:id;primaryKey" json:"id"`
	IdTGroup uint64 `gorm:"column:id_t_group;type:int;not null;uniqueIndex:idx_group_user"` // SQLITE3 does only support FK via type definition https://github.com/go-gorm/gorm/issues/765 https://www.sqlite.org/foreignkeys.html
	IdTUser  uint64 `gorm:"column:id_t_user;type:int;not null;uniqueIndex:idx_group_user"`  // SQLITE3 does only support FK via type definition https://github.com/go-gorm/gorm/issues/765 https://www.sqlite.org/foreignkeys.html

	Group T_group `gorm:"foreignKey:IdTGroup" json:"group"`
	User  T_user  `gorm:"foreignKey:IdTUser" json:"user"`
}

type T_user struct {
	// - Set the JSON ignore flag (json:"-") for sensitive columns that may NEVER be leaked by a JSON response.
	// - Make columns "not null" if possible. Otherwise, use null-types (e.g. sql.NullString).
	// - Avoid 'default' constraints or gorm will replace empty values (0, "", false) with set default values on CREATE!
	// - Define a lower-snake-case json name for every attribute.
	Id               uint64         `gorm:"column:id;primaryKey" json:"id"`
	Email            string         `gorm:"column:email;not null;unique" json:"email"`             // User ID. Notification e-mail == user ID, to make sure this is always in sync
	Password         sql.NullString `gorm:"column:password" json:"-"`                              // Password hash for users not using a dedicated authenticator, such as oauth SSO. Empty password indicates other authentication mechanism.
	Company          string         `gorm:"column:company;not null" json:"company"`                // Field to mark users of the same company, as those will be able to see each other
	Department       string         `gorm:"column:department;default:'';" json:"department"`       // Field to support distinguishing users of a company from different departments
	Gid              string         `gorm:"column:gid;default:''" json:"-"`                        // Global user ID, e.g. within the company. May be util e.g. to query asset inventories.
	Created          time.Time      `gorm:"column:created;not null" json:"created"`                //
	LastLogin        time.Time      `gorm:"column:last_login;not null" json:"last_login"`          // Last time an access token was requested
	LogoutCount      uint           `gorm:"column:logout_count;default:0" json:"-"`                // A counter incremented on each logout and incorporated into every JWT token to invalidate previously issued ones ahead of time.
	ApiTokenRevision uint           `gorm:"column:api_token_revision;default:0;not null" json:"-"` // A counter incremented on each API token issuance to invalidate previously issued API tokens.
	Active           bool           `gorm:"column:active;not null" json:"active"`                  //
	Admin            bool           `gorm:"column:admin;not null" json:"admin"`                    //
	Name             string         `gorm:"column:name;not null" json:"name"`                      //
	Surname          string         `gorm:"column:surname;not null" json:"surname"`                //
	Gender           string         `gorm:"column:gender;default:''" json:"gender"`                // Gender could be either M/W/D, but can also be left empty
	Demo             bool           `gorm:"column:demo;not null;default:false" json:"demo"`        // Whether the user is allowed to view modules but not execute them
	Certificate      []byte         `gorm:"column:certificate;not null" json:"certificate"`        // User's public key to allow sending encrypted messages
	DbPasswordHash   string         `gorm:"column:db_password;default:''" json:"-"`                // Hashed password generated by the system and used as the user's temporary password to access database views. This hash is injected into the database user object, to avoid clear-text password handling.

	Ownerships []T_ownership `gorm:"foreignKey:IdTUser;constraint:OnUpdate:CASCADE,OnDelete:CASCADE" json:"ownerships"`
}