config

package

Go to main page

Versions in this module

v1

v1.74.1

May 1, 2024

v1.74.0

Apr 18, 2024

v1.73.3

Mar 16, 2024

v1.73.2

Jan 25, 2024

v1.73.1

Jan 25, 2024

v1.73.0

Jan 25, 2024

v1.72.2

Jan 25, 2024

v1.72.1

Jan 12, 2024

v1.72.0

Nov 23, 2023

v1.71.1

Nov 7, 2023

v1.71.0

Nov 1, 2023

v1.70.2

Oct 17, 2023

v1.70.1

Oct 12, 2023

v1.70.0

Oct 8, 2023

Changes in this version

type Lint

+ RequireViewpoints RequireViewpoints

+ type RequireViewpoints struct

+ Enabled bool

+ Exclude []string

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

+ func (r RequireViewpoints) IsEnabled() bool

v1.69.2

Oct 3, 2023

v1.69.1

Oct 2, 2023

v1.69.0

Oct 2, 2023

v1.68.2

Jul 26, 2023

v1.68.1

Jul 12, 2023

v1.68.0

Jun 23, 2023

v1.67.1

Jun 18, 2023

v1.67.0

Jun 17, 2023

Changes in this version

type Viewpoint

+ Groups []ViewpointGroup

+ type ViewpointGroup struct

+ Color string

+ Desc string

+ Labels []string

+ Name string

+ Tables []string

v1.66.0

Jun 16, 2023

Changes in this version

type Config

+ Viewpoints []Viewpoint

type MD

+ Viewpoint string

+ type Viewpoint struct

+ Desc string

+ Distance int

+ Labels []string

+ Name string

+ Tables []string

v1.65.4

Jun 7, 2023

v1.65.3

Apr 14, 2023

v1.65.2

Apr 10, 2023

v1.65.1

Apr 8, 2023

v1.65.0

Apr 8, 2023

Changes in this version

type Lint

+ RequireTableLabels RequireTableLabels

+ type RequireTableLabels struct

+ AllOrNothing bool

+ Enabled bool

+ Exclude []string

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

+ func (r RequireTableLabels) IsEnabled() bool

v1.64.1

Apr 3, 2023

v1.64.0

Mar 25, 2023

v1.63.0

Mar 13, 2023

v1.62.1

Feb 20, 2023

v1.62.0

Feb 8, 2023

Changes in this version

type ER

+ ShowColumnTypes *ShowColumnTypes

+ type ShowColumnTypes struct

+ Primary bool

+ Related bool

v1.61.0

Feb 3, 2023

v1.60.0

Jan 26, 2023

v1.59.0

Jan 22, 2023

Changes in this version

+ var SupportERFormat = []string

type AdditionalRelation

+ Cardinality string

+ Override bool

+ ParentCardinality string

type Config

+ func (c *Config) NeedToGenerateERImages() bool

type ER

+ HideDef bool

+ type Mermaid struct

+ Schema string

+ Table string

type Option

+ func IncludeLabels(l []string) Option

type Templates

+ Mermaid Mermaid

v1.58.0

Jan 16, 2023

Changes in this version

+ var DefaultERDistance = 1

type Config

+ Distance int

type Option

+ func Exclude(e []string) Option

+ func Include(i []string) Option

v1.57.1

Dec 11, 2022

v1.57.0

Dec 11, 2022

Changes in this version

+ const SchemaFileName

type Config

+ DisableOutputSchema bool

+ func (c *Config) SchemaFilePath() string

v1.56.9

Dec 6, 2022

v1.56.8

Nov 9, 2022

v1.56.7

Nov 9, 2022

v1.56.6

Oct 31, 2022

v1.56.5

Oct 26, 2022

v1.56.4

Oct 25, 2022

v1.56.3

Sep 24, 2022

v1.56.2

Sep 2, 2022

v1.56.1

Jul 28, 2022

v1.56.0

May 28, 2022

Changes in this version

