configmigrate

Documentation

Overview

Package configmigrate provides a way to upgrade the YAML configuration file.

Index

• Constants
• type Config
• type Migrator
  • func New(cfg *Config) (m *Migrator)
  • func (m *Migrator) Migrate(body []byte, target uint) (newBody []byte, upgraded bool, err error)

Constants

const LastSchemaVersion uint = 28

LastSchemaVersion is the most recent schema version.

Types

type Config

type Config struct {
	// WorkingDir is an absolute path to the working directory of AdGuardHome.
	WorkingDir string
}

Config is a the configuration for initializing a Migrator.

type Migrator

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

Migrator performs the YAML configuration file migrations.

func New

func New(cfg *Config) (m *Migrator)

New creates a new Migrator.

func (*Migrator) Migrate

func (m *Migrator) Migrate(body []byte, target uint) (newBody []byte, upgraded bool, err error)

Migrate preforms necessary upgrade operations to upgrade file to target schema version, if needed. It returns the body of the upgraded config file, whether the file was upgraded, and an error, if any. If upgraded is false, the body is the same as the input.