sqlmodel

type Codegen struct {
	// Meta information
	Meta map[string]interface{}
	// Format the code
	Format bool
}

type Column struct {
	// Name is the name of this column
	Name string
	// Type is the database type of this column
	Type ColumnType
	// ScanType is the database type of this column
	ScanType string
	// Model representation of this column
	Model ColumnModel
}

type ColumnModel struct {
	// HasDocumentation return true if the column has documentation
	HasDocumentation bool
	// Name is the name of this column
	Name string
	// Type is the database type of this column
	Type string
	// Tage is the field tag
	Tag string
}

type ColumnType struct {
	// Name of the column type
	Name string
	// Underlying is the name of the column data type (the underlying type of the domain, if applicable)
	Underlying string
	// IsPrimaryKey returns true if the column is in primary key
	IsPrimaryKey bool
	// IsNullable determines whether the column allow null values
	IsNullable bool
	// IsUnsigned returns true if the numeric type is unassigned
	IsUnsigned bool
	// CharMaxLength determines the maximum length for character types
	CharMaxLength int
	// Precision for numeric type
	Precision int
	// PrecisionScale for numeric type
	PrecisionScale int
}

type CompositeTagBuilder []TagBuilder

type Executor struct {
	// Generator is the generator
	Generator Generator
	// Provider provides information the database schema
	Provider SchemaProvider
}

type FileSystem = fs.FS

type GORMTagBuilder struct{}

type Generator interface {
	// Generate generates a model or script
	Generate(ctx *GeneratorContext) error
}

type GeneratorContext struct {
	// Template name
	Template string
	// Writer where the output will be written
	Writer io.Writer
	// Schema definition
	Schema *Schema
}

type JSONTagBuilder struct{}

type ModelProvider struct {
	// Config for this provider
	Config *ModelProviderConfig
	// Provider represents the actual provider
	Provider SchemaProvider
	// TagBuilder builds struct tags from column type
	TagBuilder TagBuilder
}

type ModelProviderConfig struct {
	// Package name
	Package string
	// UseNamedParams determines whether to use named params
	UseNamedParams bool
	// InlcudeDoc determines whether to include documentation
	InlcudeDoc bool
}

type MySQLProvider struct {
	// DB is a connection to MySQL database
	DB Querier
}

type NoopTagBuilder struct{}

type PostgreSQLProvider struct {
	// DB is a connection to PostgreSQL database
	DB Querier
}

type Querier interface {
	// Query performs a query and returns a set of rows
	Query(query string, args ...interface{}) (*sql.Rows, error)
	// QueryRow performs a query and returns a row
	QueryRow(query string, args ...interface{}) *sql.Row
	// Close closes the connection
	Close() error
}

type SQLXTagBuilder struct{}

type SQLiteProvider struct {
	// DB is a connection to PostgreSQL database
	DB Querier
}

type Schema struct {
	// Name of the schema
	Name string
	// Driver name
	Driver string
	// Tables are the associated tables
	Tables []Table
	// IsDefault returns if this schema is default
	IsDefault bool
	// Model for this schema
	Model SchemaModel
}

type SchemaModel struct {
	// Package name
	Package string
	// HasDocumentation return true if the schema has documentation
	HasDocumentation bool
}

type SchemaProvider interface {
	// Tables returns all tables for this schema
	Tables(schema string) ([]string, error)
	// Schema returns the schema definition
	Schema(schema string, tables ...string) (*Schema, error)
	// Close closes connection to the db
	Close() error
}

type Spec struct {
	// Filename of the spec
	Filename string
	// Template name
	Template string
	// FileSystem is the underlying file system
	FileSystem WriteFileSystem
	// Schema is the database schema name
	Schema string
	// Tables is the list of the desired tables from the database schema
	Tables []string
	// IgnoreTables ecludes the those tables from generation
	IgnoreTables []string
}

type Table struct {
	// Name of this table
	Name string
	// Driver name
	Driver string
	// Model representation of this table
	Model TableModel
	// Columns of this table
	Columns []Column
}

type TableModel struct {
	// HasDocumentation return true if the table has documentation
	HasDocumentation bool
	// Type of this model
	Type string
	// Package name
	Package string
	// InsertRoutine is the insert routine name
	InsertRoutine string
	// InsertColumns are the columns
	InsertColumns string
	// InsertValues are the values to be inserted
	InsertValues string
	// SelectByPKRoutine is the select by primary key routine
	SelectByPKRoutine string
	// SelectAllRoutine is the select-all's routine
	SelectAllRoutine string
	// DeleteByPkRoutine is the delete by primary key routine
	DeleteByPKRoutine string
	// UpdateByPKRoutine is the update by primary key routine
	UpdateByPKRoutine string
	// UpdateByPKColumns is the columns for update condition
	UpdateByPKColumns string
	// PrimaryKeyCondition is a where clause condition
	PrimaryKeyCondition string
	// PrimaryKeyParams is the primary key args
	PrimaryKeyParams string
	// PrimaryKeyEntityParams is the primary key args
	PrimaryKeyEntityParams string
	// PrimaryKeyArgs is the primary key args
	PrimaryKeyArgs string
	// PrimaryKey is the map of primary key args
	PrimaryKey map[string]string
}

type TagBuilder interface {
	// Build returns a struct tag from column type
	Build(column *Column) string
}

type TypeDef struct {
	// Type name
	Type string
	// NullableType name
	NullableType string
}

type ValidateTagBuilder struct{}

type WriteFileSystem interface {
	FileSystem

	// OpenFile opens a new file
	OpenFile(string, int, fs.FileMode) (fs.File, error)
}

type XMLTagBuilder struct{}