type Format

+ HideColumnsWithoutValues []string

+ func (f *Format) UnmarshalYAML(data []byte) error

+ func (f Format) MarshalYAML() ([]byte, error)

v1.55.1

Apr 4, 2022

v1.55.0

Apr 4, 2022

v1.54.2

Dec 16, 2021

v1.54.1

Dec 15, 2021

v1.54.0

Dec 10, 2021

Changes in this version

type AdditionalComment

+ ColumnLabels map[string][]string

v1.53.0

Nov 16, 2021

Changes in this version

type Format

+ ShowOnlyFirstParagraph bool

v1.52.0

Oct 22, 2021

v1.51.0

Oct 19, 2021

Changes in this version

type Format

+ Number bool

v1.50.0

Apr 1, 2021

Changes in this version

type Config

+ RequiredVersion string

v1.49.7

Mar 6, 2021

v1.49.6

Feb 17, 2021

v1.49.5

Feb 17, 2021

v1.49.4

Feb 4, 2021

v1.49.3

Feb 3, 2021

v1.49.2

Feb 1, 2021

v1.49.1

Feb 1, 2021

v1.49.0

Jan 31, 2021

v1.48.1

Jan 20, 2021

v1.48.0

Jan 16, 2021

v1.47.0

Jan 4, 2021

v1.46.0

Dec 11, 2020

v1.45.2

Nov 26, 2020

v1.45.1

Nov 22, 2020

v1.45.0

Nov 10, 2020

Changes in this version

+ func SelectNamingStrategy(name string) bool

+ func ToParentColumnName(name string) string

+ func ToParentTableName(name string) string

type Config

+ BaseUrl string

+ DetectVirtualRelations DetectVirtualRelations

+ type DetectVirtualRelations struct

+ Enabled bool

+ Strategy string

+ type Namer func(string) string

+ type NamingStrategy struct

+ ParentColumn Namer

+ ParentTable Namer

+ func (ns *NamingStrategy) ParentColumnName(name string) string

+ func (ns *NamingStrategy) ParentTableName(name string) string

type Option

+ func BaseUrl(baseUrl string) Option

v1.44.0

Nov 5, 2020

Changes in this version

type Config

+ Templates Templates

+ type Dot struct

+ Schema string

+ Table string

+ type MD struct

+ Index string

+ Table string

+ type PUML struct

+ Schema string

+ Table string

+ type Templates struct

+ Dot Dot

+ MD MD

+ PUML PUML

v1.43.1

Aug 12, 2020

v1.43.0

Aug 7, 2020

Changes in this version

type RequireColumnComment

+ AllOrNothing bool

type RequireConstraintComment

+ AllOrNothing bool

type RequireIndexComment

+ AllOrNothing bool

type RequireTableComment

+ AllOrNothing bool

type RequireTriggerComment

+ AllOrNothing bool

type UnrelatedTable

+ AllOrNothing bool

v1.42.0

Aug 2, 2020

v1.41.0

Jul 11, 2020

v1.40.0

Jul 8, 2020

Changes in this version

type Config

+ func (c *Config) LoadOption(options ...Option) error

type ER

+ Font string

v1.39.0

Jun 14, 2020

v1.38.3

May 13, 2020

v1.38.2

May 11, 2020

v1.38.1

May 10, 2020

v1.38.0

May 10, 2020

v1.37.5

May 8, 2020

Changes in this version

+ const DefaultDocPath

+ var DefaultConfigFilePaths = []string

v1.37.4

May 7, 2020

Changes in this version

type Config

+ Path string

+ func (c *Config) LoadConfig(in []byte) error

v1.37.3

May 5, 2020

v1.37.2

May 1, 2020

v1.37.1

Apr 30, 2020

v1.37.0

Apr 28, 2020

Changes in this version

type AdditionalComment

+ ConstraintComments map[string]string

+ IndexComments map[string]string

+ TriggerComments map[string]string

type Lint

