| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>DruidTable (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.adapter.druid, class: DruidTable"> |
| <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>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="sub-nav-list"> |
| <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> |
| <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.adapter.druid</a></div> |
| <h1 title="Class DruidTable" class="title">Class DruidTable</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="../../schema/impl/AbstractTable.html" title="class in org.apache.calcite.schema.impl">org.apache.calcite.schema.impl.AbstractTable</a> |
| <div class="inheritance">org.apache.calcite.adapter.druid.DruidTable</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a></code>, <code><a href="../../schema/TranslatableTable.html" title="interface in org.apache.calcite.schema">TranslatableTable</a></code>, <code><a href="../../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DruidTable</span> |
| <span class="extends-implements">extends <a href="../../schema/impl/AbstractTable.html" title="class in org.apache.calcite.schema.impl">AbstractTable</a> |
| implements <a href="../../schema/TranslatableTable.html" title="interface in org.apache.calcite.schema">TranslatableTable</a></span></div> |
| <div class="block">Table mapped onto a Druid table.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</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">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final org.joda.time.Interval</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_INTERVAL" class="member-name-link">DEFAULT_INTERVAL</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_TIMESTAMP_COLUMN" class="member-name-link">DEFAULT_TIMESTAMP_COLUMN</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.adapter.druid.DruidSchema,java.lang.String,org.apache.calcite.rel.type.RelProtoDataType,java.util.Set,java.lang.String,java.util.List,java.util.Map,java.util.Map)" class="member-name-link">DruidTable</a><wbr>(<a href="DruidSchema.html" title="class in org.apache.calcite.adapter.druid">DruidSchema</a> schema, |
| <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> dataSource, |
| <a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a> protoRowType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<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>> metricFieldNames, |
| <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> timestampFieldName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.joda.time.Interval> intervals, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid">ComplexMetric</a>>> complexMetrics, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>> allFields)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a Druid table.</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-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></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"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid">ComplexMetric</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComplexMetricsFrom(java.lang.String)" class="member-name-link">getComplexMetricsFrom</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> alias)</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 list of <a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid"><code>ComplexMetric</code></a> that match the given |
| <code>alias</code> if it exists, otherwise returns an empty list, never |
| <code>null</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)" class="member-name-link">getRowType</a><wbr>(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns this table's row type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isComplexMetric(java.lang.String)" class="member-name-link">isComplexMetric</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> alias)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether the given <code>alias</code> is a reference to a |
| registered <a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid"><code>ComplexMetric</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMetric(java.lang.String)" class="member-name-link">isMetric</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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRolledUp(java.lang.String)" class="member-name-link">isRolledUp</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> column)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines whether the given <code>column</code> has been rolled up.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid">ComplexMetric</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resolveComplexMetric(java.lang.String,org.apache.calcite.rel.core.AggregateCall)" class="member-name-link">resolveComplexMetric</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> alias, |
| <a href="../../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a> call)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the appropriate <a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid"><code>ComplexMetric</code></a> that is mapped from the given <code>alias</code> |
| if it exists, and is used in the expected context with the given <a href="../../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core"><code>AggregateCall</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)" class="member-name-link">rolledUpColumnValidInsideAgg</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> column, |
| <a href="../../sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| @Nullable <a href="../../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> parent, |
| @Nullable <a href="../../config/CalciteConnectionConfig.html" title="interface in org.apache.calcite.config">CalciteConnectionConfig</a> config)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines whether the given rolled up column can be used inside the given aggregate function.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toRel(org.apache.calcite.plan.RelOptTable.ToRelContext,org.apache.calcite.plan.RelOptTable)" class="member-name-link">toRel</a><wbr>(<a href="../../plan/RelOptTable.ToRelContext.html" title="interface in org.apache.calcite.plan">RelOptTable.ToRelContext</a> context, |
| <a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> relOptTable)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Converts this table into a <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expression</code></a>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.schema.impl.AbstractTable">Methods inherited from class org.apache.calcite.schema.impl.<a href="../../schema/impl/AbstractTable.html" title="class in org.apache.calcite.schema.impl">AbstractTable</a></h3> |
| <code><a href="../../schema/impl/AbstractTable.html#getJdbcTableType()">getJdbcTableType</a>, <a href="../../schema/impl/AbstractTable.html#getStatistic()">getStatistic</a>, <a href="../../schema/impl/AbstractTable.html#unwrap(java.lang.Class)">unwrap</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#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/Object.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/Object.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/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#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/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#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/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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.schema.Table">Methods inherited from interface org.apache.calcite.schema.<a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a></h3> |
| <code><a href="../../schema/Table.html#getJdbcTableType()">getJdbcTableType</a>, <a href="../../schema/Table.html#getStatistic()">getStatistic</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.schema.Wrapper">Methods inherited from interface org.apache.calcite.schema.<a href="../../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></h3> |
| <code><a href="../../schema/Wrapper.html#maybeUnwrap(java.lang.Class)">maybeUnwrap</a>, <a href="../../schema/Wrapper.html#unwrapOrThrow(java.lang.Class)">unwrapOrThrow</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="DEFAULT_TIMESTAMP_COLUMN"> |
| <h3>DEFAULT_TIMESTAMP_COLUMN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name">DEFAULT_TIMESTAMP_COLUMN</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.calcite.adapter.druid.DruidTable.DEFAULT_TIMESTAMP_COLUMN">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_INTERVAL"> |
| <h3>DEFAULT_INTERVAL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">org.joda.time.Interval</span> <span class="element-name">DEFAULT_INTERVAL</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.adapter.druid.DruidSchema,java.lang.String,org.apache.calcite.rel.type.RelProtoDataType,java.util.Set,java.lang.String,java.util.List,java.util.Map,java.util.Map)"> |
| <h3>DruidTable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DruidTable</span><wbr><span class="parameters">(<a href="DruidSchema.html" title="class in org.apache.calcite.adapter.druid">DruidSchema</a> schema, |
| <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> dataSource, |
| <a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a> protoRowType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<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>> metricFieldNames, |
| <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> timestampFieldName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.joda.time.Interval> intervals, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid">ComplexMetric</a>>> complexMetrics, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>> allFields)</span></div> |
| <div class="block">Creates a Druid table.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>schema</code> - Druid schema that contains this table</dd> |
| <dd><code>dataSource</code> - Druid data source name</dd> |
| <dd><code>protoRowType</code> - Field names and types</dd> |
| <dd><code>metricFieldNames</code> - Names of fields that are metrics</dd> |
| <dd><code>intervals</code> - Default interval if query does not constrain the time, or null</dd> |
| <dd><code>timestampFieldName</code> - Name of the column that contains the time</dd> |
| </dl> |
| </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="resolveComplexMetric(java.lang.String,org.apache.calcite.rel.core.AggregateCall)"> |
| <h3>resolveComplexMetric</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid">ComplexMetric</a></span> <span class="element-name">resolveComplexMetric</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> alias, |
| <a href="../../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a> call)</span></div> |
| <div class="block">Returns the appropriate <a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid"><code>ComplexMetric</code></a> that is mapped from the given <code>alias</code> |
| if it exists, and is used in the expected context with the given <a href="../../rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core"><code>AggregateCall</code></a>. |
| Otherwise returns <code>null</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRolledUp(java.lang.String)"> |
| <h3>isRolledUp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRolledUp</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> column)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../schema/Table.html#isRolledUp(java.lang.String)">Table</a></code></span></div> |
| <div class="block">Determines whether the given <code>column</code> has been rolled up.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../schema/Table.html#isRolledUp(java.lang.String)">isRolledUp</a></code> in interface <code><a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../schema/impl/AbstractTable.html#isRolledUp(java.lang.String)">isRolledUp</a></code> in class <code><a href="../../schema/impl/AbstractTable.html" title="class in org.apache.calcite.schema.impl">AbstractTable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)"> |
| <h3>rolledUpColumnValidInsideAgg</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">rolledUpColumnValidInsideAgg</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> column, |
| <a href="../../sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| @Nullable <a href="../../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> parent, |
| @Nullable <a href="../../config/CalciteConnectionConfig.html" title="interface in org.apache.calcite.config">CalciteConnectionConfig</a> config)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../schema/Table.html#rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)">Table</a></code></span></div> |
| <div class="block">Determines whether the given rolled up column can be used inside the given aggregate function. |
| You can assume that <code>isRolledUp(column)</code> is <code>true</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../schema/Table.html#rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)">rolledUpColumnValidInsideAgg</a></code> in interface <code><a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../schema/impl/AbstractTable.html#rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)">rolledUpColumnValidInsideAgg</a></code> in class <code><a href="../../schema/impl/AbstractTable.html" title="class in org.apache.calcite.schema.impl">AbstractTable</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>column</code> - The column name for which <code>isRolledUp</code> is true</dd> |
| <dd><code>call</code> - The aggregate call</dd> |
| <dd><code>parent</code> - Parent node of <code>call</code> in the <a href="../../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> tree</dd> |
| <dd><code>config</code> - Config settings. May be null</dd> |
| <dt>Returns:</dt> |
| <dd>true iff the given aggregate call is valid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComplexMetricsFrom(java.lang.String)"> |
| <h3>getComplexMetricsFrom</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid">ComplexMetric</a>></span> <span class="element-name">getComplexMetricsFrom</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> alias)</span></div> |
| <div class="block">Returns the list of <a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid"><code>ComplexMetric</code></a> that match the given |
| <code>alias</code> if it exists, otherwise returns an empty list, never |
| <code>null</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isComplexMetric(java.lang.String)"> |
| <h3>isComplexMetric</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isComplexMetric</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> alias)</span></div> |
| <div class="block">Returns whether the given <code>alias</code> is a reference to a |
| registered <a href="ComplexMetric.html" title="class in org.apache.calcite.adapter.druid"><code>ComplexMetric</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)"> |
| <h3>getRowType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getRowType</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../schema/Table.html#getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)">Table</a></code></span></div> |
| <div class="block">Returns this table's row type. |
| |
| <p>This is a struct type whose |
| fields describe the names and types of the columns in this table.</p> |
| |
| <p>The implementer must use the type factory provided. This ensures that |
| the type is converted into a canonical form; other equal types in the same |
| query will use the same object.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../schema/Table.html#getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)">getRowType</a></code> in interface <code><a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>typeFactory</code> - Type factory with which to create the type</dd> |
| <dt>Returns:</dt> |
| <dd>Row type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toRel(org.apache.calcite.plan.RelOptTable.ToRelContext,org.apache.calcite.plan.RelOptTable)"> |
| <h3>toRel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">toRel</span><wbr><span class="parameters">(<a href="../../plan/RelOptTable.ToRelContext.html" title="interface in org.apache.calcite.plan">RelOptTable.ToRelContext</a> context, |
| <a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> relOptTable)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../schema/TranslatableTable.html#toRel(org.apache.calcite.plan.RelOptTable.ToRelContext,org.apache.calcite.plan.RelOptTable)">TranslatableTable</a></code></span></div> |
| <div class="block">Converts this table into a <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expression</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../schema/TranslatableTable.html#toRel(org.apache.calcite.plan.RelOptTable.ToRelContext,org.apache.calcite.plan.RelOptTable)">toRel</a></code> in interface <code><a href="../../schema/TranslatableTable.html" title="interface in org.apache.calcite.schema">TranslatableTable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isMetric(java.lang.String)"> |
| <h3>isMetric</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isMetric</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> |
| </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> |