config

package

Go to main page

Versions in this module

v1

v1.30.0

Sep 1, 2025

v1.29.0

Apr 17, 2025

v1.28.0

Jan 20, 2025

v1.27.0

Aug 5, 2024

Changes in this version

type Config

+ Servers []Server

+ type Server struct

+ Engine Engine

+ Name string

+ URI string

v1.26.0

Mar 28, 2024

v1.25.0

Jan 4, 2024

v1.24.0

Nov 22, 2023

Changes in this version

type Config

+ Options map[string]yaml.Node

+ Overrides Overrides

+ type Overrides struct

+ Go *golang.GlobalOptions

v1.23.0

Oct 24, 2023

Changes in this version

+ var ErrInvalidDatabase = errors.New("database must be managed or have a non-empty URI")

+ var ErrManagedDatabaseNoAuthToken = errors.New(...)

+ var ErrManagedDatabaseNoProject = errors.New(...)

+ type Analyzer struct

+ Database *bool

type Cloud

+ AuthToken string

type SQL

+ Analyzer Analyzer

+ Name string

type SQLGo

+ BuildTags string

v1.22.0

Sep 26, 2023

Changes in this version

type Database

+ Managed bool

type SQLGo

+ OutputCopyFromFileName string

v1.21.0

Sep 6, 2023

Changes in this version

type Plugin

+ Env []string

v1.20.0

Jul 31, 2023

Changes in this version

+ var ErrInvalidQueryParameterLimit = errors.New("invalid query parameter limit")

+ var ErrMissingEngine = errors.New("unknown engine")

+ var ErrMissingVersion = errors.New("no version number")

+ var ErrNoOutPath = errors.New("no output path")

+ var ErrNoPackageName = errors.New("missing package name")

+ var ErrNoPackagePath = errors.New("missing package path")

+ var ErrNoPackages = errors.New("no packages")

+ var ErrNoQuerierType = errors.New("no querier emit type enabled")

+ var ErrPluginBothTypes = errors.New("plugin: both `process` and `wasm` cannot both be defined")

+ var ErrPluginBuiltin = errors.New("a built-in plugin with that name already exists")

+ var ErrPluginExists = errors.New("a plugin with that name already exists")

+ var ErrPluginNoName = errors.New("missing plugin name")

+ var ErrPluginNoType = errors.New("plugin: field `process` or `wasm` required")

+ var ErrPluginNotFound = errors.New("no plugin found")

+ var ErrPluginProcessNoCmd = errors.New("plugin: missing process command")

+ var ErrUnknownEngine = errors.New("invalid engine")

+ var ErrUnknownVersion = errors.New("invalid version number")

+ func Validate(c *Config) error

+ type Cloud struct

+ Hostname string

+ Organization string

+ Project string

+ type Codegen struct

+ Options yaml.Node

+ Out string

+ Plugin string

+ type CombinedSettings struct

+ Codegen Codegen

+ Global Config

+ Go SQLGo

+ JSON SQLJSON

+ Overrides []Override

+ Package SQL

+ Rename map[string]string

+ func Combine(conf Config, pkg SQL) CombinedSettings

+ type Config struct

+ Cloud Cloud

+ Gen Gen

+ Plugins []Plugin

+ Project Project

+ Rules []Rule

+ SQL []SQL

+ Version string

+ func ParseConfig(rd io.Reader) (Config, error)

+ type Database struct

+ URI string

+ type Engine string

+ const EngineMySQL

+ const EnginePostgreSQL

+ const EngineSQLite

+ type Gen struct

+ Go *GenGo

+ type GenGo struct

+ Overrides []Override

+ Rename map[string]string

+ type GoStructTag string

+ func (s GoStructTag) Parse() (map[string]string, error)

+ type GoType struct

+ BuiltIn bool

+ Name string

+ Package string

+ Path string

+ Pointer bool

+ Slice bool

+ Spec string

+ func (gt GoType) Parse() (*ParsedGoType, error)

+ func (o *GoType) UnmarshalJSON(data []byte) error

+ func (o *GoType) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type Override struct

+ Column string

+ ColumnName *pattern.Match

+ DBType string

+ Deprecated_Null bool

+ Deprecated_PostgresType string

+ Engine Engine

+ GoBasicType bool

+ GoImportPath string

+ GoPackage string

+ GoStructTag GoStructTag

+ GoStructTags map[string]string

+ GoType GoType

+ GoTypeName string

+ Nullable bool

+ TableCatalog *pattern.Match

+ TableRel *pattern.Match

+ TableSchema *pattern.Match

+ Unsigned bool

+ func (o *Override) Matches(n *ast.TableName, defaultSchema string) bool

+ func (o *Override) Parse() (err error)

+ type ParsedGoType struct

+ BasicType bool

+ ImportPath string

+ Package string

+ StructTag string

+ TypeName string

+ type Paths []string

+ func (p *Paths) UnmarshalJSON(data []byte) error

+ func (p *Paths) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type Plugin struct

+ Name string

+ Process ...

+ WASM ...

+ type Project struct

+ ID string

+ type PythonType struct

+ Module string

+ Name string

+ func (t PythonType) IsSet() bool

+ func (t PythonType) TypeString() string

+ type Rule struct

+ Msg string

+ Name string

+ Rule string

+ type SQL struct

+ Codegen []Codegen

+ Database *Database

+ Engine Engine

+ Gen SQLGen

+ Queries Paths

+ Rules []string

+ Schema Paths

+ StrictFunctionChecks bool

+ StrictOrderBy *bool

+ type SQLGen struct

+ Go *SQLGo

+ JSON *SQLJSON

+ type SQLGo struct

+ EmitAllEnumValues bool

+ EmitDBTags bool

+ EmitEmptySlices bool

+ EmitEnumValidMethod bool

+ EmitExactTableNames bool

+ EmitExportedQueries bool

+ EmitInterface bool

+ EmitJSONTags bool

+ EmitMethodsWithDBArgument bool

+ EmitParamsStructPointers bool

+ EmitPointersForNullTypes bool

+ EmitPreparedQueries bool

+ EmitResultStructPointers bool

+ InflectionExcludeTableNames []string

+ JSONTagsCaseStyle string

+ JsonTagsIDUppercase bool

+ OmitUnusedStructs bool

+ Out string

+ OutputBatchFileName string

+ OutputDBFileName string

+ OutputFilesSuffix string

+ OutputModelsFileName string

+ OutputQuerierFileName string

+ Overrides []Override

+ Package string

+ QueryParameterLimit *int32

+ Rename map[string]string

+ SQLDriver string

+ SQLPackage string

+ type SQLJSON struct

+ Filename string

+ Indent string

+ Out string

+ type V1GenerateSettings struct

+ Cloud Cloud

+ Overrides []Override

+ Packages []v1PackageSettings

+ Project Project

+ Rename map[string]string

+ Rules []Rule

+ Version string

+ func (c *V1GenerateSettings) Translate() Config

+ func (c *V1GenerateSettings) ValidateGlobalOverrides() error

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