pggen

README

Notice

This is a temporary fork that I have been working on with the intention of backporting the changes to the upstream pggen. It is not fully functional.

Changes

Because of the changes in how types are managed in v4 compared to v5, type registration needs to be configured in the AfterConnect function on the pgx config.

dbconfig, err := pgxpool.ParseConfig(databaseURL)
if err != nil {
	// handle error
}

dbconfig.AfterConnect = func(ctx context.Context, pgconn *pgconn.PgConn) error {
    err := your_gen_pkg.Register(ctx, pgconn)
    if err != nil {
        return fmt.Errorf("failed to register types: %w", err)
    }

    return nil
}

Features Supported

The following examples compile, and are implemented.

• example/author
• example/domain
• example/go_pointer_types
• example/inline_param_count
• example/pgcrypto
• example/slices
• example/syntax
• example/custom_types
• example/enums
• example/device
• example/function
• example/separate_out_dir/out
• example/erp/order
• example/ltree
• example/void
• example/composite

Feature Unsupported

• example/citext
• example/nested
• example/complex_params

Documentation

Index

• func Generate(opts GenerateOptions) (mErr error)
• type GenerateOptions
• type Lang

Functions

func Generate

func Generate(opts GenerateOptions) (mErr error)

Generate generates language specific code to safely wrap each SQL ast.SourceQuery in opts.QueryFiles.

Generate must only be called once per output directory.

Types

type GenerateOptions

type GenerateOptions struct {
	// What language to generate code in.
	Language Lang
	// The connection string to the running Postgres database to use to get type
	// information for each query in QueryFiles.
	//
	// Must be parseable by pgconn.ParseConfig, like:
	//
	//   # Example DSN
	//   user=jack password=secret host=pg.example.com port=5432 dbname=foo_db sslmode=verify-ca
	//
	//   # Example URL
	//   postgres://jack:secret@pg.example.com:5432/foo_db?sslmode=verify-ca
	ConnString string
	// Generate code for each of the SQL query file paths.
	QueryFiles []string
	// Schema files to run on Postgres init. Can be *.sql, *.sql.gz, or executable
	// *.sh files .
	SchemaFiles []string
	// The name of the Go package for the file. If empty, defaults to the
	// directory name.
	GoPackage string
	// Directory to write generated files. Writes one file for each query file.
	// If more than one query file, also writes querier.go.
	OutputDir string
	// A map of lowercase acronyms to the upper case equivalent, like:
	// "api" => "API", or "apis" => "APIs".
	Acronyms map[string]string
	// A map from a Postgres type name to a fully qualified Go type.
	TypeOverrides map[string]string
	// What log level to log at.
	LogLevel slog.Level
	// How many params to inline when calling querier methods.
	// Set to 0 to always create a struct for params.
	InlineParamCount int
}

GenerateOptions are the unparsed options that controls the generated Go code.

type Lang

type Lang string

Lang is a supported codegen language.

const (
	LangGo Lang = "go"
)