db

Documentation

Index

• type DB
  • func GetDB() DB
  • func GetDBWithCustomAuth(address, username, password string) DB

Types

type DB

type DB interface {
	/* crud functions */
	// building
	CreateBuilding(building structs.Building) (structs.Building, error)
	GetBuilding(id string) (structs.Building, error)
	UpdateBuilding(id string, building structs.Building) (structs.Building, error)
	DeleteBuilding(id string) error

	// room
	CreateRoom(room structs.Room) (structs.Room, error)
	GetRoom(id string) (structs.Room, error)
	UpdateRoom(id string, room structs.Room) (structs.Room, error)
	DeleteRoom(id string) error
	GetRoomAttachments(room string) ([]string, error)

	// device
	CreateDevice(device structs.Device) (structs.Device, error)
	GetDevice(id string) (structs.Device, error)
	UpdateDevice(id string, device structs.Device) (structs.Device, error)
	DeleteDevice(id string) error

	// device state
	GetDeviceState(string) (statedefinition.StaticDevice, error)

	// device type
	CreateDeviceType(dt structs.DeviceType) (structs.DeviceType, error)
	GetDeviceType(id string) (structs.DeviceType, error)
	UpdateDeviceType(id string, dt structs.DeviceType) (structs.DeviceType, error)
	DeleteDeviceType(id string) error

	// room configuration
	CreateRoomConfiguration(rc structs.RoomConfiguration) (structs.RoomConfiguration, error)
	GetRoomConfiguration(id string) (structs.RoomConfiguration, error)
	UpdateRoomConfiguration(id string, rc structs.RoomConfiguration) (structs.RoomConfiguration, error)
	DeleteRoomConfiguration(id string) error

	// ui configs
	CreateUIConfig(roomID string, ui structs.UIConfig) (structs.UIConfig, error)
	GetUIConfig(roomID string) (structs.UIConfig, error)
	UpdateUIConfig(id string, ui structs.UIConfig) (structs.UIConfig, error)
	DeleteUIConfig(id string) error
	GetUIAttachment(ui, attachment string) (string, []byte, error)

	// lab configs
	GetLabConfig(roomID string) (structs.LabConfig, error)

	// schedule configs
	GetScheduleConfig(roomID string) (structs.ScheduleConfig, error)

	/* bulk functions */
	GetAllBuildings() ([]structs.Building, error)
	GetAllRooms() ([]structs.Room, error)
	GetAllDevices() ([]structs.Device, error)
	GetAllDeviceTypes() ([]structs.DeviceType, error)
	GetAllDeviceStates() ([]statedefinition.StaticDevice, error)
	GetAllRoomConfigurations() ([]structs.RoomConfiguration, error)
	GetAllUIConfigs() ([]structs.UIConfig, error)
	CreateBulkDevices([]structs.Device) []structs.BulkUpdateResponse // TODO change the response struct

	/* Specialty functions */
	GetDevicesByRoom(roomID string) ([]structs.Device, error)
	GetDeviceStatesByRoom(roomID string) ([]statedefinition.StaticDevice, error)
	GetDeviceStatesByBuilding(buildingID string) ([]statedefinition.StaticDevice, error)
	GetDevicesByRoomAndType(roomID, typeID string) ([]structs.Device, error)
	GetDevicesByRoomAndRole(roomID, roleID string) ([]structs.Device, error)
	GetDevicesByRoleAndType(roleID, typeID string) ([]structs.Device, *nerr.E)
	GetDevicesByRoleAndTypeAndDesignation(roleID, typeID, designation string) ([]structs.Device, *nerr.E)

	GetRoomsByBuilding(id string) ([]structs.Room, error)
	GetRoomsByDesignation(designation string) ([]structs.Room, *nerr.E)

	/* dmps functions */
	GetDMPSList() (structs.DMPSList, error)

	/* Options Functions */
	GetTemplate(id string) (structs.UIConfig, error)
	GetAllTemplates() ([]structs.Template, error)
	UpdateTemplate(id string, newTemp structs.UIConfig) (structs.UIConfig, error)
	GetIcons() ([]string, error)
	UpdateIcons(iconList []string) ([]string, error)
	GetDeviceRoles() ([]structs.Role, error)
	UpdateDeviceRoles(roles []structs.Role) ([]structs.Role, error)
	GetRoomDesignations() ([]string, error)
	UpdateRoomDesignations(desigs []string) ([]string, error)
	GetClosureCodes() ([]string, error)
	UpdateClosureCodes(desigs []string) ([]string, error)
	GetTags() ([]string, error)
	UpdateTags(newTags []string) ([]string, error)
	GetMenuTree() ([]string, error)

	GetAttributeGroup(groupID string) (structs.Group, error)
	GetAllAttributeGroups() ([]structs.Group, error)

	/* Deployment Info Functions  */
	GetDeploymentInfo(serviceID string) (structs.FullConfig, error)
	GetDeviceDeploymentInfo(deviceType string) (structs.DeviceDeploymentConfig, error)
	GetServiceInfo(serviceID string) (structs.ServiceConfigWrapper, error)
	GetServiceAttachment(service, designation string) ([]byte, error)
	GetServiceZip(service, designation string) ([]byte, error)

	GetAuth() (structs.Auth, error)

	//Get the state (replication/readiness) of the database
	GetStatus() (string, error)
}

DB .

func GetDB

func GetDB() DB

GetDB returns the instance of the database to use.

func GetDBWithCustomAuth

func GetDBWithCustomAuth(address, username, password string) DB

GetDBWithCustomAuth returns an instance of the database with a custom authentication