csv

Documentation

Index

• Constants
• Variables
• type CSV
  • func New(spec interface{}) (*CSV, error)
  • func (c *CSV) Changelog() string
  • func (c *CSV) Condition(source string) (bool, error)
  • func (c *CSV) ConditionFromSCM(source string, scm scm.ScmHandler) (bool, error)
  • func (c *CSV) Source(workingDir string) (string, error)
  • func (c *CSV) Target(source string, dryRun bool) (changed bool, err error)
  • func (c *CSV) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) (changed bool, files []string, message string, err error)
• type Spec
  • func (s *Spec) Validate() error

Constants

const (
	// DEFAULTSEPARATOR defines the default csv separator
	DEFAULTSEPARATOR rune = ','
	// DEFAULTCOMMENT defines the default comment character
	DEFAULTCOMMENT rune = '#'
)

Variables

var (
	ErrSpecFileUndefined       = errors.New("csv file undefined")
	ErrSpecKeyUndefined        = errors.New("csv key or query undefined")
	ErrSpecFileAndFilesDefined = errors.New("parameter \"file\" and \"files\" are mutually exclusive")
	// ErrWrongSpec is returned when the Spec has wrong content
	ErrWrongSpec error = errors.New("wrong spec content")
)

var (
	// ErrDaselFailedParsingJSONByteFormat is returned if dasel couldn't parse the byteData
	ErrDaselFailedParsingJSONByteFormat error = errors.New("fail to parse Json data")
)

var (
	ErrSpecVersionFilterRequireMultiple = errors.New("in the context of a source, parameter \"versionfilter\" and \"query\" must be used together")
)

Types

type CSV

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

CSV stores configuration about the file and the key value which needs to be updated.

func New

func New(spec interface{}) (*CSV, error)

func (*CSV) Changelog

func (c *CSV) Changelog() string

Changelog returns the changelog for this resource, or an empty string if not supported

func (*CSV) Condition

func (c *CSV) Condition(source string) (bool, error)

func (*CSV) ConditionFromSCM

func (c *CSV) ConditionFromSCM(source string, scm scm.ScmHandler) (bool, error)

func (*CSV) Source

func (c *CSV) Source(workingDir string) (string, error)

func (*CSV) Target

func (c *CSV) Target(source string, dryRun bool) (changed bool, err error)

func (*CSV) TargetFromSCM

func (c *CSV) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) (changed bool, files []string, message string, err error)

TargetFromSCM updates a scm repository based on the modified yaml file.

type Spec

type Spec struct {
	// [s][c][t] File specifies the csv file
	File string `yaml:",omitempty"`
	// [c][t] Files specifies a list of Json file to manipuate
	Files []string `yaml:",omitempty"`
	// [s][c][t] Key specifies the csv query
	Key string `yaml:",omitempty"`
	// [s][c][t] Query allows to used advanced query. Override the parameter key
	Query string `yaml:",omitempty"`
	// [s][c][t] Key specifies the csv value, default to source output
	Value string `yaml:",omitempty"`
	// [s][c][t] Comma specifies the csv separator character, default ","
	Comma rune `yaml:",omitempty"`
	// [s][c][t] Comma specifies the csv comment character, default "#"
	Comment rune `yaml:",omitempty"`
	// [c][t] *Deprecated* Please look at query parameter to achieve similar objective
	Multiple bool `yaml:",omitempty" jsonschema:"-"`
	// [s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
	VersionFilter version.Filter `yaml:",omitempty"`
}

func (*Spec) Validate

func (s *Spec) Validate() error