codegen

type Dialect string

type InputParam struct {
	// Name of the param, like 'FirstName' in pggen.arg('FirstName').
	PgName string
	// The database type of this param as reported by the database.
	Type sqltype.Type
}

type OutputColumn struct {
	// Name of an output column, named by the database, like "foo" in
	// "SELECT 1 as foo".
	PgName string
	// The database type of the column as reported by the database.
	Type sqltype.Type
	// If the type can be null; depends on the query. In Postgres a column
	// defined with a NOT NULL constraint can still be null in the output with a
	// left join, and nullability is determined using rudimentary control-flow
	// analysis. ClickHouse reports nullability exactly, in the type itself.
	Nullable bool
}

type QueryFile struct {
	SourcePath string       // absolute path to the source SQL query file
	Queries    []TypedQuery // the typed queries
}

type TypedQuery struct {
	// Name of the query, from the comment preceding the query. Like 'FindAuthors'
	// in the source SQL: "-- name: FindAuthors :many"
	Name string
	// The result output kind, :one, :many, or :exec.
	ResultKind ast.ResultKind
	// The comment lines preceding the query, without the SQL comment syntax and
	// excluding the :name line.
	Doc []string
	// The SQL query, with pggen functions replaced by the dialect's parameter
	// syntax. Ready to run on the database.
	PreparedSQL string
	// The input parameters to the query.
	Inputs []InputParam
	// The output columns of the query.
	Outputs []OutputColumn
	// Qualified protocol buffer message type to use for each output row, like
	// "erp.api.Product". If empty, generate our own Row type.
	ProtobufType string
	// User-specified output row struct name, like "ItemRow". If set, multiple
	// queries can share the same output struct.
	OutputType string
	// User-specified exported name for the query's SQL constant, like
	// "ItemsSQL". Empty means the constant keeps its unexported default name
	// and only the generated method reads it.
	SQLConst string
	// Set when this query is one fanned-out statement of a paginate=<spec>
	// query. VariantGroup is the public dispatcher name; VariantKey identifies
	// the sort key + direction. Empty VariantGroup means an ordinary query.
	VariantGroup string
	VariantKey   ast.VariantKey
}