orm

package
v0.25.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 20, 2024 License: MIT Imports: 7 Imported by: 1

Documentation

Index

Constants

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

Variables

View Source 
var (
	ErrNothingToUpdate   = errors.New("nothing to update")
	ErrCannotRetrieveRow = errors.New("cannot retrieve inserted row")
	ErrCannotPrepare     = errors.New("supplied executor does not implement bob.Preparer")
)

Functions

func Except added in v0.15.0 

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

Except drops the given column names from the column set

func Only added in v0.15.0 

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

Only drops other column names from the column set

func SkipHooks added in v0.2.3 

func SkipHooks(ctx context.Context) context.Context

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

func SkipModelHooks added in v0.22.0 

func SkipModelHooks(ctx context.Context) context.Context

SkipModelHooks modifies a context to prevent hooks from running on models.

func SkipQueryHooks added in v0.22.0 

func SkipQueryHooks(ctx context.Context) context.Context

SkipQueryHooks modifies a context to prevent hooks from running on querys.

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 added in v0.3.1 

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 added in v0.2.3 

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 added in v0.2.3 

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

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

func (*Hooks[T, K]) Add added in v0.2.3 

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

Add a hook to the set

func (*Hooks[T, K]) Do added in v0.2.3 

func (h *Hooks[T, K]) 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 added in v0.6.1 

type RelSetDetails struct {
	TableName string
	Mapped    []RelSetMapping
	Position  int
	Start     bool
	End       bool
}

func (RelSetDetails) Columns added in v0.23.0 

func (r RelSetDetails) Columns() []string

func (RelSetDetails) UniqueExternals added in v0.22.0 

func (r RelSetDetails) UniqueExternals() []RelSetMapping

type RelSetMapping added in v0.6.1 

type RelSetMapping struct {
	Column         string
	Value          [2]string // [0] is the SQL value, [1] is the Go value
	ExternalTable  string
	ExternalColumn string
	ExtPosition    int
	ExternalStart  bool
	ExternalEnd    bool
}

func (RelSetMapping) HasValue added in v0.23.0 

func (r RelSetMapping) HasValue() bool

type RelSide added in v0.2.1 

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"`

	// These are columns that exist in the database, but should not be
	// considered by the relationship when determining if it is a join table
	// the columns are never set or read, so make sure they have a default value
	// or operations will fail
	// the first slice is for the from table, the second is for the to table
	IgnoredColumns [2][]string `yaml:"-"`

	// if the origin is unique
	FromUnique bool `yaml:"-"`
	// if the destination is unique
	ToUnique bool `yaml:"-"`

	// Which side to modify, "from" or "to"
	// If not set, it will try to "guess" which side to modify
	// - if only one of the sides contains a primary key,
	//   it will choose to modify the other side
	// - If (both or none) of them contains a primary key,
	//   it will try with "Unique" columns
	// - If it still cannot choose, it defaults to "to"
	Modify string `yaml:"modify"`

	// If the key is nullable. We need this to know if we can remove the
	// relationship without deleting it
	// this is set in Relationships.init()
	KeyNullable bool `yaml:"-"`

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

type RelWhere added in v0.6.1 

type RelWhere struct {
	Column   string `yaml:"column"`
	SQLValue string `yaml:"sql_value"`
	GoValue  string `yaml:"go_value"`
}

type Relationship 

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

	// These can be set through user configuration
	Ignored bool
	// Do not create the inverse of a user configured relationship
	NoReverse bool `yaml:"no_reverse"`
}

func (Relationship) Foreign added in v0.6.1 

func (r Relationship) Foreign() string

func (Relationship) ForeignPosition added in v0.22.0 

func (r Relationship) ForeignPosition() int

func (Relationship) InsertEarly added in v0.6.1 

func (r Relationship) InsertEarly() bool

func (Relationship) IsRemovable added in v0.6.1 

func (r Relationship) IsRemovable() bool

func (Relationship) IsToMany added in v0.6.1 

func (r Relationship) IsToMany() bool

func (Relationship) Local added in v0.6.1 

func (r Relationship) Local() string

func (Relationship) LocalPosition added in v0.22.0 

func (r Relationship) LocalPosition() int

func (Relationship) NeedsMany added in v0.23.0 

func (r Relationship) NeedsMany(position int) bool

NeedsMany returns true if the table on this side needs to be many

func (Relationship) Validate added in v0.23.0 

func (r Relationship) Validate() error

func (Relationship) ValuedSides added in v0.6.1 

func (r Relationship) ValuedSides() []RelSetDetails

type RelationshipChainError added in v0.6.1 

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 added in v0.6.1 

func (e *RelationshipChainError) Error() string

type Setter added in v0.22.0 

type Setter[T any, InsertQ any, UpdateQ any] interface {
	// SetColumns should return the column names that are set
	SetColumns() []string
	// Overwrite the values in T with the set values in the setter
	Overwrite(T)
	// Act as a mod for the update query
	bob.Mod[UpdateQ]
	// Return a mod for the insert query
	InsertMod() bob.Mod[InsertQ]
}

type SkipModelHooksKey added in v0.22.0 

type SkipModelHooksKey struct{}

If set to true, model hooks are skipped

type SkipQueryHooksKey added in v0.22.0 

type SkipQueryHooksKey struct{}

If set to true, query hooks are skipped

type Table added in v0.22.0 

type Table interface {
	// PrimaryKeyVals returns the values of the primary key columns
	// If a single column, expr.Arg(col) is expected
	// If multiple columns, expr.ArgGroup(col1, col2, ...) is expected
	PrimaryKeyVals() bob.Expression
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.