tmquery

Documentation

Overview

Package query implements the custom query format used to filter event subscriptions in Tendermint.

Query expressions describe properties of events and their attributes, using strings like:

abci.invoice.number = 22 AND abci.invoice.owner = 'Ivan'

Query expressions can handle attribute values encoding numbers, strings, dates, and timestamps. The complete query grammar is described in the query/syntax package.

Index

• type Query
  • func Compile(ast syntax.Query) (*Query, error)
  • func MustCompile(query string) *Query
  • func MustParse(s string) *Query
  • func New(query string) (*Query, error)
  • func (q *Query) Matches(events []types.Event) bool
  • func (q *Query) String() string
  • func (q *Query) Syntax() syntax.Query

Types

type Query

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

A Query is the compiled form of a query.

var All *Query

All is a query that matches all events.

func Compile

func Compile(ast syntax.Query) (*Query, error)

Compile compiles the given query AST so it can be used to match events.

func MustCompile

func MustCompile(query string) *Query

MustCompile compiles the query expression into an executable query. In case of error, MustCompile will panic.

This is intended for use in program initialization; use query.New if you need to check errors.

func MustParse

func MustParse(s string) *Query

MustParse turns the given string into a query or panics; for tests or others cases where you know the string is valid.

func New

func New(query string) (*Query, error)

New parses and compiles the query expression into an executable query.

func (*Query) Matches

func (q *Query) Matches(events []types.Event) bool

Matches reports whether q matches the given events. If q == nil, the query matches any non-empty collection of events.

func (*Query) String

func (q *Query) String() string

String matches part of the pubsub.Query interface.

func (*Query) Syntax

func (q *Query) Syntax() syntax.Query

Syntax returns the syntax tree representation of q.