| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlAttributeDefinition (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.sql.ddl, class: SqlAttributeDefinition"> |
| <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>Constr | </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>Constr | </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.sql.ddl</a></div> |
| <h1 title="Class SqlAttributeDefinition" class="title">Class SqlAttributeDefinition</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="../SqlNode.html" title="class in org.apache.calcite.sql">org.apache.calcite.sql.SqlNode</a> |
| <div class="inheritance"><a href="../SqlCall.html" title="class in org.apache.calcite.sql">org.apache.calcite.sql.SqlCall</a> |
| <div class="inheritance">org.apache.calcite.sql.ddl.SqlAttributeDefinition</div> |
| </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/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SqlAttributeDefinition</span> |
| <span class="extends-implements">extends <a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></span></div> |
| <div class="block">Parse tree for SqlAttributeDefinition, |
| which is part of a <a href="SqlCreateType.html" title="class in org.apache.calcite.sql.ddl"><code>SqlCreateType</code></a>.</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>final <a href="../SqlDataTypeSpec.html" title="class in org.apache.calcite.sql">SqlDataTypeSpec</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#dataType" class="member-name-link">dataType</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final <a href="../SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#name" class="member-name-link">name</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.sql.SqlNode">Fields inherited from class org.apache.calcite.sql.<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></h3> |
| <code><a href="../SqlNode.html#EMPTY_ARRAY">EMPTY_ARRAY</a>, <a href="../SqlNode.html#pos">pos</a></code></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="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOperandList()" class="member-name-link">getOperandList</a>()</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 operands.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOperator()" class="member-name-link">getOperator</a>()</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unparse(org.apache.calcite.sql.SqlWriter,int,int)" class="member-name-link">unparse</a><wbr>(<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes a SQL representation of this node to a writer.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.sql.SqlCall">Methods inherited from class org.apache.calcite.sql.<a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></h3> |
| <code><a href="../SqlCall.html#accept(org.apache.calcite.sql.util.SqlVisitor)">accept</a>, <a href="../SqlCall.html#clone(org.apache.calcite.sql.parser.SqlParserPos)">clone</a>, <a href="../SqlCall.html#equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)">equalsDeep</a>, <a href="../SqlCall.html#findValidOptions(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.parser.SqlParserPos,java.util.Collection)">findValidOptions</a>, <a href="../SqlCall.html#getCallSignature(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)">getCallSignature</a>, <a href="../SqlCall.html#getFunctionQuantifier()">getFunctionQuantifier</a>, <a href="../SqlCall.html#getKind()">getKind</a>, <a href="../SqlCall.html#getMonotonicity(org.apache.calcite.sql.validate.SqlValidatorScope)">getMonotonicity</a>, <a href="../SqlCall.html#isCountStar()">isCountStar</a>, <a href="../SqlCall.html#isExpanded()">isExpanded</a>, <a href="../SqlCall.html#operand(int)">operand</a>, <a href="../SqlCall.html#operandCount()">operandCount</a>, <a href="../SqlCall.html#setOperand(int,org.apache.calcite.sql.SqlNode)">setOperand</a>, <a href="../SqlCall.html#validate(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)">validate</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.sql.SqlNode">Methods inherited from class org.apache.calcite.sql.<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></h3> |
| <code><a href="../SqlNode.html#clone()">clone</a>, <a href="../SqlNode.html#clone(E)">clone</a>, <a href="../SqlNode.html#cloneArray(org.apache.calcite.sql.SqlNode%5B%5D)">cloneArray</a>, <a href="../SqlNode.html#equalDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)">equalDeep</a>, <a href="../SqlNode.html#equalDeep(java.util.List,java.util.List,org.apache.calcite.util.Litmus)">equalDeep</a>, <a href="../SqlNode.html#equalsDeep(org.apache.calcite.sql.SqlNode,boolean)">equalsDeep</a>, <a href="../SqlNode.html#getParserPosition()">getParserPosition</a>, <a href="../SqlNode.html#isA(java.util.Set)">isA</a>, <a href="../SqlNode.html#toList()">toList</a>, <a href="../SqlNode.html#toList(org.apache.calcite.sql.parser.SqlParserPos)">toList</a>, <a href="../SqlNode.html#toSqlString(org.apache.calcite.sql.SqlDialect)">toSqlString</a>, <a href="../SqlNode.html#toSqlString(org.apache.calcite.sql.SqlDialect,boolean)">toSqlString</a>, <a href="../SqlNode.html#toSqlString(java.util.function.UnaryOperator)">toSqlString</a>, <a href="../SqlNode.html#toString()">toString</a>, <a href="../SqlNode.html#unparseWithParentheses(org.apache.calcite.sql.SqlWriter,int,int,boolean)">unparseWithParentheses</a>, <a href="../SqlNode.html#validateExpr(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)">validateExpr</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#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#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="name"> |
| <h3>name</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></span> <span class="element-name">name</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dataType"> |
| <h3>dataType</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../SqlDataTypeSpec.html" title="class in org.apache.calcite.sql">SqlDataTypeSpec</a></span> <span class="element-name">dataType</span></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="getOperator()"> |
| <h3>getOperator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></span> <span class="element-name">getOperator</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlCall.html#getOperator()">getOperator</a></code> in class <code><a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOperandList()"> |
| <h3>getOperandList</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="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></span> <span class="element-name">getOperandList</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../SqlCall.html#getOperandList()">SqlCall</a></code></span></div> |
| <div class="block">Returns the list of operands. The set and order of operands is call-specific. |
| <p>Note: the proper type would be <code>List<@Nullable SqlNode></code>, however, |
| it would trigger too many changes to the current codebase.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlCall.html#getOperandList()">getOperandList</a></code> in class <code><a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the list of call operands, never null, the operands can be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unparse(org.apache.calcite.sql.SqlWriter,int,int)"> |
| <h3>unparse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">unparse</span><wbr><span class="parameters">(<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../SqlNode.html#unparse(org.apache.calcite.sql.SqlWriter,int,int)">SqlNode</a></code></span></div> |
| <div class="block">Writes a SQL representation of this node to a writer. |
| |
| <p>The <code>leftPrec</code> and <code>rightPrec</code> parameters give |
| us enough context to decide whether we need to enclose the expression in |
| parentheses. For example, we need parentheses around "2 + 3" if preceded |
| by "5 *". This is because the precedence of the "*" operator is greater |
| than the precedence of the "+" operator. |
| |
| <p>The algorithm handles left- and right-associative operators by giving |
| them slightly different left- and right-precedence. |
| |
| <p>If <a href="../SqlWriter.html#isAlwaysUseParentheses()"><code>SqlWriter.isAlwaysUseParentheses()</code></a> is true, we use |
| parentheses even when they are not required by the precedence rules. |
| |
| <p>For the details of this algorithm, see <a href="../SqlCall.html#unparse(org.apache.calcite.sql.SqlWriter,int,int)"><code>SqlCall.unparse(org.apache.calcite.sql.SqlWriter, int, int)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../SqlCall.html#unparse(org.apache.calcite.sql.SqlWriter,int,int)">unparse</a></code> in class <code><a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>writer</code> - Target writer</dd> |
| <dd><code>leftPrec</code> - The precedence of the <a href="../SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> immediately |
| preceding this node in a depth-first scan of the parse |
| tree</dd> |
| <dd><code>rightPrec</code> - The precedence of the <a href="../SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> immediately</dd> |
| </dl> |
| </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> |
