Bob Gen for MySQL

Generates an ORM based on a MySQL database schema

Usage

# With env variable
MYSQL_DSN=user:pass@tcp(host:port)/dbname go run github.com/stephenafamo/bob/gen/bobgen-mysql@latest

# With configuration file
go run github.com/stephenafamo/bob/gen/bobgen-mysql@latest -c ./config/bobgen.yaml

Driver Configuration

Link to general configuration and usage

The configuration for the MySQL driver must all be prefixed by the driver name. You must use a configuration file or environment variables for configuring the database driver.

In the configuration file for MySQL for example you would do:

mysql:
  dsn: "user:pass@tcp(host:port)/dbname"

When you use an environment variable it must also be prefixed by the driver name:

MYSQL_DSN="user:pass@tcp(host:port)/dbname"

The values that exist for the drivers:

Name	Description	Default
dsn	URL to connect to
output	Folder for generated files	"models"
pkgname	Package name for generated code	"models"
concurrency	How many tables to fetch in parallel	10
only	Only generate these
except	Skip generation for these

Only/Except:

The only and except configuration options can be used to specify which tables to include or exclude from code generation. You can either supply a list of table names or use regular expressions to match multiple tables.

Consider the example below:

mysql:
  only:
    "/^foo/":
    bar_baz:

This configuration only generates models for tables that start with foo and the table named bar_baz.

Alternatively, the following example excludes these tables from code generation rather than including them:

mysql:
  except:
    "/^foo/":
    bar_baz:

You may also exclude specific columns:

mysql:
  # Removes public.migrations table, the name column from the addresses table, and
  # secret_col of any table from being generated. Foreign keys that reference tables
  # or columns that are no longer generated may cause problems.
  except:
    public.migrations:
    public.addresses:
      - name
    "*":
      - secret_col