orm

package

v0.14.0 Latest Latest Go to latest Published: Dec 28, 2022 License: MIT Imports: 5 Imported by: 13

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/stephenafamo/bob

Links

Documentation ¶

Index ¶

Constants
func SkipHooks(ctx context.Context) context.Context
type Columns
- func NewColumns(names ...string) Columns
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
type RelationshipChainError
- func (e *RelationshipChainError) Error() string

Constants ¶

View Source

const (
	// The prefix of an eager loaded relationship
	CtxLoadPrefix ctxKey = iota
	// The alias of an eager loader's parent
	CtxLoadParentAlias
)

Variables ¶

This section is empty.

Functions ¶

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.

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] struct {
	// contains filtered or unexported fields
}

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

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

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

Add a hook to the set

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

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

type RelSetDetails struct {
	TableName string
	Mapped    []RelSetMapping
}

type RelSetMapping ¶ added in v0.6.1

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

type RelSide ¶ added in v0.2.1

type RelSide struct {
	From        string
	FromColumns []string
	To          string
	ToColumns   []string

	FromWhere, ToWhere []RelWhere

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

type RelWhere ¶ added in v0.6.1

type RelWhere struct {
	Column string
	Value  string
}

type Relationship ¶

type Relationship struct {
	Name        string
	ByJoinTable bool
	Sides       []RelSide

	Ignored bool // Can be set through user configuration
}

func (Relationship) Foreign ¶ added in v0.6.1

func (r Relationship) Foreign() string

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

func (r Relationship) NeededColumns() []string

func (Relationship) StaticSides ¶ added in v0.6.1

func (r Relationship) StaticSides() []struct {
	Table   string
	Columns [][2]string
}

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL