database

Documentation

Overview

Package database represents a connector to the sqlite storage backend to store persistent data from core and plugins

Index

• Variables
• func CopyObjects(src, target *gorm.DB, objects ...any) (err error)
• type Connector
  • func GetTestDatabase(t *testing.T) Connector
  • func New(driverName, connString, encryptionSecret string) (c Connector, err error)
• type LogWriter
  • func NewLogrusLogWriterWithLevel(logger *logrus.Logger, level logrus.Level, dbDriver string) LogWriter
  • func (l LogWriter) Print(a ...any)
  • func (l LogWriter) Printf(format string, a ...any)

Variables

var ErrCoreMetaNotFound = errors.New("core meta entry not found")

ErrCoreMetaNotFound is the error thrown when reading a non-existent core_kv key

Functions

func CopyObjects

func CopyObjects(src, target *gorm.DB, objects ...any) (err error)

CopyObjects is a helper to copy elements of a given type from the src to the target GORM database interface

Types

type Connector

type Connector interface {
	Close() error
	CopyDatabase(src, target *gorm.DB) error
	DB() *gorm.DB
	DeleteCoreMeta(key string) error
	ReadCoreMeta(key string, value any) error
	StoreCoreMeta(key string, value any) error
	ReadEncryptedCoreMeta(key string, value any) error
	ResetEncryptedCoreMeta() error
	StoreEncryptedCoreMeta(key string, value any) error
	DecryptField(string) (string, error)
	EncryptField(string) (string, error)
	ValidateEncryption() error
}

Connector represents a database connection having some extra convenience methods

func GetTestDatabase

func GetTestDatabase(t *testing.T) Connector

GetTestDatabase returns a Connector to an in-mem SQLite DB

func New

func New(driverName, connString, encryptionSecret string) (c Connector, err error)

New creates a new Connector with the given driver and database

type LogWriter

type LogWriter struct{ io.Writer }

LogWriter implements a logger for the gorm logging

func NewLogrusLogWriterWithLevel

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

func (LogWriter) Print

func (l LogWriter) Print(a ...any)

Print implements the gorm.Logger interface

func (LogWriter) Printf

func (l LogWriter) Printf(format string, a ...any)

Printf implements the gorm.Logger interface