filter

Documentation

Overview

Package filter provides filters for squirrel.

Index

• type Filter
  • func New(column string, ftype Type, value any) Filter
  • func (f Filter) SetOperator(operator Operator) Filter
  • func (f Filter) UseSelectBuilder(sb sq.SelectBuilder) sq.SelectBuilder
  • func (f Filter) WithFilters(filters ...Filter) Filter
• type Operator
• type Type

Types

type Filter

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

Filter is a filter for squirrel.SelectBuilder.

func New

func New(column string, ftype Type, value any) Filter

New creates a new filter.

func (Filter) SetOperator

func (f Filter) SetOperator(operator Operator) Filter

SetOperator sets operator for linking filters.

func (Filter) UseSelectBuilder

func (f Filter) UseSelectBuilder(sb sq.SelectBuilder) sq.SelectBuilder

UseSelectBuilder adds filters to squirrel.SelectBuilder.

func (Filter) WithFilters

func (f Filter) WithFilters(filters ...Filter) Filter

WithFilters adds filters.

type Operator

type Operator uint8

Operator is an operator for linking filters.

const (
	// OperatorAnd is an operator for AND linking filters.
	OperatorAnd Operator = iota + 1
	// OperatorOr is an operator for OR linking filters.
	OperatorOr
)

type Type

type Type uint8

Type is a type of filter.

const (
	// TypeEQ value is equal.
	TypeEQ Type = iota + 1

	// TypeNotEQ value is not equal.
	TypeNotEQ

	// TypeGTE greater than value.
	TypeGTE

	// TypeGT value greater.
	TypeGT

	// TypeLT value less.
	TypeLT

	// TypeLTE value less or equals.
	TypeLTE

	// TypeLike value can contain.
	TypeLike

	// TypeNotLike value cannot contain.
	TypeNotLike

	// TypeILike value can contain (case insensitive).
	TypeILike

	// TypeNotILike value cannot contain (case insensitive).
	TypeNotILike
)