sqlc

type Argument ¶

type Argument struct {
	Column *Column
}

Argument represents SQL argument corresponding to a column.

func (x *Argument) String() string

type ArgumentCondition ¶

type ArgumentCondition struct {
	Column   *Column
	Argument *Argument
}

ArgumentCondition represents a simple equality condition between a column and an argument.

func (x *ArgumentCondition) String() string

type Attributes ¶

type Attributes struct {
	Comment string `json:"comment,omitempty"`
	Charset string `json:"charset,omitempty"`
	Collate string `json:"collate,omitempty"`
}

Attributes represents common attributes that can be applied to schemas, tables, and columns. These are typically dialect-specific metadata.

type Catalog ¶

type Catalog struct {
	Schemas []Schema `json:"schemas,omitempty"`
}

Catalog represents the root structure of a sqlc catalog file. It contains all schemas and their associated database objects.

func LoadCatalog(path string) (*Catalog, error)

func (x *Catalog) GetTable(name string) *Table

type Column ¶

type Column struct {
	Name string `json:"name"`
	Type string `json:"type,omitempty"`
	Null bool   `json:"null,omitempty"`
	// Inherit common attributes
	Attributes
}

Column represents a table column with its name, data type, and nullability.

type ColumnCondition ¶

type ColumnCondition struct {
	Left  *ColumnRef
	Right *ColumnRef
}

func (x *ColumnCondition) String() string

type ColumnRef ¶

type ColumnRef struct {
	Name  string
	Table *Table
}

ColumnRef represents a reference to a specific column within a table.

func (x *ColumnRef) String() string

type CompositeCondition ¶

type CompositeCondition struct {
	Operator   string
	Conditions []fmt.Stringer
}

CompositeCondition represents a combination of multiple conditions using a logical operator (e.g., AND, OR).

func (x *CompositeCondition) AddColumn(column *Column)

func (x *CompositeCondition) AddColumnRef(left, right *ColumnRef)

func (x *CompositeCondition) String() string

type Config ¶

type Config struct {
	Version string `yaml:"version"`
	SQL     []SQL  `yaml:"sql"`
}

Config represents the root structure of a sqlc.yaml configuration file. This file controls how sqlc generates Go code from SQL schemas and queries.

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

type ForeignKey ¶

type ForeignKey struct {
	Name       string   `json:"name"`
	Columns    []string `json:"columns,omitempty"`
	References struct {
		Table   string   `json:"table"`
		Columns []string `json:"columns,omitempty"`
	} `json:"references"`
}

ForeignKey represents a foreign key constraint linking columns in this table to columns in a referenced table.

type Generator ¶

type Generator struct {
	Config  *Config
	Catalog *Catalog
}

Generator generates an SQL queries

func (x *Generator) Generate() error

type Index ¶

type Index struct {
	Name   string      `json:"name,omitempty"`
	Unique bool        `json:"unique,omitempty"`
	Parts  []IndexPart `json:"parts,omitempty"`
}

Index represents a database index on one or more columns or expressions.

func (x *Index) HasExpr() bool

type IndexPart ¶

type IndexPart struct {
	Desc   bool   `json:"desc,omitempty"`
	Column string `json:"column,omitempty"`
	Expr   string `json:"expr,omitempty"`
}

IndexPart represents a single part of an index, which can be either a column or an expression.

type SQL ¶

type SQL struct {
	Schema      string   `yaml:"schema"`
	Engine      string   `yaml:"engine"`
	Queries     string   `yaml:"queries"`
	SkipQueries []string `yaml:"skip_queries,omitempty"`
}

SQL represents a single SQL configuration block within the sqlc.yaml file. Each SQL block defines the schema files, query files, and database engine for a specific code generation target.

func (s *SQL) GetSkipQueriesSet() map[string]bool

type Schema ¶

type Schema struct {
	Name   string  `json:"name"`
	Tables []Table `json:"tables,omitempty"`
	// Inherit common attributes
	Attributes
}

Schema represents a database schema containing tables and other database objects.

type Table ¶

type Table struct {
	Name        string       `json:"name"`
	Columns     []Column     `json:"columns,omitempty"`
	Indexes     []Index      `json:"indexes,omitempty"`
	PrimaryKey  *Index       `json:"primary_key,omitempty"`
	ForeignKeys []ForeignKey `json:"foreign_keys,omitempty"`
	// Inherit common attributes
	Attributes
}

Table represents a database table with its columns, indexes, and constraints.

func (x *Table) GetColumn(name string) *Column

func (x *Table) GetNonPrimaryKeyColumns() []Column

func (x *Table) GetNonUniqueIndexes() []*Index

func (x *Table) GetUniqueKeys() []*Index