config

package

v0.13.0 Latest Latest Go to latest Published: Dec 17, 2025 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/KarnerTh/mermerd

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type MermerdConfig
- func NewConfig() MermerdConfig
type OutputModeType
type RelationshipLabel

Constants ¶

View Source

const (
	ConnectionStringKey            = "connectionString"
	ConnectionStringSuggestionsKey = "connectionStringSuggestions"
	DebugKey                       = "debug"
	EncloseWithMermaidBackticksKey = "encloseWithMermaidBackticks"
	IgnoreTables                   = "ignoreTables"
	OmitAttributeKeysKey           = "omitAttributeKeys"
	OmitConstraintLabelsKey        = "omitConstraintLabels"
	OutputFileNameKey              = "outputFileName"
	OutputMode                     = "outputMode"
	RelationshipLabelsKey          = "relationshipLabels"
	SchemaKey                      = "schema"
	SchemaPrefixSeparator          = "schemaPrefixSeparator"
	SelectedTablesKey              = "selectedTables"
	ShowAllConstraintsKey          = "showAllConstraints"
	ShowDescriptionsKey            = "showDescriptions"
	ShowSchemaPrefix               = "showSchemaPrefix"
	UseAllSchemasKey               = "useAllSchemas"
	UseAllTablesKey                = "useAllTables"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type MermerdConfig ¶

type MermerdConfig interface {
	ConnectionString() string
	ConnectionStringSuggestions() []string
	Debug() bool
	EncloseWithMermaidBackticks() bool
	IgnoreTables() []string
	OmitAttributeKeys() bool
	OmitConstraintLabels() bool
	OutputFileName() string
	OutputMode() OutputModeType
	RelationshipLabels() []RelationshipLabel
	SchemaPrefixSeparator() string
	Schemas() []string
	SelectedTables() []string
	ShowAllConstraints() bool
	ShowDescriptions() []string
	ShowSchemaPrefix() bool
	UseAllSchemas() bool
	UseAllTables() bool
}

func NewConfig ¶

func NewConfig() MermerdConfig

type OutputModeType ¶ added in v0.12.0

type OutputModeType string

const (
	File   OutputModeType = "file"
	Stdout OutputModeType = "stdout"
)

func (*OutputModeType) Set ¶ added in v0.12.0

func (o *OutputModeType) Set(v string) error

func (*OutputModeType) String ¶ added in v0.12.0

func (o *OutputModeType) String() string

func (*OutputModeType) Type ¶ added in v0.12.0

func (o *OutputModeType) Type() string

type RelationshipLabel ¶ added in v0.10.0

type RelationshipLabel struct {
	PkName string
	FkName string
	Label  string
}

Source Files ¶

View all Source files

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