org.apache.calcite.util.trace

Class CalciteTrace

java.lang.Object

org.apache.calcite.util.trace.CalciteTrace

public abstract class CalciteTrace
extends Object

Contains all of the tracers used within org.apache.calcite class libraries.

Note to developers

Please ensure that every tracer used in org.apache.calcite is added to this class as a public static final member called componentTracer. For example, getPlannerTracer() is the tracer used by all classes which take part in the query planning process.

The javadoc in this file is the primary source of information on what tracers are available, so the javadoc against each tracer member must be an up-to-date description of what that tracer does. Be sure to describe what tracing level is required to obtain each category of tracing.

In the class where the tracer is used, create a private (or perhaps protected) static final member called tracer.

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	PARSER_LOGGER The "org.apache.calcite.sql.parser" tracer reports parser events in SqlParser and other classes (at level Level.FINE or higher).

Constructor Summary

Constructors

Constructor and Description
CalciteTrace()

Method Summary

Methods

Modifier and Type	Method and Description
static ThreadLocal<Function2<Void,File,String>>	getDynamicHandler() Thread-local handler that is called with dynamically generated Java code.
static Logger	getParserTracer() The "org.apache.calcite.sql.parser" tracer reports parse events.
static Logger	getPlannerTracer() The "org.apache.calcite.plan.RelOptPlanner" tracer prints the query optimization process.
static Logger	getRelImplementorTracer() The "org.apache.calcite.rel.RelImplementorImpl" tracer reports when expressions are bound to variables (Level.FINE)
static Logger	getSqlTimingTracer() The tracer "org.apache.calcite.sql.timing" traces timing for various stages of query processing.
static Logger	getSqlToRelTracer() The "org.apache.calcite.sql2rel" tracer reports parse events.
static Logger	getStatementTracer() The "org.apache.calcite.prepare.Prepare" tracer prints the generated program at level Level.FINE or higher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARSER_LOGGER

public static final Logger PARSER_LOGGER

The "org.apache.calcite.sql.parser" tracer reports parser events in SqlParser and other classes (at level Level.FINE or higher).

Constructor Detail

CalciteTrace

public CalciteTrace()

Method Detail

getPlannerTracer

public static Logger getPlannerTracer()

The "org.apache.calcite.plan.RelOptPlanner" tracer prints the query optimization process.

Levels:

• Level.FINE prints rules as they fire;
• Level.FINER prints and validates the whole expression pool and rule queue as each rule fires;
• Level.FINEST prints finer details like rule importances.

getStatementTracer

public static Logger getStatementTracer()

The "org.apache.calcite.prepare.Prepare" tracer prints the generated program at level Level.FINE or higher.

getRelImplementorTracer

public static Logger getRelImplementorTracer()

The "org.apache.calcite.rel.RelImplementorImpl" tracer reports when expressions are bound to variables (Level.FINE)

getSqlTimingTracer

public static Logger getSqlTimingTracer()

The tracer "org.apache.calcite.sql.timing" traces timing for various stages of query processing.

See Also:

CalciteTimingTracer

getParserTracer

public static Logger getParserTracer()

The "org.apache.calcite.sql.parser" tracer reports parse events.

getSqlToRelTracer

public static Logger getSqlToRelTracer()

The "org.apache.calcite.sql2rel" tracer reports parse events.

getDynamicHandler

public static ThreadLocal<Function2<Void,File,String>> getDynamicHandler()

Thread-local handler that is called with dynamically generated Java code. It exists for unit-testing. The handler is never null; the default handler does nothing.