Documentation
¶
Index ¶
- Constants
- type Engine
- func (e *Engine) CreateSettings(ctx context.Context, s *settings.Platform) (*settings.Platform, error)
- func (e *Engine) CreateSettingsTable(ctx context.Context, driver string) error
- func (e *Engine) GetSettings(ctx context.Context) (*settings.Platform, error)
- func (e *Engine) UpdateSettings(ctx context.Context, s *settings.Platform) (*settings.Platform, error)
- type EngineOpt
- type SettingsInterface
Constants ¶
View Source
const ( // CreatePostgresTable represents a query to create the Postgres settings table. CreatePostgresTable = `` /* 418-byte string literal not displayed */ // CreateSqliteTable represents a query to create the Sqlite settings table. CreateSqliteTable = `` /* 441-byte string literal not displayed */ )
View Source
const (
TableSettings = "settings"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Engine ¶ added in v0.27.0
type Engine struct {
// contains filtered or unexported fields
}
Engine represents the settings functionality that implements the SettingsInterface interface.
func (*Engine) CreateSettings ¶ added in v0.27.0
func (e *Engine) CreateSettings(ctx context.Context, s *settings.Platform) (*settings.Platform, error)
CreateSettings creates a platform settings record in the database.
func (*Engine) CreateSettingsTable ¶ added in v0.27.0
CreateSettingsTable creates the settings table in the database.
func (*Engine) GetSettings ¶ added in v0.27.0
GetSettings gets platform settings from the database.
type EngineOpt ¶
EngineOpt represents a configuration option to initialize the database engine for Settings.
func WithClient ¶
WithClient sets the gorm.io/gorm client in the database engine for Settings.
func WithContext ¶
WithContext sets the context in the database engine for Settings.
func WithLogger ¶
WithLogger sets the github.com/sirupsen/logrus logger in the database engine for Settings.
func WithSkipCreation ¶
WithSkipCreation sets the skip creation logic in the database engine for Settings.
type SettingsInterface ¶
type SettingsInterface interface {
// CreateSettings defines a function that creates a platform settings record.
CreateSettings(context.Context, *settings.Platform) (*settings.Platform, error)
// GetSettings defines a function that gets platform settings.
GetSettings(context.Context) (*settings.Platform, error)
// UpdateSettings defines a function that updates platform settings.
UpdateSettings(context.Context, *settings.Platform) (*settings.Platform, error)
}
Source Files
Click to show internal directories.
Click to hide internal directories.