config

Documentation

Index

• Constants
• Variables
• type AdditionalComment
• type AdditionalRelation
• type ColumnCount
  • func (r ColumnCount) Check(s *schema.Schema, exclude []string) []RuleWarn
  • func (r ColumnCount) IsEnabled() bool
• type Config
  • func NewConfig() (*Config, error)
  • func (c *Config) FilterTables(s *schema.Schema) error
  • func (c *Config) Load(configPath string, options ...Option) error
  • func (c *Config) LoadConfigFile(path string) error
  • func (c *Config) LoadEnviron() error
  • func (c *Config) MaskedDSN() (string, error)
  • func (c *Config) MergeAdditionalData(s *schema.Schema) error
  • func (c *Config) ModifySchema(s *schema.Schema) error
• type DuplicateRelations
  • func (r DuplicateRelations) Check(s *schema.Schema, exclude []string) []RuleWarn
  • func (r DuplicateRelations) IsEnabled() bool
• type ER
• type Format
• type Lint
• type Option
  • func Adjust(adjust bool) Option
  • func DSN(dsn string) Option
  • func Distance(distance int) Option
  • func DocPath(docPath string) Option
  • func ERFormat(erFormat string) Option
  • func ERSkip(skip bool) Option
  • func Sort(sort bool) Option
• type RequireColumnComment
  • func (r RequireColumnComment) Check(s *schema.Schema, exclude []string) []RuleWarn
  • func (r RequireColumnComment) IsEnabled() bool
• type RequireColumns
  • func (r RequireColumns) Check(s *schema.Schema, exclude []string) []RuleWarn
  • func (r RequireColumns) IsEnabled() bool
• type RequireColumnsColumn
• type RequireForeignKeyIndex
  • func (r RequireForeignKeyIndex) Check(s *schema.Schema, exclude []string) []RuleWarn
  • func (r RequireForeignKeyIndex) IsEnabled() bool
• type RequireTableComment
  • func (r RequireTableComment) Check(s *schema.Schema, exclude []string) []RuleWarn
  • func (r RequireTableComment) IsEnabled() bool
• type Rule
• type RuleWarn
• type UnrelatedTable
  • func (r UnrelatedTable) Check(s *schema.Schema, exclude []string) []RuleWarn
  • func (r UnrelatedTable) IsEnabled() bool

Constants

const DefaultERFormat = "png"

DefaultERFormat is the default ER diagram format

Variables

var DefaultDistance = 1

DefaultDistance is the default distance between tables that display relations in the ER

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 checks table column count

func (ColumnCount) Check

func (r ColumnCount) Check(s *schema.Schema, exclude []string) []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"`
	Format      Format               `yaml:"format"`
	ER          ER                   `yaml:"er"`
	Include     []string             `yaml:"include"`
	Exclude     []string             `yaml:"exclude"`
	Lint        Lint                 `yaml:"lint"`
	LintExclude []string             `yaml:"lintExclude"`
	Relations   []AdditionalRelation `yaml:"relations"`
	Comments    []AdditionalComment  `yaml:"comments"`
}

Config is tbls config

func NewConfig

func NewConfig() (*Config, error)

NewConfig return Config

func (*Config) FilterTables

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

FilterTables filter tables from schema.Schema

func (*Config) Load

func (c *Config) Load(configPath string, options ...Option) error

Load load config with all method

func (*Config) LoadConfigFile

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

LoadConfigFile load config file

func (*Config) LoadEnviron

func (c *Config) LoadEnviron() error

LoadEnviron load environment variables

func (*Config) MaskedDSN

func (c *Config) MaskedDSN() (string, error)

MaskedDSN return DSN mask password

func (*Config) MergeAdditionalData

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

MergeAdditionalData merge additional* to schema.Schema

func (*Config) ModifySchema

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

ModifySchema modify schema.Schema by config

type DuplicateRelations

type DuplicateRelations struct {
	Enabled bool `yaml:"enabled"`
}

DuplicateRelations checks duplicate table relations

func (DuplicateRelations) Check

