efeqt

Documentation

Index

• Constants
• Variables
• func CreateFieldsTsVector(values Map, fields ...Field) string
• func Entity[E entity](override ...Override) *E
• func TsVector(values ...any) string
• type BuildResult
• type DuplicatesBuilder
• type EntityBuilder
  • func (b EntityBuilder) Field(name string) Field
• type EntityMigrator
  • func Migrate[E entity](db *esquel.DB) EntityMigrator
• type Field
• type FilterBuilder
  • func Filter(modifiers ...Modifier) FilterBuilder
• type FindRepository
• type Map
• type Modifier
  • func After(use ...bool) Modifier
  • func Or(use ...bool) Modifier
• type Override
• type QueryBuilder
  • func Fragment(builders ...QueryBuilder) QueryBuilder
  • func If(condition bool, qb QueryBuilder) QueryBuilder
  • func Use(values any) QueryBuilder
• type RelationshipBuilder
  • func Relationship(relationshipField Field) RelationshipBuilder
• type RemoveRepository
• type RepositoryManager
  • func Repository[E entity](db *esquel.DB) RepositoryManager[E]
• type Runner
  • func Run(db *esquel.DB) Runner
• type Safe
• type SaveRepository
• type SelectorBuilder
  • func Selector(fields ...QueryBuilder) SelectorBuilder
• type ShapeBuilder
  • func Shape() ShapeBuilder
• type SortBuilder
• type Sorter
• type TemporaryBuilder
  • func Temporary(name string, qb QueryBuilder) TemporaryBuilder
• type Value

Constants

const (
	Insert = "INSERT"
	Update = "UPDATE"
)

const (
	SortUp   = "ASC"
	SortDown = "DESC"
)

const (
	Id = "id"
)

const (
	TsVectorDataType = "TSVECTOR"
)

Variables

var (
	ErrorMissingPrimaryKey   = errors.New("missing primary key")
	ErrorMissingDatabase     = errors.New("missing database connection")
	ErrorMismatchQueryTarget = errors.New("mismatch query target len with builders")
	ErrorTargetNoPtr         = errors.New("query target is not a pointer")
	ErrorInvalidMap          = errors.New("invalid map type, needs to be map[string]any")
)

Functions

func CreateFieldsTsVector

func CreateFieldsTsVector(values Map, fields ...Field) string

func Entity

func Entity[E entity](override ...Override) *E

func TsVector

func TsVector(values ...any) string

Types

type BuildResult

type BuildResult struct {
	Sql    string
	Values map[string]any
}

type DuplicatesBuilder

type DuplicatesBuilder interface {
	QueryBuilder
	Prevent(fields ...QueryBuilder) ShapeBuilder
	Remove(remove ...bool) ShapeBuilder
}

type EntityBuilder

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

func (EntityBuilder) Field

func (b EntityBuilder) Field(name string) Field

type EntityMigrator

type EntityMigrator interface {
	Cascade(cascade ...bool) EntityMigrator
	GetUpSql() string
	GetDownSql() string
	Up() error
	Down() error

	MustUp()
	MustDown()
}

func Migrate

func Migrate[E entity](db *esquel.DB) EntityMigrator

type Field

type Field interface {
	QueryBuilder
	Default(value any) Field
	NotNull(notNull ...bool) Field
	Prefix(prefix string) Field
	PrimaryKey(primaryKey ...bool) Field
	Type(dataType string) Field
	Unique(unique ...bool) Field
	Relationship(relationship Field) Field
	CreateValue(fn func(operation string, values Map) Value) Field
	Name() string
	TsVector() Field
	Serial() Field
	Bool() Field
	Char(n int) Field
	Varchar(n int) Field
	Jsonb() Field
	Int() Field
	Float() Field
	Timestamp() Field
	Timestampz() Field
}

type FilterBuilder

