| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Hook (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.runtime, enum: Hook"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#enum-constant-summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#enum-constant-detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.runtime</a></div> |
| <h1 title="Enum Hook" class="title">Enum Hook</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>> |
| <div class="inheritance">org.apache.calcite.runtime.Hook</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">Hook</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>></span></div> |
| <div class="block">Collection of hooks that can be set by observers and are executed at various |
| parts of the query preparation process. |
| |
| <p>For testing and debugging rather than for end-users.</p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="Hook.Closeable.html" class="type-name-link" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Removes a Hook after use.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> |
| </section> |
| </li> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <li> |
| <section class="constants-summary" id="enum-constant-summary"> |
| <h2>Enum Constant Summary</h2> |
| <div class="caption"><span>Enum Constants</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Enum Constant</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="#CONVERTED" class="member-name-link">CONVERTED</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called with the output of sql-to-rel-converter.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#CREATE_MATERIALIZATION" class="member-name-link">CREATE_MATERIALIZATION</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Called when materialization is created.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#CURRENT_TIME" class="member-name-link">CURRENT_TIME</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called to get the current time.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#ENABLE_BINDABLE" class="member-name-link">ENABLE_BINDABLE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Returns a boolean value, whether the return convention should be |
| <a href="../interpreter/BindableConvention.html" title="enum in org.apache.calcite.interpreter"><code>BindableConvention</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#EXPRESSION_REDUCER" class="member-name-link">EXPRESSION_REDUCER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called when a constant expression is being reduced.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#JAVA_PLAN" class="member-name-link">JAVA_PLAN</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Called with the generated Java plan, just before it is compiled by |
| Janino.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#PARSE_TREE" class="member-name-link">PARSE_TREE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called with the SQL string and parse tree, in an array.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#PLAN_BEFORE_IMPLEMENTATION" class="member-name-link">PLAN_BEFORE_IMPLEMENTATION</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Called when a plan is about to be implemented (e.g.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#PLANNER" class="member-name-link">PLANNER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called with the created planner.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#PROGRAM" class="member-name-link">PROGRAM</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Called to create a Program to optimize the statement.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#QUERY_PLAN" class="member-name-link">QUERY_PLAN</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called with a query that has been generated to send to a back-end system.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#REL_BUILDER_SIMPLIFY" class="member-name-link">REL_BUILDER_SIMPLIFY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Returns a boolean value, whether RelBuilder should simplify expressions.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#SQL2REL_CONVERTER_CONFIG_BUILDER" class="member-name-link">SQL2REL_CONVERTER_CONFIG_BUILDER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called before SqlToRelConverter is built.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#STANDARD_STREAMS" class="member-name-link">STANDARD_STREAMS</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Called to get stdin, stdout, stderr.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#STRING_TO_QUERY" class="member-name-link">STRING_TO_QUERY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Converts a SQL string to a |
| <a href="../jdbc/CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc"><code>CalcitePrepare.Query</code></a> object.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#SUB" class="member-name-link">SUB</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Called by the planner after substituting a materialization.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#TRIMMED" class="member-name-link">TRIMMED</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called after de-correlation and field trimming, but before |
| optimization.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><T> <a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#add(java.util.function.Consumer)" class="member-name-link">add</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><T> handler)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">this installs a global hook (cross-thread), so it might have greater impact |
| than expected.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><T,<wbr> |
| R> <a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#add(java.util.function.Function)" class="member-name-link">add</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><T,<wbr>R> handler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#add(java.util.function.Consumer)"><code>add(Consumer)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><T,<wbr> |
| R> <a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#addThread(com.google.common.base.Function)" class="member-name-link">addThread</a><wbr>(com.google.common.base.Function<T,<wbr>R> handler)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#addThread(java.util.function.Consumer)"><code>addThread(Consumer)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> <a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addThread(java.util.function.Consumer)" class="member-name-link">addThread</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><T> handler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a handler for this thread.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><V> V</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(V)" class="member-name-link">get</a><wbr>(V defaultValue)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the value of a property hook.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <V> com.google.common.base.Function<<a href="../util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#property(V)" class="member-name-link">property</a><wbr>(V v)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#propertyJ(V)"><code>propertyJ(V)</code></a>.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <V> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="../util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#propertyJ(V)" class="member-name-link">propertyJ</a><wbr>(V v)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a function that, when a hook is called, will "return" a given |
| value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#run(java.lang.Object)" class="member-name-link">run</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> arg)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Runs all handlers registered for this Hook, with the given argument.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <li> |
| <section class="constant-details" id="enum-constant-detail"> |
| <h2>Enum Constant Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="CURRENT_TIME"> |
| <h3>CURRENT_TIME</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">CURRENT_TIME</span></div> |
| <div class="block">Called to get the current time. Use this to return a predictable time |
| in tests.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="STANDARD_STREAMS"> |
| <h3>STANDARD_STREAMS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">STANDARD_STREAMS</span></div> |
| <div class="block">Called to get stdin, stdout, stderr. |
| Use this to re-assign streams in tests.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REL_BUILDER_SIMPLIFY"> |
| <h3>REL_BUILDER_SIMPLIFY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">REL_BUILDER_SIMPLIFY</span></div> |
| <div class="block">Returns a boolean value, whether RelBuilder should simplify expressions. |
| Default true.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ENABLE_BINDABLE"> |
| <h3>ENABLE_BINDABLE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">ENABLE_BINDABLE</span></div> |
| <div class="block">Returns a boolean value, whether the return convention should be |
| <a href="../interpreter/BindableConvention.html" title="enum in org.apache.calcite.interpreter"><code>BindableConvention</code></a>. |
| Default false.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PARSE_TREE"> |
| <h3>PARSE_TREE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">PARSE_TREE</span></div> |
| <div class="block">Called with the SQL string and parse tree, in an array.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="STRING_TO_QUERY"> |
| <h3>STRING_TO_QUERY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">STRING_TO_QUERY</span></div> |
| <div class="block">Converts a SQL string to a |
| <a href="../jdbc/CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc"><code>CalcitePrepare.Query</code></a> object. This hook is |
| an opportunity to execute a <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> query |
| plan in the JDBC driver rather than the usual SQL string.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="JAVA_PLAN"> |
| <h3>JAVA_PLAN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">JAVA_PLAN</span></div> |
| <div class="block">Called with the generated Java plan, just before it is compiled by |
| Janino.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SQL2REL_CONVERTER_CONFIG_BUILDER"> |
| <h3>SQL2REL_CONVERTER_CONFIG_BUILDER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">SQL2REL_CONVERTER_CONFIG_BUILDER</span></div> |
| <div class="block">Called before SqlToRelConverter is built.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CONVERTED"> |
| <h3>CONVERTED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">CONVERTED</span></div> |
| <div class="block">Called with the output of sql-to-rel-converter.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PLANNER"> |
| <h3>PLANNER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">PLANNER</span></div> |
| <div class="block">Called with the created planner.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TRIMMED"> |
| <h3>TRIMMED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">TRIMMED</span></div> |
| <div class="block">Called after de-correlation and field trimming, but before |
| optimization.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SUB"> |
| <h3>SUB</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">SUB</span></div> |
| <div class="block">Called by the planner after substituting a materialization.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EXPRESSION_REDUCER"> |
| <h3>EXPRESSION_REDUCER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">EXPRESSION_REDUCER</span></div> |
| <div class="block">Called when a constant expression is being reduced.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PROGRAM"> |
| <h3>PROGRAM</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">PROGRAM</span></div> |
| <div class="block">Called to create a Program to optimize the statement.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CREATE_MATERIALIZATION"> |
| <h3>CREATE_MATERIALIZATION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">CREATE_MATERIALIZATION</span></div> |
| <div class="block">Called when materialization is created.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="QUERY_PLAN"> |
| <h3>QUERY_PLAN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">QUERY_PLAN</span></div> |
| <div class="block">Called with a query that has been generated to send to a back-end system. |
| The query might be a SQL string (for the JDBC adapter), a list of Mongo |
| pipeline expressions (for the MongoDB adapter), et cetera.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PLAN_BEFORE_IMPLEMENTATION"> |
| <h3>PLAN_BEFORE_IMPLEMENTATION</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.22", |
| status=EXPERIMENTAL) |
| </span><span class="modifiers">public static final</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">PLAN_BEFORE_IMPLEMENTATION</span></div> |
| <div class="block">Called when a plan is about to be implemented (e.g. implemented via Enumerable, Bindable, |
| and so on). |
| The hook supplies <a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel"><code>RelRoot</code></a> as an argument.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="values()"> |
| <h3>values</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>[]</span> <span class="element-name">values</span>()</div> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueOf(java.lang.String)"> |
| <h3>valueOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.util.function.Consumer)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="annotations">@API(status=MAINTAINED) |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><T> handler)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">this installs a global hook (cross-thread), so it might have greater impact |
| than expected. Use with caution. Prefer thread-local hooks.</div> |
| </div> |
| <div class="block">Adds a handler for this Hook. |
| |
| <p>Returns a <a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime"><code>Hook.Closeable</code></a> so that you can use the following |
| try-finally pattern to prevent leaks:</p> |
| |
| <blockquote><pre> |
| final Hook.Closeable closeable = Hook.FOO.add(HANDLER); |
| try { |
| ... |
| } finally { |
| closeable.close(); |
| }</pre> |
| </blockquote></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#addThread(java.util.function.Consumer)"><code>addThread(Consumer)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.util.function.Function)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="type-parameters"><T,<wbr> |
| R></span> <span class="return-type"><a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><T,<wbr>R> handler)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#add(java.util.function.Consumer)"><code>add(Consumer)</code></a>.</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addThread(java.util.function.Consumer)"> |
| <h3>addThread</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type"><a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span> <span class="element-name">addThread</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><T> handler)</span></div> |
| <div class="block">Adds a handler for this thread.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addThread(com.google.common.base.Function)"> |
| <h3>addThread</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="type-parameters"><T,<wbr> |
| R></span> <span class="return-type"><a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span> <span class="element-name">addThread</span><wbr><span class="parameters">(com.google.common.base.Function<T,<wbr>R> handler)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#addThread(java.util.function.Consumer)"><code>addThread(Consumer)</code></a>.</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="property(V)"> |
| <h3 id="property(java.lang.Object)">property</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="type-parameters"><V></span> |
| <span class="return-type">com.google.common.base.Function<<a href="../util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">property</span><wbr><span class="parameters">(V v)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="#propertyJ(V)"><code>propertyJ(V)</code></a>.</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="propertyJ(V)"> |
| <h3 id="propertyJ(java.lang.Object)">propertyJ</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><V></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="../util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>></span> <span class="element-name">propertyJ</span><wbr><span class="parameters">(V v)</span></div> |
| <div class="block">Returns a function that, when a hook is called, will "return" a given |
| value. (Because of the way hooks work, it "returns" the value by writing |
| into a <a href="../util/Holder.html" title="class in org.apache.calcite.util"><code>Holder</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="run(java.lang.Object)"> |
| <h3>run</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">run</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> arg)</span></div> |
| <div class="block">Runs all handlers registered for this Hook, with the given argument.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(V)"> |
| <h3 id="get(java.lang.Object)">get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><V></span> <span class="return-type">V</span> <span class="element-name">get</span><wbr><span class="parameters">(V defaultValue)</span></div> |
| <div class="block">Returns the value of a property hook. |
| (Property hooks take a <a href="../util/Holder.html" title="class in org.apache.calcite.util"><code>Holder</code></a> as an argument.)</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
