| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>CalciteTrace (Apache Calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CalciteTrace (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CalciteTrace.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.util.trace</a></div> |
| <h2 title="Class CalciteTrace" class="title">Class CalciteTrace</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.util.trace.CalciteTrace</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">CalciteTrace</span> |
| extends java.lang.Object</pre> |
| <div class="block">Contains all of the <code>tracers</code> used within |
| org.apache.calcite class libraries. |
| |
| <h3>Note to developers</h3> |
| |
| <p>Please ensure that every tracer used in org.apache.calcite is added to |
| this class as a <em>public static final</em> member called <code> |
| <i>component</i>Tracer</code>. For example, <a href="#getPlannerTracer()"><code>getPlannerTracer()</code></a> is the |
| tracer used by all classes which take part in the query planning process. |
| |
| <p>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. |
| |
| <p>In the class where the tracer is used, create a <em>private</em> (or |
| perhaps <em>protected</em>) <em>static final</em> member called <code> |
| tracer</code>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static java.lang.ThreadLocal<<a href="../../linq4j/function/Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a><java.lang.Void,​java.io.File,​java.lang.String>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DYNAMIC_HANDLER">DYNAMIC_HANDLER</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARSER_LOGGER">PARSER_LOGGER</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The "org.apache.calcite.sql.parser" tracer reports parser events in |
| <a href="../../sql/parser/SqlParser.html" title="class in org.apache.calcite.sql.parser"><code>SqlParser</code></a> and other classes at DEBUG.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">CalciteTrace</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static java.lang.ThreadLocal<<a href="../../linq4j/function/Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a><java.lang.Void,​java.io.File,​java.lang.String>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDynamicHandler()">getDynamicHandler</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Thread-local handler that is called with dynamically generated Java code.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParserTracer()">getParserTracer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The "org.apache.calcite.sql.parser" tracer reports parse events.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPlannerTracer()">getPlannerTracer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The "org.apache.calcite.plan.RelOptPlanner" tracer prints the query |
| optimization process.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelImplementorTracer()">getRelImplementorTracer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The "org.apache.calcite.rel.RelImplementorImpl" tracer reports when |
| expressions are bound to variables (DEBUG, formerly FINE)</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSqlTimingTracer()">getSqlTimingTracer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The tracer "org.apache.calcite.sql.timing" traces timing for |
| various stages of query processing.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSqlToRelTracer()">getSqlToRelTracer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The "org.apache.calcite.sql2rel" tracer reports parse events.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatementTracer()">getStatementTracer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The "org.apache.calcite.prepare.Prepare" tracer prints the generated |
| program at DEBUG (formerly, FINE) or higher.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="PARSER_LOGGER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARSER_LOGGER</h4> |
| <pre>public static final org.slf4j.Logger PARSER_LOGGER</pre> |
| <div class="block">The "org.apache.calcite.sql.parser" tracer reports parser events in |
| <a href="../../sql/parser/SqlParser.html" title="class in org.apache.calcite.sql.parser"><code>SqlParser</code></a> and other classes at DEBUG.</div> |
| </li> |
| </ul> |
| <a id="DYNAMIC_HANDLER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DYNAMIC_HANDLER</h4> |
| <pre>private static final java.lang.ThreadLocal<<a href="../../linq4j/function/Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a><java.lang.Void,​java.io.File,​java.lang.String>> DYNAMIC_HANDLER</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CalciteTrace</h4> |
| <pre>public CalciteTrace()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getPlannerTracer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPlannerTracer</h4> |
| <pre class="methodSignature">public static org.slf4j.Logger getPlannerTracer()</pre> |
| <div class="block">The "org.apache.calcite.plan.RelOptPlanner" tracer prints the query |
| optimization process. |
| |
| <p>Levels: |
| |
| <ul> |
| <li><code>Logger.debug(String)</code> (formerly FINE) prints rules as they fire; |
| <li><code>Logger.trace(String)</code> (formerly FINER) prints and validates the whole expression |
| pool and rule queue as each rule fires; |
| <li><code>Logger.trace(String)</code> (formerly FINEST) also prints finer details like rule |
| importances. |
| </ul></div> |
| </li> |
| </ul> |
| <a id="getStatementTracer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatementTracer</h4> |
| <pre class="methodSignature">public static org.slf4j.Logger getStatementTracer()</pre> |
| <div class="block">The "org.apache.calcite.prepare.Prepare" tracer prints the generated |
| program at DEBUG (formerly, FINE) or higher.</div> |
| </li> |
| </ul> |
| <a id="getRelImplementorTracer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelImplementorTracer</h4> |
| <pre class="methodSignature">public static org.slf4j.Logger getRelImplementorTracer()</pre> |
| <div class="block">The "org.apache.calcite.rel.RelImplementorImpl" tracer reports when |
| expressions are bound to variables (DEBUG, formerly FINE)</div> |
| </li> |
| </ul> |
| <a id="getSqlTimingTracer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlTimingTracer</h4> |
| <pre class="methodSignature">public static org.slf4j.Logger getSqlTimingTracer()</pre> |
| <div class="block">The tracer "org.apache.calcite.sql.timing" traces timing for |
| various stages of query processing.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="CalciteTimingTracer.html" title="class in org.apache.calcite.util.trace"><code>CalciteTimingTracer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParserTracer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParserTracer</h4> |
| <pre class="methodSignature">public static org.slf4j.Logger getParserTracer()</pre> |
| <div class="block">The "org.apache.calcite.sql.parser" tracer reports parse events.</div> |
| </li> |
| </ul> |
| <a id="getSqlToRelTracer()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlToRelTracer</h4> |
| <pre class="methodSignature">public static org.slf4j.Logger getSqlToRelTracer()</pre> |
| <div class="block">The "org.apache.calcite.sql2rel" tracer reports parse events.</div> |
| </li> |
| </ul> |
| <a id="getDynamicHandler()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDynamicHandler</h4> |
| <pre class="methodSignature">public static java.lang.ThreadLocal<<a href="../../linq4j/function/Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a><java.lang.Void,​java.io.File,​java.lang.String>> getDynamicHandler()</pre> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CalciteTrace.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
