repo

type AggregateFunction string

type BatchProcessOptions struct {
	// DeleteMode indicates that items are being deleted during processing.
	// When true, the offset is not incremented to avoid skipping records.
	DeleteMode bool
}

type ComparisonOp string

type CompositeKey struct {
	IsStrict bool // IsStrict indicates if the composite key will use AND logic / OR logic for conditions.
	Conds    []Condition
}

type CompositeKeyEntry struct {
	Key Key
	Err error
}

type CompositeKeyGroup struct {
	CompositeKey CompositeKey
	IsStrict     bool
}

type Condition struct {
	Field QueryField
	Value CompositeKeyEntry
}

type JoinClause struct {
	OnCondition JoinCondition
	Type        JoinType
}

type JoinCondition struct {
	Table     table
	Field     string
	JoinTable table
	JoinField string
}

type JoinType string

type Key struct {
	Value     any
	Operation ComparisonOp
}

type LoadEntity interface {
	model.System |
		model.KeyConfiguration
}

type LoadingFields struct {
	Table       table
	JoinField   QueryField
	SelectField SelectField
}

type Opt[T LoadEntity] func(*T) error

type OrderDirection string

type OrderField struct {
	Field     QueryField
	Direction OrderDirection
}

type Pagination struct {
	Skip  int
	Top   int
	Count bool
}

type Preload []string

type Query struct {
	// Limit is a max size of returned elements.
	Limit int

	Offset int

	// CompositeKeys form the where part of the Query
	CompositeKeyGroup []CompositeKeyGroup

	// PreloadModel specifies which associations to preload.
	PreloadModel Preload

	// Used when updating a model with zero-values
	// If All is true all fields will be updated. Otherwise only the provided will be updated
	// If this is not provided, only non-zero values are updated
	UpdateFields Update

	// Used whenever a custom select is desired
	// By default, if this is not provided select all fields
	SelectFields []*SelectField

	// Joins stores the JOIN clauses for the query.
	Joins []JoinClause

	// Used to aggregate columns. Use on GroupBy
	Group []QueryField

	OrderFields []OrderField
}

type QueryField = string

type QueryFieldValue = string

type QueryFunction struct {
	Function AggregateFunction
	Distinct bool
}

type QueryMapper interface {
	GetQuery(ctx context.Context) *Query
	GetUUID(field QueryField) (uuid.UUID, error)
	GetPagination() Pagination
}

type Repo interface {
	Create(ctx context.Context, resource Resource) error
	List(ctx context.Context, resource Resource, result any, query Query) error
	Delete(ctx context.Context, resource Resource, query Query) (bool, error)
	First(ctx context.Context, resource Resource, query Query) (bool, error)
	Patch(ctx context.Context, resource Resource, query Query) (bool, error)
	Set(ctx context.Context, resource Resource) error
	Transaction(ctx context.Context, txFunc TransactionFunc) error
	Count(ctx context.Context, resource Resource, query Query) (int, error)
	OffboardTenant(ctx context.Context, tenantID string) error
}

type Resource interface {
	IsSharedModel() bool
	TableName() string
}

type SelectField struct {
	Field QueryField
	Func  QueryFunction
	Alias string
}

type TransactionFunc func(context.Context) error

type UniqueConstraintError struct {
	Detail string
}

type Update struct {
	Fields []QueryField
	All    bool
}