gonfman

package module

v0.0.1 Latest Latest Go to latest Published: Mar 12, 2021 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/axkit/gonfman

Links

Open Source Insights

README ¶

gonfman

Extends axkit/gonfig to use PostgreSQL as a metadata and values storage

Database model

database model

Entities

Data Type
Control
Section
Param

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// TableNameParam holds default table name used as params/values storage.
	TableNameParam = "config_params"

	// TableNameSection holds default table name holding heirarchy of parameters.
	TableNameSection = "config_sections"

	// TableNameControl holds default table name holding ui control names.
	TableNameControl = "config_controls"

	// Mapping holds mapping between gonfig kinds and params.data_type_id.
	Mapping = map[string]gonfig.AKind{
		"int":    gonfig.AInt,
		"bool":   gonfig.ABool,
		"string": gonfig.AString,
		"float":  gonfig.AFloat,
	}
)

View Source

var ErrUnsupportedDataType = errors.New("column data_type_id has unknown value")

ErrUnsupportedDataType indicates invalid element in Mapping.

Functions ¶

This section is empty.

Types ¶

type ConfigManager ¶

type ConfigManager struct {
	// contains filtered or unexported fields
}

ConfigManager implements logic or reading application parameters from the sql database.

func New ¶

func New(db *sql.DB) *ConfigManager

New returns ConfigManager.

func (*ConfigManager) ApplyTo ¶

func (cm *ConfigManager) ApplyTo(g gonfig.Configer, ow bool) error

ApplyTo copies all rows from table TableNameParam.

func (*ConfigManager) Controls ¶

func (cm *ConfigManager) Controls() []Control

func (*ConfigManager) Init ¶

func (s *ConfigManager) Init(ctx context.Context) error

Init caches rows from config_* tables.

func (*ConfigManager) Params ¶

func (cm *ConfigManager) Params() []Param

func (*ConfigManager) Sections ¶

func (cm *ConfigManager) Sections() []Section

func (*ConfigManager) Start ¶

func (s *ConfigManager) Start(ctx context.Context) error

Start

func (*ConfigManager) UpdateParams ¶

func (cm *ConfigManager) UpdateParams(m map[string]string) error

type Control ¶

type Control struct {
	ID                       string  `json:"id"`
	ValidationFunction       *string `json:"validateFunction"`
	FailedValidationResponse *string `json:"failedValidationResponse"`
}

Control specify ui control to be used for param's value modification.

type Param ¶

type Param struct {
	ID                string    `json:"id"`
	SectionID         string    `json:"sectionID"`
	PositionOrder     int       `json:"positionOrder"`
	Name              string    `json:"name"`
	DataTypeID        string    `json:"dataTypeID"`
	ControlID         *string   `json:"controlID"`
	RawValue          string    `json:"rawValue"`
	IsReadonly        bool      `json:"isReadonly"`
	IsNullable        bool      `json:"isNullable"`
	UpdatedAt         time.Time `json:"-"`
	UpdateFingerPrint int       `json:"-"`
}

Param describes param stored in SQL database. Param's value is stored as string in RawValue field.

type Section ¶

type Section struct {
	ID            string `json:"id"`
	ParentID      string `json:"parentID"`
	PositionOrder int    `json:"positionOrder"`
	Name          string `json:"name"`
}

Section describes a hierarchy of configuration parameters.

Source Files ¶

View all Source files

gonfman.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL