Skip to main content

Bob Gen for Postgres

Generates an ORM based on a postgres database schema

Usage

# With env variable
PSQL_DSN=postgres://user:pass@host:port/dbname go run github.com/stephenafamo/bob/gen/bobgen-psql@latest

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

Driver Configuration

The configuration for the postgres 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 postgresql for example you would do:

psql:
dsn: "postgres://user:pass@host:port/dbname"

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

PSQL_DSN="postgres://user:pass@host:port/dbname"

The values that exist for the drivers:

NameDescriptionDefault
dsnURL to connect to
schemasSchemas find tables in["public"]
shared_schemaSchema to not include prefix in modelfirst value in "schemas"
outputFolder for generated files"models"
pkgnamePackage name for generated code"models"
uuid_pkgUUID package to use (gofrs or google)"gofrs"
concurrencyHow many tables to fetch in parallel10
onlyOnly generate these
exceptSkip generation for these

Example of Only/Except:

psql:
# 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