Documentation
¶
Overview ¶
Package db provides database connectivity and operations for OpenList
Index ¶
- Variables
- func AutoMigrate(models ...any) error
- func BatchCreateSearchNodes(nodes *[]model.SearchNode) error
- func ClearSearchNodes() error
- func Close()
- func CreateMeta(u *model.Meta) error
- func CreateSSHPublicKey(k *model.SSHPublicKey) error
- func CreateSearchNode(node *model.SearchNode) error
- func CreateStorage(storage *model.Storage) error
- func CreateTaskData(t *model.TaskItem) error
- func CreateUser(u *model.User) error
- func DeleteMetaByID(id uint) error
- func DeleteSSHPublicKeyByID(id uint) error
- func DeleteSearchNodesByParent(path string) error
- func DeleteSettingItemByKey(key string) error
- func DeleteStorageByID(id uint) error
- func DeleteUserByID(id uint) error
- func GetDB() *gorm.DB
- func GetEnabledStorages() ([]model.Storage, error)
- func GetMetaByID(id uint) (*model.Meta, error)
- func GetMetaByPath(path string) (*model.Meta, error)
- func GetMetas(pageIndex, pageSize int) (metas []model.Meta, count int64, err error)
- func GetPublicSettingItems() ([]model.SettingItem, error)
- func GetSSHPublicKeyByID(id uint) (*model.SSHPublicKey, error)
- func GetSSHPublicKeyByUserID(userID uint, pageIndex, pageSize int) (keys []model.SSHPublicKey, count int64, err error)
- func GetSSHPublicKeyByUserTitle(userID uint, title string) (*model.SSHPublicKey, error)
- func GetSSHPublicKeys(pageIndex, pageSize int) (keys []model.SSHPublicKey, count int64, err error)
- func GetSearchNodesByParent(parent string) ([]model.SearchNode, error)
- func GetSettingItemByKey(key string) (*model.SettingItem, error)
- func GetSettingItems() ([]model.SettingItem, error)
- func GetSettingItemsByGroup(group int) ([]model.SettingItem, error)
- func GetSettingItemsInGroups(groups []int) ([]model.SettingItem, error)
- func GetStorageByID(id uint) (*model.Storage, error)
- func GetStorageByMountPath(mountPath string) (*model.Storage, error)
- func GetStorages(pageIndex, pageSize int) ([]model.Storage, int64, error)
- func GetTaskDataByType(taskType string) (*model.TaskItem, error)
- func GetTaskDataFunc(taskType string, enabled bool) func() ([]byte, error)
- func GetUserByID(id uint) (*model.User, error)
- func GetUserByName(username string) (*model.User, error)
- func GetUserByRole(role int) (*model.User, error)
- func GetUserBySSOID(ssoID string) (*model.User, error)
- func GetUsers(pageIndex, pageSize int) (users []model.User, count int64, err error)
- func Init(d *gorm.DB)
- func RegisterAuthn(u *model.User, credential *webauthn.Credential) error
- func RemoveAuthn(u *model.User, id string) error
- func SaveSettingItem(item *model.SettingItem) error
- func SaveSettingItems(items []model.SettingItem) (err error)
- func SearchNode(req model.SearchReq, useFullText bool) ([]model.SearchNode, int64, error)
- func UpdateAuthn(userID uint, authn string) error
- func UpdateMeta(u *model.Meta) error
- func UpdateSSHPublicKey(k *model.SSHPublicKey) error
- func UpdateStorage(storage *model.Storage) error
- func UpdateTaskData(t *model.TaskItem) error
- func UpdateTaskDataFunc(taskType string, enabled bool) func([]byte) error
- func UpdateUser(u *model.User) error
Constants ¶
This section is empty.
Variables ¶
var ( // ErrDatabaseNotInitialized is returned when a database operation is attempted before initialization ErrDatabaseNotInitialized = errors.New("database not initialized") )
Error definitions
Functions ¶
func AutoMigrate ¶
AutoMigrate performs database schema migrations for the given models Applies special options for MySQL databases to ensure proper charset and engine Parameters:
- models: list of model structs to migrate
Returns:
- error if migration fails
func BatchCreateSearchNodes ¶
func BatchCreateSearchNodes(nodes *[]model.SearchNode) error
func ClearSearchNodes ¶
func ClearSearchNodes() error
func Close ¶
func Close()
Close properly closes the database connection Should be called when the application is shutting down
func CreateMeta ¶
func CreateSSHPublicKey ¶
func CreateSSHPublicKey(k *model.SSHPublicKey) error
func CreateSearchNode ¶
func CreateSearchNode(node *model.SearchNode) error
func CreateStorage ¶
CreateStorage just insert storage to database
func CreateTaskData ¶
func CreateUser ¶
func DeleteMetaByID ¶ added in v4.2.5
func DeleteSSHPublicKeyByID ¶ added in v4.2.5
func DeleteSettingItemByKey ¶
func DeleteStorageByID ¶ added in v4.2.5
DeleteStorageByID just delete storage from database by id
func DeleteUserByID ¶ added in v4.2.5
func GetDB ¶
GetDB returns the current database connection Can be used to perform custom database operations Returns nil if the database has not been initialized
func GetEnabledStorages ¶
func GetPublicSettingItems ¶
func GetPublicSettingItems() ([]model.SettingItem, error)
func GetSSHPublicKeyByID ¶ added in v4.2.5
func GetSSHPublicKeyByID(id uint) (*model.SSHPublicKey, error)
func GetSSHPublicKeyByUserID ¶ added in v4.2.5
func GetSSHPublicKeyByUserTitle ¶
func GetSSHPublicKeyByUserTitle(userID uint, title string) (*model.SSHPublicKey, error)
func GetSSHPublicKeys ¶
func GetSSHPublicKeys(pageIndex, pageSize int) (keys []model.SSHPublicKey, count int64, err error)
func GetSearchNodesByParent ¶
func GetSearchNodesByParent(parent string) ([]model.SearchNode, error)
func GetSettingItemByKey ¶
func GetSettingItemByKey(key string) (*model.SettingItem, error)
func GetSettingItems ¶
func GetSettingItems() ([]model.SettingItem, error)
func GetSettingItemsByGroup ¶
func GetSettingItemsByGroup(group int) ([]model.SettingItem, error)
func GetSettingItemsInGroups ¶
func GetSettingItemsInGroups(groups []int) ([]model.SettingItem, error)
func GetStorageByID ¶ added in v4.2.5
GetStorageByID Get Storage by id, used to update storage usually
func GetStorageByMountPath ¶
GetStorageByMountPath Get Storage by mountPath, used to update storage usually
func GetStorages ¶
GetStorages Get all storages from database order by index
func Init ¶
Init initializes the database connection and performs schema migrations Parameters:
- d: database connection instance
The function will terminate the application if migrations fail
func RegisterAuthn ¶
func RegisterAuthn(u *model.User, credential *webauthn.Credential) error
func SaveSettingItem ¶
func SaveSettingItem(item *model.SettingItem) error
func SaveSettingItems ¶
func SaveSettingItems(items []model.SettingItem) (err error)
func SearchNode ¶
func UpdateAuthn ¶
func UpdateMeta ¶
func UpdateSSHPublicKey ¶
func UpdateSSHPublicKey(k *model.SSHPublicKey) error
func UpdateStorage ¶
UpdateStorage just update storage in database
func UpdateTaskData ¶
func UpdateUser ¶
Types ¶
This section is empty.