schema

Documentation

Index

• type Col
• type SchemaRules
  • func ParseSchema(schemaFile string) SchemaRules
  • func (s *SchemaRules) IsFixed(colnames []string)
  • func (s *SchemaRules) IsOrdered(colnames []string)
• type Status
  • func (s Status) String() string

Types

type Col

type Col struct {
	Name        string
	Rule        string
	Description string
	Status      Status

	NErrs  int
	NNA    int
	NEMPTY int
	NVALID int
}

type SchemaRules

type SchemaRules struct {
	// Directives
	Separater    rune
	ExactColumns int
	// Checks
	CheckOrdered bool
	Ordered      bool
	CheckFixed   bool
	Fixed        bool
	ExtraCols    []string
	// Other
	Comment  rune
	Errors   int      // count of schema-specific errors
	NA       []string // NA values
	EMPTY    []string // empty values
	YAMLData map[string]interface{}

	// Columns
	Columns []Col

	// Output configuration
	OutputOrder string // by data input or by schema
}

func ParseSchema

func ParseSchema(schemaFile string) SchemaRules

Parse Schema - Entrypoint

func (*SchemaRules) IsFixed

func (s *SchemaRules) IsFixed(colnames []string)

IsFixed - test whether column names match exactly

func (*SchemaRules) IsOrdered

func (s *SchemaRules) IsOrdered(colnames []string)

IsOrdered - test whether column names are in the same order as the schema.

type Status

type Status int

Define the column status

func (Status) String

func (s Status) String() string