query

package
Version: v0.35.9 Latest Latest
Warning

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

Go to latest
Published: Jul 20, 2022 License: Apache-2.0 Imports: 7 Imported by: 310

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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 added in v0.35.1

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

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

func MustCompile added in v0.35.1

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 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, error)

Matches satisfies part of the pubsub.Query interface. This implementation never reports an error. A nil *Query matches all events.

func (*Query) String

func (q *Query) String() string

String matches part of the pubsub.Query interface.

func (*Query) Syntax added in v0.35.1

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

Syntax returns the syntax tree representation of q.

Source Files

Directories

Path Synopsis
Package syntax defines a scanner and parser for the Tendermint event filter query language.
Package syntax defines a scanner and parser for the Tendermint event filter query language.

Jump to

Keyboard shortcuts

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