config

Documentation

Index

• type AdditionalComment
• type AdditionalRelation
• type ColumnCount
  • func (r ColumnCount) Check(s *schema.Schema) []RuleWarn
  • func (r ColumnCount) IsEnabled() bool
• type Config
  • func NewConfig() (*Config, error)
  • func (c *Config) LoadArgs(args []string) error
  • func (c *Config) LoadConfigFile(path string) error
  • func (c *Config) MergeAdditionalData(s *schema.Schema) error
• type Lint
• type RequireColumnComment
  • func (r RequireColumnComment) Check(s *schema.Schema) []RuleWarn
  • func (r RequireColumnComment) IsEnabled() bool
• type RequireTableComment
  • func (r RequireTableComment) Check(s *schema.Schema) []RuleWarn
  • func (r RequireTableComment) IsEnabled() bool
• type Rule
• type RuleWarn
• type UnrelatedTable
  • func (r UnrelatedTable) Check(s *schema.Schema) []RuleWarn
  • func (r UnrelatedTable) IsEnabled() bool

Types

type AdditionalComment

type AdditionalComment struct {
	Table          string            `yaml:"table"`
	TableComment   string            `yaml:"tableComment"`
	ColumnComments map[string]string `yaml:"columnComments"`
}

AdditionalComment is the struct for table relation from yaml

type AdditionalRelation

type AdditionalRelation struct {
	Table         string   `yaml:"table"`
	Columns       []string `yaml:"columns"`
	ParentTable   string   `yaml:"parentTable"`
	ParentColumns []string `yaml:"parentColumns"`
	Def           string   `yaml:"def"`
}

AdditionalRelation is the struct for table relation from yaml

type ColumnCount

type ColumnCount struct {
	Enabled bool     `yaml:"enabled"`
	Max     int      `yaml:"max"`
	Exclude []string `yaml:"exclude"`
}

ColumnCount check table column count

func (ColumnCount) Check

func (r ColumnCount) Check(s *schema.Schema) []RuleWarn

Check table column count

func (ColumnCount) IsEnabled

func (r ColumnCount) IsEnabled() bool

IsEnabled return Rule is enabled or not

type Config

type Config struct {
	DSN       string               `yaml:"dsn"`
	DocPath   string               `yaml:"docPath"`
	Lint      Lint                 `yaml:"lint"`
	Relations []AdditionalRelation `yaml:"relations"`
	Comments  []AdditionalComment  `yaml:"comments"`
}

Config is tbls config

func NewConfig

func NewConfig() (*Config, error)

NewConfig return Config

func (*Config) LoadArgs

func (c *Config) LoadArgs(args []string) error

LoadArgs load args slice

func (*Config) LoadConfigFile

func (c *Config) LoadConfigFile(path string) error

LoadConfigFile load config file

func (*Config) MergeAdditionalData

func (c *Config) MergeAdditionalData(s *schema.Schema) error

MergeAdditionalData merge additional* to schema.Schema

type Lint

type Lint struct {
	RequireTableComment  RequireTableComment  `yaml:"requireTableComment"`
	RequireColumnComment RequireColumnComment `yaml:"requireColumnComment"`
	UnrelatedTable       UnrelatedTable       `yaml:"unrelatedTable"`
	ColumnCount          ColumnCount          `yaml:"columnCount"`
}

Lint is the struct for lint config

type RequireColumnComment

type RequireColumnComment struct {
	Enabled        bool     `yaml:"enabled"`
	Exclude        []string `yaml:"exclude"`
	ExcludedTables []string `yaml:"excludedTables"`
}

RequireColumnComment check column comment

func (RequireColumnComment) Check

func (r RequireColumnComment) Check(s *schema.Schema) []RuleWarn

Check column comment

func (RequireColumnComment) IsEnabled

func (r RequireColumnComment) IsEnabled() bool

IsEnabled return Rule is enabled or not

type RequireTableComment

type RequireTableComment struct {
	Enabled bool     `yaml:"enabled"`
	Exclude []string `yaml:"exclude"`
}

RequireTableComment check table comment

func (RequireTableComment) Check

func (r RequireTableComment) Check(s *schema.Schema) []RuleWarn

Check table comment

func (RequireTableComment) IsEnabled

func (r RequireTableComment) IsEnabled() bool

IsEnabled return Rule is enabled or not

type Rule

type Rule interface {
	IsEnabled() bool
	Check(*schema.Schema) []RuleWarn
}

Rule is interfece of `tbls lint` cop

type RuleWarn

type RuleWarn struct {
	Message string
}

RuleWarn is struct of Rule error

type UnrelatedTable

type UnrelatedTable struct {
	Enabled bool     `yaml:"enabled"`
	Exclude []string `yaml:"exclude"`
}

UnrelatedTable check isolated table

func (UnrelatedTable) Check

func (r UnrelatedTable) Check(s *schema.Schema) []RuleWarn

Check table relation

func (UnrelatedTable) IsEnabled

func (r UnrelatedTable) IsEnabled() bool

IsEnabled return Rule is enabled or not