+ RequireConstraintComment RequireConstraintComment

+ RequireIndexComment RequireIndexComment

+ RequireTriggerComment RequireTriggerComment

+ type RequireConstraintComment struct

+ Enabled bool

+ Exclude []string

+ ExcludeTables []string

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

+ func (r RequireConstraintComment) IsEnabled() bool

+ type RequireIndexComment struct

+ Enabled bool

+ Exclude []string

+ ExcludeTables []string

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

+ func (r RequireIndexComment) IsEnabled() bool

+ type RequireTriggerComment struct

+ Enabled bool

+ Exclude []string

+ ExcludeTables []string

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

+ func (r RequireTriggerComment) IsEnabled() bool

v1.36.1

Apr 26, 2020

v1.36.0

Apr 25, 2020

v1.35.0

Apr 21, 2020

v1.34.1

Apr 21, 2020

v1.34.0

Apr 21, 2020

v1.33.0

Apr 18, 2020

v1.32.2

Apr 17, 2020

v1.32.1

Apr 17, 2020

Changes in this version

type RequireColumnComment

+ ExcludeTables []string

v1.32.0

Apr 17, 2020

Changes in this version

+ type LabelStyleBigQuery struct

+ Enabled bool

+ Exclude []string

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

+ func (r LabelStyleBigQuery) IsEnabled() bool

type Lint

+ LabelStyleBigQuery LabelStyleBigQuery

v1.31.2

Apr 14, 2020

v1.31.1

Apr 13, 2020

v1.31.0

Apr 10, 2020

Changes in this version

type AdditionalComment

+ Labels []string

type Config

+ Labels []string

v1.30.0

Apr 6, 2020

Changes in this version

type Config

+ Desc string

v1.29.3

Apr 5, 2020

Changes in this version

type DSN

+ Headers map[string]string

+ URL string

+ func (d *DSN) UnmarshalYAML(data []byte) error

+ func (d DSN) MarshalYAML() ([]byte, error)

type Option

+ func DSNURL(dsn string) Option

v1.29.2

Mar 17, 2020

Changes in this version

type Config

+ func New() (*Config, error)

v1.29.1

Mar 14, 2020

v1.29.0

Mar 13, 2020

Changes in this version

type Config

+ Dict dict.Dict

+ MergedDict dict.Dict

+ Name string

v1.28.2

Mar 9, 2020

v1.28.1

Mar 8, 2020

v1.28.0

Mar 7, 2020

Changes in this version

type Config

+ Include []string

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

v1.27.0

Feb 24, 2020

Changes in this version

+ var DefaultDistance = 1

type ER

+ Distance *int

type Option

+ func Distance(distance int) Option

v1.26.0

Feb 19, 2020

v1.25.1

Feb 17, 2020

v1.25.0

Feb 6, 2020

v1.24.1

Jan 16, 2020

v1.24.0

Jan 11, 2020

v1.23.0

Dec 11, 2019

v1.22.1

Nov 20, 2019

v1.22.0

Nov 20, 2019

v1.21.1

Nov 11, 2019

v1.21.0

Nov 10, 2019

Changes in this version

type Config

+ LintExclude []string

v1.20.0

Nov 2, 2019

Changes in this version

type Lint

+ RequireForeignKeyIndex RequireForeignKeyIndex

+ type RequireForeignKeyIndex struct

+ Enabled bool

+ Exclude []string

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

+ func (r RequireForeignKeyIndex) IsEnabled() bool

v1.19.0

Sep 6, 2019

Changes in this version

+ type DuplicateRelations struct

+ Enabled bool

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

+ func (r DuplicateRelations) IsEnabled() bool

type Lint

+ DuplicateRelations DuplicateRelations

v1.18.2

Sep 5, 2019

v1.18.1

Aug 15, 2019

v1.18.0

Aug 12, 2019

v1.17.2

Jul 15, 2019

v1.17.1

Jul 8, 2019

v1.17.0

Jun 12, 2019

