Documentation
¶
Overview ¶
Package database represents a connector to the sqlite storage backend to store persistent data from core and plugins
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrCoreMetaNotFound = errors.New("core meta entry not found")
ErrCoreMetaNotFound is the error thrown when reading a non-existent core_kv key
Functions ¶
Types ¶
type Connector ¶
type Connector interface {
// Close closes the database connector.
Close() error
// CopyDatabase copies all core database objects from src to target.
CopyDatabase(src, target *gorm.DB) error
// DB returns the underlying GORM database handle.
DB() *gorm.DB
// DeleteCoreMeta removes a core metadata entry by key.
DeleteCoreMeta(key string) error
// ReadCoreMeta reads a JSON-encoded core metadata entry by key into value.
ReadCoreMeta(key string, value any) error
// StoreCoreMeta stores value as a JSON-encoded core metadata entry by key.
StoreCoreMeta(key string, value any) error
// ReadEncryptedCoreMeta reads an encrypted core metadata entry by key into value.
ReadEncryptedCoreMeta(key string, value any) error
// ResetEncryptedCoreMeta removes all encrypted core metadata entries.
ResetEncryptedCoreMeta() error
// StoreEncryptedCoreMeta stores value as an encrypted core metadata entry by key.
StoreEncryptedCoreMeta(key string, value any) error
// DecryptField decrypts an encrypted database field value.
DecryptField(string) (string, error)
// EncryptField encrypts a database field value.
EncryptField(string) (string, error)
// ValidateEncryption verifies the configured encryption secret against stored metadata.
ValidateEncryption() error
}
Connector represents a database connection having some extra convenience methods
func GetTestDatabase ¶
GetTestDatabase returns a Connector to an in-mem SQLite DB
type LogWriter ¶ added in v3.20.0
LogWriter implements a logger for the gorm logging
func NewLogrusLogWriterWithLevel ¶ added in v3.20.0
func NewLogrusLogWriterWithLevel(logger *logrus.Logger, level logrus.Level, dbDriver string) LogWriter
NewLogrusLogWriterWithLevel creates a new LogWriter with the given logrus.Logger and the specified logrus.Level
Click to show internal directories.
Click to hide internal directories.