func (r DuplicateRelations) Check(s *schema.Schema, exclude []string) []RuleWarn

Check duplicate table relations

func (DuplicateRelations) IsEnabled

func (r DuplicateRelations) IsEnabled() bool

IsEnabled return Rule is enabled or not

type ER

type ER struct {
	Skip     bool   `yaml:"skip"`
	Format   string `yaml:"format"`
	Comment  bool   `yaml:"comment"`
	Distance *int   `yaml:"distance"`
}

ER is er setting

type Format

type Format struct {
	Adjust bool `yaml:"adjust"`
	Sort   bool `yaml:"sort"`
}

Format is document format setting

type Lint

type Lint struct {
	RequireTableComment    RequireTableComment    `yaml:"requireTableComment"`
	RequireColumnComment   RequireColumnComment   `yaml:"requireColumnComment"`
	UnrelatedTable         UnrelatedTable         `yaml:"unrelatedTable"`
	ColumnCount            ColumnCount            `yaml:"columnCount"`
	RequireColumns         RequireColumns         `yaml:"requireColumns"`
	DuplicateRelations     DuplicateRelations     `yaml:"duplicateRelations"`
	RequireForeignKeyIndex RequireForeignKeyIndex `yaml:"requireForeignKeyIndex"`
}

Lint is the struct for lint config

type Option

type Option func(*Config) error

Option function change Config

func Adjust

func Adjust(adjust bool) Option

Adjust return Option set Config.Format.Adjust

func DSN

func DSN(dsn string) Option

DSN return Option set Config.DSN

func Distance

func Distance(distance int) Option

Distance return Option set Config.ER.Distance

func DocPath

func DocPath(docPath string) Option

DocPath return Option set Config.DocPath

func ERFormat

func ERFormat(erFormat string) Option

ERFormat return Option set Config.ER.Format

func ERSkip

func ERSkip(skip bool) Option

ERSkip return Option set Config.ER.Skip

func Sort

func Sort(sort bool) Option

Sort return Option set Config.Format.Sort

type RequireColumnComment

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

RequireColumnComment checks column comment

func (RequireColumnComment) Check

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

Check column comment

func (RequireColumnComment) IsEnabled

func (r RequireColumnComment) IsEnabled() bool

IsEnabled return Rule is enabled or not

type RequireColumns

type RequireColumns struct {
	Enabled bool                   `yaml:"enabled"`
	Columns []RequireColumnsColumn `yaml:"columns"`
}

RequireColumns checks if the table has specified columns

func (RequireColumns) Check

func (r RequireColumns) Check(s *schema.Schema, exclude []string) []RuleWarn

Check the existence of a table columns

func (RequireColumns) IsEnabled

func (r RequireColumns) IsEnabled() bool

IsEnabled return Rule is enabled or not

type RequireColumnsColumn

type RequireColumnsColumn struct {
	Name    string   `yaml:"name"`
	Exclude []string `yaml:"exclude"`
}

RequireColumnsColumn is required column

type RequireForeignKeyIndex

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

RequireForeignKeyIndex checks if the foreign key columns have an index

func (RequireForeignKeyIndex) Check

func (r RequireForeignKeyIndex) Check(s *schema.Schema, exclude []string) []RuleWarn

Check if the foreign key columns have an index

func (RequireForeignKeyIndex) IsEnabled

func (r RequireForeignKeyIndex) IsEnabled() bool

IsEnabled return Rule is enabled or not

type RequireTableComment

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

RequireTableComment checks table comment

func (RequireTableComment) Check

func (r RequireTableComment) Check(s *schema.Schema, exclude []string) []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.Schema, exclude []string) []RuleWarn
}

Rule is interfece of `tbls lint` cop

type RuleWarn

type RuleWarn struct {
	Target  string
	Message string
}

RuleWarn is struct of Rule error

type UnrelatedTable

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

UnrelatedTable checks isolated table

func (UnrelatedTable) Check

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

Check table relation

func (UnrelatedTable) IsEnabled

func (r UnrelatedTable) IsEnabled() bool

IsEnabled return Rule is enabled or not