driver

Documentation

Index

• type Config
• type DBInfo
• type IndexExtra
• type Interface
  • func New(config Config) Interface

Types

type Config

type Config struct {
	// The database connection string
	DSN string
	// The database schemas to generate models for
	// a map of the schema name to the DSN
	Attach map[string]string
	// The name of this schema will not be included in the generated models
	// a context value can then be used to set the schema at runtime
	// useful for multi-tenant setups
	SharedSchema string `yaml:"shared_schema"`
	// List of tables that will be included. Others are ignored
	Only map[string][]string
	// List of tables that will be should be ignored. Others are included
	Except map[string][]string
	// Which `database/sql` driver to use (the full module name)
	DriverName string `yaml:"driver_name"`

	// The name of the folder to output the models package to
	Output string
	// The name you wish to assign to your generated models package
	Pkgname   string
	NoFactory bool `yaml:"no_factory"`
}

type DBInfo

type DBInfo = drivers.DBInfo[any, any, IndexExtra]

type IndexExtra

type IndexExtra = struct {
	Partial bool `json:"partial"`
}

type Interface

type Interface = drivers.Interface[any, any, IndexExtra]

func New

func New(config Config) Interface