Changes in this version

type ER

+ Comment bool

v1.16.1

Jun 11, 2019

v1.16.0

Jun 4, 2019

v1.15.4

May 28, 2019

v1.15.3

May 27, 2019

v1.15.2

May 27, 2019

v1.15.1

May 26, 2019

v1.15.0

May 26, 2019

v1.14.0

May 15, 2019

v1.13.3

May 13, 2019

v1.13.2

May 12, 2019

v1.13.1

May 12, 2019

v1.13.0

May 12, 2019

v1.12.0

May 11, 2019

Changes in this version

type Config

+ Exclude []string

+ func (c *Config) ExcludeTables(s *schema.Schema) error

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

type Lint

+ RequireColumns RequireColumns

+ type RequireColumns struct

+ Columns []RequireColumnsColumn

+ Enabled bool

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

+ func (r RequireColumns) IsEnabled() bool

+ type RequireColumnsColumn struct

+ Exclude []string

+ Name string

v1.11.1

Apr 25, 2019

v1.11.0

Apr 25, 2019

v1.10.1

Mar 16, 2019

v1.10.0

Mar 13, 2019

Changes in this version

+ const DefaultERFormat

type Config

+ ER ER

+ Format Format

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

+ type ER struct

+ Format string

+ Skip bool

+ type Format struct

+ Adjust bool

+ Sort bool

+ type Option func(*Config) error

+ func Adjust(adjust bool) Option

+ func DSN(dsn string) Option

+ func DocPath(docPath string) Option

+ func ERFormat(erFormat string) Option

+ func ERSkip(skip bool) Option

+ func Sort(sort bool) Option

type RuleWarn

+ Target string

v1.9.0

Mar 9, 2019

Changes in this version

type Config

+ func (c *Config) Load(configPath string, args []string) error

+ func (c *Config) LoadEnviron() error

v1.8.3

Feb 25, 2019

Changes in this version

type RequireColumnComment

+ ExcludedTables []string

v1.8.2

Feb 25, 2019

Changes in this version

type ColumnCount

+ Exclude []string

type Lint

+ UnrelatedTable UnrelatedTable

type RequireColumnComment

+ Exclude []string

type RequireTableComment

+ Exclude []string

+ type UnrelatedTable struct

+ Enabled bool

+ Exclude []string

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

+ func (r UnrelatedTable) IsEnabled() bool

v1.8.1

Feb 25, 2019

v1.8.0

Feb 23, 2019

Changes in this version

+ type ColumnCount struct

+ Enabled bool

+ Max int

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

+ func (r ColumnCount) IsEnabled() bool

type Config

+ Lint Lint

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

+ type Lint struct

+ ColumnCount ColumnCount

+ NoRelationTables NoRelationTables

+ RequireColumnComment RequireColumnComment

+ RequireTableComment RequireTableComment

+ type NoRelationTables struct

+ Enabled bool

+ Max int

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

+ func (r NoRelationTables) IsEnabled() bool

+ type RequireColumnComment struct

+ Enabled bool

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

+ func (r RequireColumnComment) IsEnabled() bool

+ type RequireTableComment struct

+ Enabled bool

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

+ func (r RequireTableComment) IsEnabled() bool

+ type Rule interface

+ Check func(*schema.Schema) []RuleWarn

+ IsEnabled func() bool

+ type RuleWarn struct

+ Message string

v1.7.1

Dec 8, 2018

v1.7.0

Nov 29, 2018

v1.6.0

Nov 24, 2018

Changes in this version

+ type AdditionalComment struct

+ ColumnComments map[string]string

+ Table string

+ TableComment string

+ type AdditionalRelation struct

+ Columns []string

+ Def string

+ ParentColumns []string

+ ParentTable string

+ Table string

+ type Config struct

+ Comments []AdditionalComment

+ DSN string

+ DocPath string

+ Relations []AdditionalRelation

+ func NewConfig() (*Config, error)

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

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL