predicate

package
v0.6.0 Latest Latest
Warning

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

Go to latest
Published: Sep 23, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package predicate provides a simple way to build SQL predicates.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Field

type Field[T any] struct {
	Tokens []Token[T]
}

Field is a Field predicate.

func EQ

func EQ[T any](v T) *Field[T]

EQ is a shortcut of `NewFP[T]().EQ(v)`.

func EQZ

func EQZ[T any](v T) *Field[T]

EQZ is a shortcut of `NewFP[T]().Zero().EQ(v)`.

func GT

func GT[T any](v T) *Field[T]

GT is a shortcut of `NewFP[T]().GT(v)`.

func GTE

func GTE[T any](v T) *Field[T]

GTE is a shortcut of `NewFP[T]().GTE(v)`.

func In

func In[T any](v []T) *Field[T]

In is a shortcut of `NewFP[T]().In(v)`.

func IsNull

func IsNull[T any]() *Field[T]

IsNull is a shortcut of `NewFP[T]().IsNull()`.

func LT

func LT[T any](v T) *Field[T]

LT is a shortcut of `NewFP[T]().LT(v)`.

func LTE

func LTE[T any](v T) *Field[T]

LTE is a shortcut of `NewFP[T]().LTE(v)`.

func NEQ

func NEQ[T any](v T) *Field[T]

NEQ is a shortcut of `NewFP[T]().NEQ(v)`.

func NewField

func NewField[T any]() *Field[T]

func NotIn

func NotIn[T any](v []T) *Field[T]

NotIn is a shortcut of `NewFP[T]().NotIn(v)`.

func (*Field[T]) BuildFieldBun

func (f *Field[T]) BuildFieldBun(name string, qb bun.QueryBuilder)

func (*Field[T]) EQ

func (f *Field[T]) EQ(v T) *Field[T]

EQ is `=` in SQL.

func (*Field[T]) GT

func (f *Field[T]) GT(v T) *Field[T]

GT is `>` in SQL.

func (*Field[T]) GTE

func (f *Field[T]) GTE(v T) *Field[T]

GTE is `>=` in SQL.

func (*Field[T]) Group

func (f *Field[T]) Group(fn func(f *Field[T])) *Field[T]

Group groups the sub FP.

func (*Field[T]) In

func (f *Field[T]) In(vs []T) *Field[T]

In is `IN` in SQL.

func (*Field[T]) IsNop

func (f *Field[T]) IsNop() bool

IsNop indicates whether there is no operation.

func (*Field[T]) IsNotNull

func (f *Field[T]) IsNotNull() *Field[T]

IsNull is `IS NOT NULL` in SQL.

func (*Field[T]) IsNull

func (f *Field[T]) IsNull() *Field[T]

IsNull is `IS NULL` in SQL.

func (*Field[T]) LT

func (f *Field[T]) LT(v T) *Field[T]

LT is `<` in SQL.

func (*Field[T]) LTE

func (f *Field[T]) LTE(v T) *Field[T]

LTE is `<=` in SQL.

func (*Field[T]) Like

func (f *Field[T]) Like(v T) *Field[T]

Like is `LIKE` in SQL.

func (*Field[T]) NEQ

func (f *Field[T]) NEQ(v T) *Field[T]

NEQ is `<>` in SQL.

func (*Field[T]) Not

func (f *Field[T]) Not() *Field[T]

Not add the `NOT` operator to the next predicate.

func (*Field[T]) NotIn

func (f *Field[T]) NotIn(vs []T) *Field[T]

NotIn is `NOT IN` in SQL.

func (*Field[T]) Or

func (f *Field[T]) Or() *Field[T]

Or add the `OR` operator to the next predicate (default `AND`).

func (*Field[T]) Zero

func (f *Field[T]) Zero() *Field[T]

Zero makes the next predicate not skip zero value.

Attention: it has no effect on Group.

type Op

type Op int

Op represents an operator.

This is copied from ent: https://github.com/ent/ent/blob/cf2428d49a59ed30335d2cf10b509d4934a1c73b/dialect/sql/builder.go#L3382

func (Op) IsIn

func (o Op) IsIn() bool

func (Op) IsUnary

func (o Op) IsUnary() bool

func (Op) String

func (o Op) String() string

type Predicate

type Predicate[T any] struct {
	Op Op
	V  T // Value
	Vs []T
}

func (Predicate[T]) IsNop

func (p Predicate[T]) IsNop() bool

type Token

type Token[T any] struct {
	Type  TokenType
	Pred  Predicate[T]
	Group *Field[T]
}

type TokenType

type TokenType int8
const (
	Pred TokenType = iota
	Or
	Not
	Zero // Do not omit zero value
	Group
)

Jump to

Keyboard shortcuts

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