bake

bake

A database model code generator for Go. Generate ORM models from database schema using bun framework.

Features

• Supports MySQL and PostgreSQL databases
• Automatic Go type mapping for database columns
• Automatic foreign key detection and relation tag generation
• Customizable templates
• Custom field names, types, comments, and tags
• Table relationship support (has-many, has-one)
• Naming conventions (snake_case, camelCase)
• Timezone support for created_at, updated_at, deleted_at hooks

Installation

go install github.com/sishui/bake/cmd/bake@latest

Quick Start

1. Initialize a configuration file:

bake init

1. Edit bake.gen.yaml with your database connection details

2. Generate models:

bake

Commands

Configuration

Basic Configuration

log:
  level: "info"  # debug, info, warn, error
  file: ""       # log file path (optional)

initialisms: ["ID", "URL", "URI", "UUID", "IP"]  # naming conventions

timezone: "Asia/Shanghai"  # timezone for time hooks

template:
  dir: ""        # custom template directory
  model: "model" # template filename

output:
  dir: "model"                         # output directory
  package: "model"                     # package name
  module: "github.com/username/project" # module path for imports

db:
  - driver: "postgres"
    dsn: "postgres://user:pass@localhost:5432/db?sslmode=disable"
    schema: "public"
    included: []    # tables to include (default: all)
    excluded: []    # tables to exclude (default: none)

Custom Table Settings

db:
  - driver: "postgres"
    # ...
    customs:
      users:
        comment: "User table"  # custom table comment
        tags:
          - key: "form"
            name: "$SnakeCase"  # convert to snake_case
          - key: "xml"
            name: "$CamelCase"  # convert to camelCase
        fields:
          created_at:  # database column name
            name: "CreatedAt"   # custom field name
            tags:
              - key: "json"
                name: "created_at"  # custom json tag name
      posts:
        fields:
          author_id:
            name: "Author"         # custom field name
            type: "*User"          # custom field type
            relation: true        # is a relation
            tags:
              - key: "bun"
                options: ["rel:belongs", "join:author_id=id"]

Tag Name Transformations

Template Data Structure

You can use custom templates. The following data is passed to templates:

type Model struct {
    Version            string     // bake version
    Package            string     // package name
    Imports            [][]string // grouped imports
    BunModel           string     // bun.BaseModel
    Table              string     // table name
    Model              string     // model struct name
    Alias              string     // model alias
    Comments           []string   // model comments
    Fields             []*Field   // model fields
    Timezone           string     // timezone
    CreatedAtType      string     // created_at field type
    UpdatedAtType      string     // updated_at field type
    DeletedAtType      string     // deleted_at field type
    MaxFieldLength     int        // max field name length
    MaxNullableLength  int        // max nullable field length
    MaxStringLength    int        // max string field length
    MaxNumericLength   int        // max numeric field length
    MaxOrderedLength   int        // max ordered field length
    MaxEquatableLength int        // max equatable field length
    MaxRelationLength  int        // max relation field length
}

type Field struct {
    Name        string   // field name
    Type        string   // Go type
    Tag         string   // field tags
    Comments    []string // field comments
    ColumnName  string   // database column name
    Kind        string   // field kind: NUMERIC, STRING, TIME, etc.
    IsPrimary   bool     // is primary key
    IsNullable  bool     // is nullable
    IsCustom    bool     // is custom field
    IsRelation  bool     // is relation field
}

Type Mappings

MySQL

PostgreSQL

Foreign Key Relations

bake automatically detects foreign key relationships from your database schema and generates the appropriate bun relation tags.

How It Works

When a column has a foreign key constraint:

-- posts.user_id references users.id
ALTER TABLE posts ADD CONSTRAINT fk_posts_user_id 
  FOREIGN KEY (user_id) REFERENCES users(id);

bake will automatically:

1. Set IsRelation = true on the field
2. Generate the bun relation tag: bun:"user_id,rel:belongs-to,join:user_id=id"

Generated Example

For the posts table with user_id foreign key:

type Post struct {
    bun.BaseModel `bun:"table:posts"`
    
    ID        int32     `bun:"id,pk,autoincrement"`
    UserID    int64     `bun:"user_id,rel:belongs-to,join:user_id=id" json:"user_id,omitempty"`
    Title     string    `bun:"title,notnull" json:"title,omitempty"`
}

Manual Override

You can still manually configure relations using the customs configuration. Manual configuration takes precedence over automatic detection.

Development

Running Tests

go test ./...

Building

go build ./cmd/bake

License

Apache License 2.0 - see LICENSE file