config

Documentation

Overview

Package config handles sqlgen configuration parsing and validation.

Index

• type ColumnConfig
• type Config
  • func Load(path string) (*Config, error)
  • func Parse(data []byte) (*Config, error)
• type InputConfig
• type NullType
• type OutputConfig
• type PolymorphicConfig
• type TableConfig
• type TimestampsConfig
• type TypesConfig

Types

type ColumnConfig

type ColumnConfig struct {
	// Name overrides the Go field name for this column.
	Name string `yaml:"name"`

	// Type overrides the Go type for this column.
	Type string `yaml:"type"`
}

ColumnConfig provides per-column overrides.

type Config

type Config struct {
	// Input specifies where to read the schema from.
	Input InputConfig `yaml:"input"`

	// Output specifies where and how to write generated code.
	Output OutputConfig `yaml:"output"`

	// Types configures type mapping behavior.
	Types TypesConfig `yaml:"types"`

	// Timestamps configures automatic timestamp management.
	Timestamps TimestampsConfig `yaml:"timestamps"`

	// Tags configures struct tag generation. Keys are tag names, values are casing.
	// Options: "snake", "camel", "pascal", "none" (raw DB column name).
	// Default: {"json": "snake", "db": "none"}
	Tags map[string]string `yaml:"tags"`

	// Tables allows per-table configuration overrides.
	Tables map[string]TableConfig `yaml:"tables"`

	// Polymorphic defines polymorphic relationships that can't be detected from DDL.
	// Each entry describes a type+id column pair and the tables it references.
	Polymorphic []PolymorphicConfig `yaml:"polymorphic"`
}

Config is the top-level sqlgen configuration.

func Load

func Load(path string) (*Config, error)

Load reads and parses a config file.

func Parse

func Parse(data []byte) (*Config, error)

Parse parses config from YAML bytes.

type InputConfig

type InputConfig struct {
	// Dialect is the SQL dialect to parse. Currently only "postgres".
	Dialect string `yaml:"dialect"`

	// Paths is a list of SQL files or directories to parse.
	// Mutually exclusive with DSN.
	Paths []string `yaml:"paths"`

	// DSN is a database connection string for live introspection.
	// Supports environment variable expansion (e.g., ${DATABASE_URL}).
	// Mutually exclusive with Paths.
	DSN string `yaml:"dsn"`
}

InputConfig specifies schema input sources.

type NullType

type NullType string

NullType determines how nullable columns are represented in Go.

const (
	NullTypeGeneric  NullType = "generic"  // Null[T] (default, built-in generic type)
	NullTypePointer  NullType = "pointer"  // *T
	NullTypeDatabase NullType = "database" // sql.NullString, sql.NullInt64, etc.
)

type OutputConfig

type OutputConfig struct {
	// Dir is the directory to write generated files to.
	Dir string `yaml:"dir"`

	// Package is the Go package name for generated code. Defaults to the dir basename.
	Package string `yaml:"package"`

	// Tests enables generation of _test.go files alongside models.
	Tests bool `yaml:"tests"`

	// NoHooks disables generation of hook files and hook calls in CRUD.
	NoHooks bool `yaml:"no_hooks"`

	// Templates is an optional path to a directory of .tmpl files.
	// Files matching built-in template names override them.
	// Extra .tmpl files are rendered once per table.
	Templates string `yaml:"templates"`

	// Factories enables generation of factory functions for testing.
	Factories bool `yaml:"factories"`
}

OutputConfig specifies code generation output.

type PolymorphicConfig

type PolymorphicConfig struct {
	// Table is the table containing the type+id columns.
	Table string `yaml:"table"`

	// TypeColumn is the column holding the type discriminator (e.g., "commentable_type").
	TypeColumn string `yaml:"type_column"`

	// IDColumn is the column holding the FK value (e.g., "commentable_id").
	IDColumn string `yaml:"id_column"`

	// Targets maps type discriminator values to target tables.
	// Example: {"User": "users", "Post": "posts"}
	Targets map[string]string `yaml:"targets"`
}

PolymorphicConfig defines a polymorphic relationship.

type TableConfig

type TableConfig struct {
	// Skip excludes this table from code generation.
	Skip bool `yaml:"skip"`

	// Name overrides the Go struct name for this table.
	Name string `yaml:"name"`

	// Columns provides per-column overrides.
	Columns map[string]ColumnConfig `yaml:"columns"`
}

TableConfig provides per-table overrides.

type TimestampsConfig

type TimestampsConfig struct {
	// CreatedAt is the column name for creation timestamp. Default: "created_at".
	// Set to "-" to disable.
	CreatedAt string `yaml:"created_at"`

	// UpdatedAt is the column name for update timestamp. Default: "updated_at".
	// Set to "-" to disable.
	UpdatedAt string `yaml:"updated_at"`
}

TimestampsConfig controls automatic timestamp management.

type TypesConfig

type TypesConfig struct {
	// NullType determines how nullable columns are represented.
	// Options: "generic" (default), "pointer", "database"
	NullType NullType `yaml:"null"`

	// Replacements maps DB type patterns to custom Go types.
	// Example: {"uuid": "github.com/google/uuid.UUID"}
	Replacements map[string]string `yaml:"replacements"`

	// ColumnReplacements maps "table.column" patterns to custom Go types.
	// Use "*" as table name to match all tables.
	// Examples:
	//   "users.metadata": "encoding/json.RawMessage"
	//   "*.external_id": "github.com/google/uuid.UUID"
	ColumnReplacements map[string]string `yaml:"column_replacements"`
}

TypesConfig configures type mapping behavior.