Documentation ¶
Index ¶
- Constants
- type AdditionalComment
- type AdditionalRelation
- type ColumnCount
- type Config
- func (c *Config) ExcludeTables(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 ER
- type Format
- type Lint
- type Option
- type RequireColumnComment
- type RequireColumns
- type RequireColumnsColumn
- type RequireTableComment
- type Rule
- type RuleWarn
- type UnrelatedTable
Constants ¶
const DefaultERFormat = "png"
DefaultERFormat is default ER diagram format
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 ¶ added in v1.8.0
type ColumnCount struct { Enabled bool `yaml:"enabled"` Max int `yaml:"max"` Exclude []string `yaml:"exclude"` }
ColumnCount check table column count
func (ColumnCount) Check ¶ added in v1.8.0
func (r ColumnCount) Check(s *schema.Schema) []RuleWarn
Check table column count
func (ColumnCount) IsEnabled ¶ added in v1.8.0
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"` Exclude []string `yaml:"exclude"` Lint Lint `yaml:"lint"` Relations []AdditionalRelation `yaml:"relations"` Comments []AdditionalComment `yaml:"comments"` }
Config is tbls config
func (*Config) ExcludeTables ¶ added in v1.12.0
ExcludeTables exclude tables from schema.Schema
func (*Config) LoadConfigFile ¶
LoadConfigFile load config file
func (*Config) LoadEnviron ¶ added in v1.9.0
LoadEnviron load environment variables
func (*Config) MergeAdditionalData ¶ added in v1.8.0
MergeAdditionalData merge additional* to schema.Schema
type Lint ¶ added in v1.8.0
type Lint struct { RequireTableComment RequireTableComment `yaml:"requireTableComment"` RequireColumnComment RequireColumnComment `yaml:"requireColumnComment"` ColumnCount ColumnCount `yaml:"columnCount"` RequireColumns RequireColumns `yaml:"requireColumns"` }
Lint is the struct for lint config
type Option ¶ added in v1.10.0
Option function change Config
type RequireColumnComment ¶ added in v1.8.0
type RequireColumnComment struct { Enabled bool `yaml:"enabled"` Exclude []string `yaml:"exclude"` ExcludedTables []string `yaml:"excludedTables"` }
RequireColumnComment check column comment
func (RequireColumnComment) Check ¶ added in v1.8.0
func (r RequireColumnComment) Check(s *schema.Schema) []RuleWarn
Check column comment
func (RequireColumnComment) IsEnabled ¶ added in v1.8.0
func (r RequireColumnComment) IsEnabled() bool
IsEnabled return Rule is enabled or not
type RequireColumns ¶ added in v1.12.0
type RequireColumns struct { Enabled bool `yaml:"enabled"` Columns []RequireColumnsColumn `yaml:"columns"` }
RequireColumns check required table columns
func (RequireColumns) Check ¶ added in v1.12.0
func (r RequireColumns) Check(s *schema.Schema) []RuleWarn
Check the existence of a table columns
func (RequireColumns) IsEnabled ¶ added in v1.12.0
func (r RequireColumns) IsEnabled() bool
IsEnabled return Rule is enabled or not
type RequireColumnsColumn ¶ added in v1.12.0
RequireColumnsColumn is required column
type RequireTableComment ¶ added in v1.8.0
RequireTableComment check table comment
func (RequireTableComment) Check ¶ added in v1.8.0
func (r RequireTableComment) Check(s *schema.Schema) []RuleWarn
Check table comment
func (RequireTableComment) IsEnabled ¶ added in v1.8.0
func (r RequireTableComment) IsEnabled() bool
IsEnabled return Rule is enabled or not
type UnrelatedTable ¶ added in v1.8.2
type UnrelatedTable struct {}
UnrelatedTable check isolated table
func (UnrelatedTable) Check ¶ added in v1.8.2
func (r UnrelatedTable) Check(s *schema.Schema) []RuleWarn
Check table relation
func (UnrelatedTable) IsEnabled ¶ added in v1.8.2
func (r UnrelatedTable) IsEnabled() bool
IsEnabled return Rule is enabled or not