type FilterBuilder interface {
	QueryBuilder
	Group(builders ...FilterBuilder) FilterBuilder
	Field(field QueryBuilder) FilterBuilder
	Equal(equal ...bool) FilterBuilder
	Is() FilterBuilder
	In(in ...bool) FilterBuilder
	Value(value any, name ...string) FilterBuilder
	Gt() FilterBuilder
	Gte() FilterBuilder
	Lt() FilterBuilder
	Lte() FilterBuilder
	Match() FilterBuilder
	Not(not ...bool) FilterBuilder
	TsQuery(values ...any) FilterBuilder
	Null() FilterBuilder
}

func Filter

func Filter(modifiers ...Modifier) FilterBuilder

type FindRepository

type FindRepository interface {
	QueryBuilder
	Run(result any, runner ...Runner) error
	MustRun(result any, runner ...Runner)
}

type Map

type Map = map[string]any

type Modifier

type Modifier interface {
	Type() string
}

func After

func After(use ...bool) Modifier

func Or

func Or(use ...bool) Modifier

type Override

type Override struct {
	Table string
	Alias string
}

type QueryBuilder

type QueryBuilder interface {
	Build() BuildResult
}

func Fragment

func Fragment(builders ...QueryBuilder) QueryBuilder

func If

func If(condition bool, qb QueryBuilder) QueryBuilder

func Use

func Use(values any) QueryBuilder

type RelationshipBuilder

type RelationshipBuilder interface {
	QueryBuilder
	Keep() RelationshipBuilder
	Prefer() RelationshipBuilder
	Intersect() RelationshipBuilder
	Unify() RelationshipBuilder
	Combine() RelationshipBuilder
}

func Relationship

func Relationship(relationshipField Field) RelationshipBuilder

type RemoveRepository

type RemoveRepository interface {
	QueryBuilder
	Run(result any, runner ...Runner) error
	MustRun(result any, runner ...Runner)
}

type RepositoryManager

type RepositoryManager[E entity] interface {
	Find(builders ...QueryBuilder) FindRepository
	Save(builders ...QueryBuilder) SaveRepository
	Remove(builders ...QueryBuilder) RemoveRepository
}

func Repository

func Repository[E entity](db *esquel.DB) RepositoryManager[E]

type Runner

type Runner interface {
	Add(builders ...QueryBuilder)
	AllInSequence(target ...any) error
	AllInParallel(target ...any) error
	MustAllInSequence(target ...any)
	MustAllInParallel(target ...any)
}

func Run

func Run(db *esquel.DB) Runner

type Safe

type Safe = esquel.Safe

type SaveRepository

type SaveRepository interface {
	QueryBuilder
	Run(result any, runner ...Runner) error
	MustRun(result any, runner ...Runner)
	ForceInsert() SaveRepository
}

type SelectorBuilder

type SelectorBuilder interface {
	QueryBuilder
	Group(qb QueryBuilder) SelectorBuilder
	Field(field QueryBuilder) SelectorBuilder
	As(value string) SelectorBuilder
	Count(f QueryBuilder) SelectorBuilder
	Sum(f QueryBuilder) SelectorBuilder
	Min(qb QueryBuilder) SelectorBuilder
	Max(qb QueryBuilder) SelectorBuilder
	Avg(qb QueryBuilder) SelectorBuilder
}

func Selector

func Selector(fields ...QueryBuilder) SelectorBuilder

type ShapeBuilder

type ShapeBuilder interface {
	QueryBuilder
	Start(start int) ShapeBuilder
	Max(max int) ShapeBuilder
	Duplicates() DuplicatesBuilder
	Sort(aliases ...map[string]Field) SortBuilder
}

func Shape

func Shape() ShapeBuilder

type SortBuilder

type SortBuilder interface {
	QueryBuilder
	Use(sorters ...Sorter) SortBuilder
	Up(field QueryBuilder) SortBuilder
	Down(field QueryBuilder) SortBuilder
}

type Sorter

type Sorter struct {
	Field     string `json:"field"`
	Direction string `json:"direction"`
}

type TemporaryBuilder

type TemporaryBuilder interface {
	QueryBuilder
}

func Temporary

func Temporary(name string, qb QueryBuilder) TemporaryBuilder

type Value

type Value any