config

type AdditionalComment struct {
	Table              string            `yaml:"table"`
	TableComment       string            `yaml:"tableComment,omitempty"`
	ColumnComments     map[string]string `yaml:"columnComments,omitempty"`
	IndexComments      map[string]string `yaml:"indexComments,omitempty"`
	ConstraintComments map[string]string `yaml:"constraintComments,omitempty"`
	TriggerComments    map[string]string `yaml:"triggerComments,omitempty"`
	Labels             []string          `yaml:"labels,omitempty"`
}

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

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

type Config struct {
	Name        string               `yaml:"name"`
	Desc        string               `yaml:"desc,omitempty"`
	Labels      []string             `yaml:"labels,omitempty"`
	DSN         DSN                  `yaml:"dsn"`
	DocPath     string               `yaml:"docPath"`
	Format      Format               `yaml:"format,omitempty"`
	ER          ER                   `yaml:"er,omitempty"`
	Include     []string             `yaml:"include,omitempty"`
	Exclude     []string             `yaml:"exclude,omitempty"`
	Lint        Lint                 `yaml:"lint,omitempty"`
	LintExclude []string             `yaml:"lintExclude,omitempty"`
	Relations   []AdditionalRelation `yaml:"relations,omitempty"`
	Comments    []AdditionalComment  `yaml:"comments,omitempty"`
	Dict        dict.Dict            `yaml:"dict,omitempty"`
	MergedDict  dict.Dict            `yaml:"-"`
	// contains filtered or unexported fields
}

type DSN struct {
	URL     string            `yaml:"url"`
	Headers map[string]string `yaml:"headers,omitempty"`
}

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

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

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

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

type Lint struct {
	RequireTableComment      RequireTableComment      `yaml:"requireTableComment"`
	RequireColumnComment     RequireColumnComment     `yaml:"requireColumnComment"`
	RequireIndexComment      RequireIndexComment      `yaml:"requireIndexComment"`
	RequireConstraintComment RequireConstraintComment `yaml:"requireConstraintComment"`
	RequireTriggerComment    RequireTriggerComment    `yaml:"requireTriggerComment"`
	UnrelatedTable           UnrelatedTable           `yaml:"unrelatedTable"`
	ColumnCount              ColumnCount              `yaml:"columnCount"`
	RequireColumns           RequireColumns           `yaml:"requireColumns"`
	DuplicateRelations       DuplicateRelations       `yaml:"duplicateRelations"`
	RequireForeignKeyIndex   RequireForeignKeyIndex   `yaml:"requireForeignKeyIndex"`
	LabelStyleBigQuery       LabelStyleBigQuery       `yaml:"labelStyleBigQuery"`
}

type Option func(*Config) error

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

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

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

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

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

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

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

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

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

type RuleWarn struct {
	Target  string
	Message string
}

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