dbabstraction

Documentation

Index

• Constants
• type Database
  • func GetNew(config models.DbConnection) (Database, error)

Constants

const (
	// TypeSqlite specifies to use an SQLite database
	TypeSqlite = iota
	// TypeRedis specifies to use a Redis database
	TypeRedis
)

Types

type Database

type Database interface {
	// GetType returns identifier of the underlying interface
	GetType() int

	// Upgrade migrates the DB to a new Gokapi version, if required
	Upgrade(currentDbVersion int)
	// RunGarbageCollection runs the databases GC
	RunGarbageCollection()
	// Close the database connection
	Close()

	// GetDbVersion gets the version number of the database
	GetDbVersion() int
	// SetDbVersion sets the version number of the database
	SetDbVersion(newVersion int)
	// GetSchemaVersion returns the version number, that the database should be if fully upgraded
	GetSchemaVersion() int

	// GetAllApiKeys returns a map with all API keys
	GetAllApiKeys() map[string]models.ApiKey
	// GetApiKey returns a models.ApiKey if valid or false if the ID is not valid
	GetApiKey(id string) (models.ApiKey, bool)
	// SaveApiKey saves the API key to the database
	SaveApiKey(apikey models.ApiKey)
	// UpdateTimeApiKey writes the content of LastUsage to the database
	UpdateTimeApiKey(apikey models.ApiKey)
	// DeleteApiKey deletes an API key with the given ID
	DeleteApiKey(id string)

	// SaveEnd2EndInfo stores the encrypted e2e info
	SaveEnd2EndInfo(info models.E2EInfoEncrypted)
	// GetEnd2EndInfo retrieves the encrypted e2e info
	GetEnd2EndInfo() models.E2EInfoEncrypted
	// DeleteEnd2EndInfo resets the encrypted e2e info
	DeleteEnd2EndInfo()

	// GetHotlink returns the id of the file associated or false if not found
	GetHotlink(id string) (string, bool)
	// GetAllHotlinks returns an array with all hotlink ids
	GetAllHotlinks() []string
	// SaveHotlink stores the hotlink associated with the file in the database
	SaveHotlink(file models.File)
	// DeleteHotlink deletes a hotlink with the given hotlink ID
	DeleteHotlink(id string)

	// GetAllMetadata returns a map of all available files
	GetAllMetadata() map[string]models.File
	// GetAllMetaDataIds returns all Ids that contain metadata
	GetAllMetaDataIds() []string
	// GetMetaDataById returns a models.File from the ID passed or false if the id is not valid
	GetMetaDataById(id string) (models.File, bool)
	// SaveMetaData stores the metadata of a file to the disk
	SaveMetaData(file models.File)
	// DeleteMetaData deletes information about a file
	DeleteMetaData(id string)

	// GetSession returns the session with the given ID or false if not a valid ID
	GetSession(id string) (models.Session, bool)
	// SaveSession stores the given session. After the expiry passed, it will be deleted automatically
	SaveSession(id string, session models.Session)
	// DeleteSession deletes a session with the given ID
	DeleteSession(id string)
	// DeleteAllSessions logs all users out
	DeleteAllSessions()

	// GetUploadDefaults returns the last used setting for amount of downloads allowed, last expiry in days and
	// a password for the file
	GetUploadDefaults() (models.LastUploadValues, bool)
	// SaveUploadDefaults saves the last used setting for an upload
	SaveUploadDefaults(values models.LastUploadValues)
	// GetUploadStatus returns a models.UploadStatus from the ID passed or false if the id is not valid
	GetUploadStatus(id string) (models.UploadStatus, bool)
	// GetAllUploadStatus returns all UploadStatus values from the past 24 hours
	GetAllUploadStatus() []models.UploadStatus
	// SaveUploadStatus stores the upload status of a new file for 24 hours
	SaveUploadStatus(status models.UploadStatus)
}

Database declares the required functions for a database connection

func GetNew

func GetNew(config models.DbConnection) (Database, error)

GetNew connects to the given database and initialises it