debug

Documentation

Overview

Package debug contains functions to help track details about query processing and report them.

Index

• type Tracker
  • func New(debug bool, debugOut io.Writer, clock clocks.Source, index blog.Index, ...) Tracker

Types

type Tracker

type Tracker interface {
	Parsed(*parser.Query, error)
	Rewritten(*parser.Query, error)
	DecorateStats(planner.Stats) planner.Stats
	Planned(*search.Space, *plandef.Plan, error)
	DecorateLookups(lookups.All) lookups.All
	ExecEvents(plan *plandef.Plan) exec.Events
	Close()
}

Tracker defines points in the query processing sequence. The Query Engine will call these at the appropriate places in the processing.

func New

func New(debug bool, debugOut io.Writer, clock clocks.Source, index blog.Index, query string) Tracker

New returns a new Tracker. The caller is expected to arrange for the various methods on Tracker to get called at the right time. It is unlikely that you need to create one of these unless you're working in the query package itself. If 'debug' is set the tracker will accumulate a detailed query report and write it to debugOut. If debugOut is nil, the report will be written to a file in $TMPDIR. If 'debug' is false, a no-op Tracker is returned.