builder

Documentation

Index

• Constants
• func BindingsFrom(operations Operations) sql.Encoder
• func FilterFrom(operations Operations) string
• type Modifier
• type Op
• type Operations
  • func FilterEpochOnly(publish types.EpochID) Operations

Constants

const (
	Eq    token = "="
	NotEq token = "!="
	Gt    token = ">"
	Gte   token = ">="
	Lt    token = "<"
	Lte   token = "<="
	In    token = "in"
)

const (
	And operator = "and"
	Or  operator = "or"
)

const (
	Epoch     field = "epoch"
	Smesher   field = "pubkey"
	Coinbase  field = "coinbase"
	Id        field = "id"
	Layer     field = "layer"
	Address   field = "address"
	Principal field = "principal"
)

const (
	Offset  modifier = "offset"
	Limit   modifier = "limit"
	OrderBy modifier = "order by"
	GroupBy modifier = "group by"
)

Functions

func BindingsFrom

func BindingsFrom(operations Operations) sql.Encoder

func FilterFrom

func FilterFrom(operations Operations) string

Types

type Modifier

type Modifier struct {
	Key modifier
	// Value will be type casted to one the expected types.
	// Modifier will panic if it doesn't match any of expected.
	Value any
}

type Op

type Op struct {
	// Prefix will be added before field name
	Prefix string
	Field  field
	Token  token
	// Value will be type casted to one the expected types.
	// Operation will panic if it doesn't match any of expected.
	Value any

	Group         []Op
	GroupOperator operator

	// CustomQuery is used to add custom query. If this is set, Field and Token will be ignored.
	// This is useful for complex queries that can't be expressed with Field and Token.
	// Value will be used for custom query if it's not nil.
	// Remember about setting correct bind index for Value.
	CustomQuery string
}

type Operations

type Operations struct {
	Filter    []Op
	Modifiers []Modifier
	StartWith string
}

func FilterEpochOnly

func FilterEpochOnly(publish types.EpochID) Operations