orm

Documentation

Index

• Constants
• func Except(cols []string, excludes ...string) []string
• func Only(cols []string, includes ...string) []string
• func SkipHooks(ctx context.Context) context.Context
• type Columns
  • func NewColumns(names ...string) Columns
  • func (c Columns) Except(cols ...string) Columns
  • func (c Columns) Names() []string
  • func (c Columns) Only(cols ...string) Columns
  • func (c Columns) WithAggFunc(a, b string) Columns
  • func (c Columns) WithParent(p ...string) Columns
  • func (c Columns) WithPrefix(prefix string) Columns
  • func (c Columns) WriteSQL(w io.Writer, d bob.Dialect, start int) ([]any, error)
• type Hook
• type Hooks
  • func (h *Hooks[T]) Add(hook Hook[T])
  • func (h *Hooks[T]) Do(ctx context.Context, exec bob.Executor, o T) (context.Context, error)
• type RelSetDetails
• type RelSetMapping
• type RelSide
• type RelWhere
• type Relationship
  • func (r Relationship) Foreign() string
  • func (r Relationship) InsertEarly() bool
  • func (r Relationship) IsRemovable() bool
  • func (r Relationship) IsToMany() bool
  • func (r Relationship) Local() string
  • func (r Relationship) NeededColumns() []string
  • func (r Relationship) ValuedSides() []RelSetDetails
• type RelationshipChainError
  • func (e *RelationshipChainError) Error() string

Constants

const (
	// The alias of an eager loader's parent
	CtxLoadParentAlias ctxKey = iota
	// A schema to use when non was specified during generation
	CtxUseSchema
)

Functions

func Except

func Except(cols []string, excludes ...string) []string

Except drops the given column names from the column set

func Only

func Only(cols []string, includes ...string) []string

Only drops other column names from the column set

func SkipHooks

func SkipHooks(ctx context.Context) context.Context

SkipHooks modifies a context to prevent hooks from running for any query it encounters.

Types

type Columns

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

func NewColumns

func NewColumns(names ...string) Columns

NewColumns returns a Columns object with the given column names

func (Columns) Except

func (c Columns) Except(cols ...string) Columns

Except drops the given column names from the column set

func (Columns) Names

func (c Columns) Names() []string

Names returns the names of the columns

func (Columns) Only

func (c Columns) Only(cols ...string) Columns

Only drops other column names from the column set

func (Columns) WithAggFunc

func (c Columns) WithAggFunc(a, b string) Columns

func (Columns) WithParent

func (c Columns) WithParent(p ...string) Columns

WithPrefix sets the parent of the columns

func (Columns) WithPrefix

func (c Columns) WithPrefix(prefix string) Columns

WithPrefix sets the prefix of the aliases of the column set

func (Columns) WriteSQL

func (c Columns) WriteSQL(w io.Writer, d bob.Dialect, start int) ([]any, error)

type Hook

type Hook[T any] func(context.Context, bob.Executor, T) (context.Context, error)

Hook is a function that can be called during lifecycle of an object the context can be modified and returned The caller is expected to use the returned context for subsequent processing

type Hooks

type Hooks[T any] struct {
	// contains filtered or unexported fields
}

Hooks is a set of hooks that can be called all at once

func (*Hooks[T]) Add

func (h *Hooks[T]) Add(hook Hook[T])

Add a hook to the set

func (*Hooks[T]) Do

func (h *Hooks[T]) Do(ctx context.Context, exec bob.Executor, o T) (context.Context, error)

Do calls all the registered hooks. if the context is set to skip hooks using SkipHooks, then Do simply returns the context

type RelSetDetails

type RelSetDetails struct {
	TableName string
	Mapped    []RelSetMapping
}

type RelSetMapping

type RelSetMapping struct {
	Column         string
	Value          string
	ExternalTable  string
	ExternalColumn string
}

type RelSide

type RelSide struct {
	From string `yaml:"from"`
	To   string `yaml:"to"`

	// To make sure the column lengths match and are in the right order,
	// a slice of tupules is expected.
	// bobgen-helpers.GenConfig has a function to spread that into From/ToColumns
	Columns     [][2]string `yaml:"columns"`
	FromColumns []string    `yaml:"-"`
	ToColumns   []string    `yaml:"-"`

	FromWhere []RelWhere `yaml:"from_where"`
	ToWhere   []RelWhere `yaml:"to_where"`

	// If the destination columns contain the key
	// if false, it means the source columns are the foreign key
	ToKey bool `yaml:"to_key"`
	// if the destination is unique
	ToUnique bool `yaml:"to_unique"`
	// If the key is nullable. We need this to know if we can remove the
	// relationship without deleting it
	KeyNullable bool `yaml:"key_nullable"`

	// Kinda hacky, used for preloading
	ToExpr func(context.Context) bob.Expression `json:"-" yaml:"-"`
}

type RelWhere

type RelWhere struct {
	Column  string `yaml:"column"`
	Value   string `yaml:"value"`
	GoValue string `yaml:"go_value"`
}

type Relationship

type Relationship struct {
	Name        string    `yaml:"name"`
	ByJoinTable bool      `yaml:"by_join_table"`
	Sides       []RelSide `yaml:"sides"`

	Ignored bool // Can be set through user configuration

	// if present is used instead of computing from the columns
	// only expected to be set by drivers not by configuration
	// configuration should set aliases though the alias configuration
	Alias string `yaml:"-"`
}

func (Relationship) Foreign

func (r Relationship) Foreign() string

func (Relationship) InsertEarly

func (r Relationship) InsertEarly() bool

func (Relationship) IsRemovable

func (r Relationship) IsRemovable() bool

func (Relationship) IsToMany

func (r Relationship) IsToMany() bool

func (Relationship) Local

func (r Relationship) Local() string

func (Relationship) NeededColumns

func (r Relationship) NeededColumns() []string

func (Relationship) ValuedSides

func (r Relationship) ValuedSides() []RelSetDetails

type RelationshipChainError

type RelationshipChainError struct {
	Table1  string
	Column1 string
	Value   string
	Table2  string
	Column2 string
}

RelationshipChainError is the error returned when a wrong value is encountered in a relationship chain

func (*RelationshipChainError) Error

func (e *RelationshipChainError) Error() string