gormschema

Documentation

Index

• type Loader
  • func New(dialect string, opts ...Option) *Loader
  • func (l *Loader) Load(models ...any) (string, error)
• type Option
  • func WithConfig(cfg *gorm.Config) Option
  • func WithJoinTable(model any, field string, jointable any) Option
• type ViewDefiner
• type ViewOption
  • func BuildStmt(fn func(db *gorm.DB) *gorm.DB) ViewOption
  • func CreateStmt(stmt string) ViewOption

Types

type Loader

type Loader struct {
	// contains filtered or unexported fields
}

Loader is a Loader for gorm schema.

func New

func New(dialect string, opts ...Option) *Loader

New returns a new Loader.

func (*Loader) Load

func (l *Loader) Load(models ...any) (string, error)

Load loads the models and returns the DDL statements representing the schema.

type Option

type Option func(*Loader)

Option configures the Loader.

func WithConfig

func WithConfig(cfg *gorm.Config) Option

WithConfig sets the gorm config.

func WithJoinTable

func WithJoinTable(model any, field string, jointable any) Option

WithJoinTable sets up a join table for the given model and field. Deprecated: put the join tables alongside the models in the Load call.

type ViewDefiner

type ViewDefiner interface {
	ViewDef(dialect string) []ViewOption
}

ViewDefiner defines a view.

type ViewOption

type ViewOption func(*viewBuilder)

ViewOption configures a viewBuilder.

func BuildStmt

func BuildStmt(fn func(db *gorm.DB) *gorm.DB) ViewOption

BuildStmt accepts a function with gorm query builder to create a CREATE VIEW statement. With this option, the view's name will be the same as the model's table name

func CreateStmt

func CreateStmt(stmt string) ViewOption

CreateStmt accepts raw SQL to create a CREATE VIEW statement.