core

type Column struct {
	Name    string // CamelCased name for Go
	DBName  string // Name as used in the DB
	Type    PyType
	Comment string
	Column  *plugin.Column
	// EmbedFields contains the embedded fields that require scanning.
	EmbedFields []Column
}

type Config struct {
	Package                     string        `json:"package" yaml:"package"`
	SqlDriver                   SQLDriverType `json:"sql_driver" yaml:"sql_driver"`
	ModelType                   string        `json:"model_type" yaml:"model_type"`
	Initialisms                 *[]string     `json:"initialisms,omitempty" yaml:"initialisms,omitempty"`
	EmitExactTableNames         bool          `json:"emit_exact_table_names" yaml:"emit_exact_table_names"`
	EmitClasses                 bool          `json:"emit_classes" yaml:"emit_classes"`
	InflectionExcludeTableNames []string      `json:"inflection_exclude_table_names,omitempty" yaml:"inflection_exclude_table_names,omitempty"`
	OmitUnusedModels            bool          `json:"omit_unused_models" yaml:"omit_unused_models"`
	OmitTypecheckingBlock       bool          `json:"omit_typechecking_block" yaml:"omit_typechecking_block"`
	QueryParameterLimit         *int32        `json:"query_parameter_limit,omitempty" yaml:"query_parameter_limit"`
	OmitKwargsLimit             *int32        `json:"omit_kwargs_limit,omitempty" yaml:"omit_kwargs_limit"`
	EmitInitFile                *bool         `json:"emit_init_file" yaml:"emit_init_file"`
	EmitDocstrings              *string       `json:"docstrings" yaml:"docstrings"`
	EmitDocstringsSQL           *bool         `json:"docstrings_emit_sql" yaml:"docstrings_emit_sql"`
	Speedups                    bool          `json:"speedups" yaml:"speedups"`
	Overrides                   []Override    `json:"overrides,omitempty" yaml:"overrides"`

	Debug bool `json:"debug" yaml:"debug"`

	IndentChar          string `json:"indent_char" yaml:"indent_char"`
	CharsPerIndentLevel int    `json:"chars_per_indent_level" yaml:"chars_per_indent_level"`

	InitialismsMap map[string]struct{} `json:"-" yaml:"-"`
	Async          bool
}

type Constant struct {
	Name  string
	Type  string
	Value string
}

type Enum struct {
	Name      string
	Comment   string
	Constants []Constant
}

type FunctionArg struct {
	Name           string
	Type           string
	FunctionFormat string
}

type Importer struct {
	Tables  []Table
	Queries []Query
	Enums   []Enum
	C       *Config
}

type Override struct {
	// name of the golang type to use, e.g. `github.com/segmentio/ksuid.KSUID`
	PyType OverridePyType `json:"py_type" yaml:"py_type"`

	// fully qualified name of the Go type, e.g. `github.com/segmentio/ksuid.KSUID`
	DBType string `json:"db_type" yaml:"db_type"`

	// fully qualified name of the column, e.g. `accounts.id`
	Column string `json:"column" yaml:"column"`

	ColumnName    *pattern.Match `json:"-"`
	TableCatalog  *pattern.Match `json:"-"`
	TableSchema   *pattern.Match `json:"-"`
	TableRel      *pattern.Match `json:"-"`
	PyImportPath  string         `json:"-"`
	PyPackageName string         `json:"-"`
	PyTypeName    string         `json:"-"`
	PyBasicType   bool           `json:"-"`
}

type OverridePyType struct {
	Import  string `json:"import" yaml:"import"`
	Name    string `json:"type" yaml:"type"`
	Package string `json:"package" yaml:"package"`
	Spec    string `json:"-"`
	BuiltIn bool   `json:"-"`
}

type ParsedOverridePyType struct {
	ImportPath  string
	TypeName    string
	PackageName string
	BasicType   bool
}

type PyType struct {
	SqlType     string
	Type        string
	DefaultType string
	IsList      bool
	IsNullable  bool
	IsEnum      bool
	IsOverride  bool
	Override    *Override
}

type Query struct {
	Cmd          string
	Comments     []string
	MethodName   string
	FuncName     string
	FieldName    string
	ConstantName string
	SQL          string
	SourceName   string
	Ret          QueryValue
	Args         []QueryValue

	// Used for :copyfrom
	Table *plugin.Identifier
}

type QueryValue struct {
	Emit   bool
	Name   string
	DBName string // The name of the field in the database. Only set if Struct==nil.
	Table  *Table
	Typ    PyType

	// Column is kept so late in the generation process around to differentiate
	// between mysql slices and pg arrays
	Column *plugin.Column
}

type SQLDriverType string

type Table struct {
	Table   *plugin.Identifier
	Name    string
	Columns []Column
	Comment string
}