Google Git
Sign in
apache / calcite-site / 29a0e912ed81c187e4f1968dbc30b739ec991f13 / . / apidocs / org / apache / calcite / sql / SqlWriter.html
blob: 97d547e539ccdb31f47ad32601e19bccd097ca2f [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SqlWriter (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SqlWriter (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SqlWriter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.sql</a></div>
<h2 title="Interface SqlWriter" class="title">Interface SqlWriter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="pretty/SqlPrettyWriter.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">SqlWriter</span></pre>
<div class="block">A <code>SqlWriter</code> is the target to construct a SQL statement from a
parse tree. It deals with dialect differences; for example, Oracle quotes
identifiers as <code>"scott"</code>, while SQL Server quotes them as <code>
[scott]</code>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span></code></th>
<td class="colLast">
<div class="block">A Frame is a piece of generated text which shares a common indentation
level.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></span></code></th>
<td class="colLast">
<div class="block">Frame type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span></code></th>
<td class="colLast">
<div class="block">Enumerates the types of frame.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SqlWriter.SubQueryStyle.html" title="enum in org.apache.calcite.sql">SqlWriter.SubQueryStyle</a></span></code></th>
<td class="colLast">
<div class="block">Style of formatting sub-queries.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dynamicParam(int)">dynamicParam</a></span>&#8203;(int&nbsp;index)</code></th>
<td class="colLast">
<div class="block">Prints a dynamic parameter (e.g.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)">endFunCall</a></span>&#8203;(<a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a>&nbsp;frame)</code></th>
<td class="colLast">
<div class="block">Ends a list which is a call to a function.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#endList(org.apache.calcite.sql.SqlWriter.Frame)">endList</a></span>&#8203;(<a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a>&nbsp;frame)</code></th>
<td class="colLast">
<div class="block">Ends a list.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">fetchOffset</a></span>&#8203;(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;fetch,
<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;offset)</code></th>
<td class="colLast">
<div class="block">Prints the OFFSET/FETCH clause.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDialect()">getDialect</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the dialect of SQL.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndentation()">getIndentation</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the offset for each level of indentation.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#identifier(java.lang.String,boolean)">identifier</a></span>&#8203;(java.lang.String&nbsp;name,
boolean&nbsp;quoted)</code></th>
<td class="colLast">
<div class="block">Prints an identifier, quoting as necessary.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#inQuery()">inQuery</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether we are currently in a query context (SELECT, INSERT,
UNION, INTERSECT, EXCEPT, and the ORDER BY operator).</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAlwaysUseParentheses()">isAlwaysUseParentheses</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether to enclose all expressions in parentheses, even if the
operator has high enough precedence that the parentheses are not
required.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isClauseStartsLine()">isClauseStartsLine</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this writer should start each clause (e.g.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isKeywordsLowerCase()">isKeywordsLowerCase</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether to output all keywords (e.g.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isQuoteAllIdentifiers()">isQuoteAllIdentifiers</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this writer should quote all identifiers, even those
that do not contain mixed-case identifiers or punctuation.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSelectListItemsOnSeparateLines()">isSelectListItemsOnSeparateLines</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the items in the SELECT clause should each be on a
separate line.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyword(java.lang.String)">keyword</a></span>&#8203;(java.lang.String&nbsp;s)</code></th>
<td class="colLast">
<div class="block">Prints a sequence of keywords.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#literal(java.lang.String)">literal</a></span>&#8203;(java.lang.String&nbsp;s)</code></th>
<td class="colLast">
<div class="block">Prints a literal, exactly as provided.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newlineAndIndent()">newlineAndIndent</a></span>()</code></th>
<td class="colLast">
<div class="block">Prints a new line, and indents.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#print(int)">print</a></span>&#8203;(int&nbsp;x)</code></th>
<td class="colLast">
<div class="block">Prints an integer.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#print(java.lang.String)">print</a></span>&#8203;(java.lang.String&nbsp;s)</code></th>
<td class="colLast">
<div class="block">Prints a string, preceded by whitespace if necessary.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets this writer so that it can format another expression.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetSettings()">resetSettings</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets all properties to their default values.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sep(java.lang.String)">sep</a></span>&#8203;(java.lang.String&nbsp;sep)</code></th>
<td class="colLast">
<div class="block">Writes a list separator, unless the separator is "," and this is the
first occurrence in the list.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sep(java.lang.String,boolean)">sep</a></span>&#8203;(java.lang.String&nbsp;sep,
boolean&nbsp;printFirst)</code></th>
<td class="colLast">
<div class="block">Writes a list separator.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNeedWhitespace(boolean)">setNeedWhitespace</a></span>&#8203;(boolean&nbsp;needWhitespace)</code></th>
<td class="colLast">
<div class="block">Sets whether whitespace is needed before the next token.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startFunCall(java.lang.String)">startFunCall</a></span>&#8203;(java.lang.String&nbsp;funName)</code></th>
<td class="colLast">
<div class="block">Starts a list which is a call to a function.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startList(java.lang.String,java.lang.String)">startList</a></span>&#8203;(java.lang.String&nbsp;open,
java.lang.String&nbsp;close)</code></th>
<td class="colLast">
<div class="block">Starts a list.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)">startList</a></span>&#8203;(<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>&nbsp;frameType)</code></th>
<td class="colLast">
<div class="block">Starts a list with no opening string.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)">startList</a></span>&#8203;(<a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a>&nbsp;frameType,
java.lang.String&nbsp;open,
java.lang.String&nbsp;close)</code></th>
<td class="colLast">
<div class="block">Starts a list.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSqlString()">toSqlString</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the contents of this writer as a 'certified kocher' SQL string.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">void&nbsp;reset()</pre>
<div class="block">Resets this writer so that it can format another expression. Does not
affect formatting preferences (see <a href="#resetSettings()"><code>resetSettings()</code></a></div>
</li>
</ul>
<a id="resetSettings()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetSettings</h4>
<pre class="methodSignature">void&nbsp;resetSettings()</pre>
<div class="block">Resets all properties to their default values.</div>
</li>
</ul>
<a id="getDialect()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDialect</h4>
<pre class="methodSignature"><a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a>&nbsp;getDialect()</pre>
<div class="block">Returns the dialect of SQL.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SQL dialect</dd>
</dl>
</li>
</ul>
<a id="toSqlString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toSqlString</h4>
<pre class="methodSignature"><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a>&nbsp;toSqlString()</pre>
<div class="block">Returns the contents of this writer as a 'certified kocher' SQL string.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SQL string</dd>
</dl>
</li>
</ul>
<a id="literal(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>literal</h4>
<pre class="methodSignature">void&nbsp;literal&#8203;(java.lang.String&nbsp;s)</pre>
<div class="block">Prints a literal, exactly as provided. Does not attempt to indent or
convert to upper or lower case. Does not add quotation marks. Adds
preceding whitespace if necessary.</div>
</li>
</ul>
<a id="keyword(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyword</h4>
<pre class="methodSignature">void&nbsp;keyword&#8203;(java.lang.String&nbsp;s)</pre>
<div class="block">Prints a sequence of keywords. Must not start or end with space, but may
contain a space. For example, <code>keyword("SELECT")</code>, <code>
keyword("CHARACTER SET")</code>.</div>
</li>
</ul>
<a id="print(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre class="methodSignature">void&nbsp;print&#8203;(java.lang.String&nbsp;s)</pre>
<div class="block">Prints a string, preceded by whitespace if necessary.</div>
</li>
</ul>
<a id="print(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre class="methodSignature">void&nbsp;print&#8203;(int&nbsp;x)</pre>
<div class="block">Prints an integer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>x</code> - Integer</dd>
</dl>
</li>
</ul>
<a id="identifier(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>identifier</h4>
<pre class="methodSignature">void&nbsp;identifier&#8203;(java.lang.String&nbsp;name,
boolean&nbsp;quoted)</pre>
<div class="block">Prints an identifier, quoting as necessary.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The identifier name</dd>
<dd><code>quoted</code> - Whether this identifier was quoted in the original sql statement,
this may not be the only factor to decide whether this identifier
should be quoted</dd>
</dl>
</li>
</ul>
<a id="dynamicParam(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dynamicParam</h4>
<pre class="methodSignature">void&nbsp;dynamicParam&#8203;(int&nbsp;index)</pre>
<div class="block">Prints a dynamic parameter (e.g. <code>?</code> for default JDBC)</div>
</li>
</ul>
<a id="fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchOffset</h4>
<pre class="methodSignature">void&nbsp;fetchOffset&#8203;(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;fetch,
<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;offset)</pre>
<div class="block">Prints the OFFSET/FETCH clause.</div>
</li>
</ul>
<a id="newlineAndIndent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newlineAndIndent</h4>
<pre class="methodSignature">void&nbsp;newlineAndIndent()</pre>
<div class="block">Prints a new line, and indents.</div>
</li>
</ul>
<a id="isQuoteAllIdentifiers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isQuoteAllIdentifiers</h4>
<pre class="methodSignature">boolean&nbsp;isQuoteAllIdentifiers()</pre>
<div class="block">Returns whether this writer should quote all identifiers, even those
that do not contain mixed-case identifiers or punctuation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether to quote all identifiers</dd>
</dl>
</li>
</ul>
<a id="isClauseStartsLine()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClauseStartsLine</h4>
<pre class="methodSignature">boolean&nbsp;isClauseStartsLine()</pre>
<div class="block">Returns whether this writer should start each clause (e.g. GROUP BY) on
a new line.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether to start each clause on a new line</dd>
</dl>
</li>
</ul>
<a id="isSelectListItemsOnSeparateLines()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSelectListItemsOnSeparateLines</h4>
<pre class="methodSignature">boolean&nbsp;isSelectListItemsOnSeparateLines()</pre>
<div class="block">Returns whether the items in the SELECT clause should each be on a
separate line.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether to put each SELECT clause item on a new line</dd>
</dl>
</li>
</ul>
<a id="isKeywordsLowerCase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isKeywordsLowerCase</h4>
<pre class="methodSignature">boolean&nbsp;isKeywordsLowerCase()</pre>
<div class="block">Returns whether to output all keywords (e.g. SELECT, GROUP BY) in lower
case.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether to output SQL keywords in lower case</dd>
</dl>
</li>
</ul>
<a id="startFunCall(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startFunCall</h4>
<pre class="methodSignature"><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a>&nbsp;startFunCall&#8203;(java.lang.String&nbsp;funName)</pre>
<div class="block">Starts a list which is a call to a function.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)"><code>endFunCall(Frame)</code></a></dd>
</dl>
</li>
</ul>
<a id="endFunCall(org.apache.calcite.sql.SqlWriter.Frame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endFunCall</h4>
<pre class="methodSignature">void&nbsp;endFunCall&#8203;(<a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a>&nbsp;frame)</pre>
<div class="block">Ends a list which is a call to a function.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frame</code> - Frame</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#startFunCall(java.lang.String)"><code>startFunCall(String)</code></a></dd>
</dl>
</li>
</ul>
<a id="startList(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startList</h4>
<pre class="methodSignature"><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a>&nbsp;startList&#8203;(java.lang.String&nbsp;open,
java.lang.String&nbsp;close)</pre>
<div class="block">Starts a list.</div>
</li>
</ul>
<a id="startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startList</h4>
<pre class="methodSignature"><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a>&nbsp;startList&#8203;(<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>&nbsp;frameType)</pre>
<div class="block">Starts a list with no opening string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frameType</code> - Type of list. For example, a SELECT list will be</dd>
</dl>
</li>
</ul>
<a id="startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startList</h4>
<pre class="methodSignature"><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a>&nbsp;startList&#8203;(<a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a>&nbsp;frameType,
java.lang.String&nbsp;open,
java.lang.String&nbsp;close)</pre>
<div class="block">Starts a list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frameType</code> - Type of list. For example, a SELECT list will be
governed according to SELECT-list formatting preferences.</dd>
<dd><code>open</code> - String to start the list; typically "(" or the empty
string.</dd>
<dd><code>close</code> - String to close the list</dd>
</dl>
</li>
</ul>
<a id="endList(org.apache.calcite.sql.SqlWriter.Frame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endList</h4>
<pre class="methodSignature">void&nbsp;endList&#8203;(<a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a>&nbsp;frame)</pre>
<div class="block">Ends a list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frame</code> - The frame which was created by <a href="#startList(java.lang.String,java.lang.String)"><code>startList(java.lang.String, java.lang.String)</code></a>.</dd>
</dl>
</li>
</ul>
<a id="sep(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sep</h4>
<pre class="methodSignature">void&nbsp;sep&#8203;(java.lang.String&nbsp;sep)</pre>
<div class="block">Writes a list separator, unless the separator is "," and this is the
first occurrence in the list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sep</code> - List separator, typically ",".</dd>
</dl>
</li>
</ul>
<a id="sep(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sep</h4>
<pre class="methodSignature">void&nbsp;sep&#8203;(java.lang.String&nbsp;sep,
boolean&nbsp;printFirst)</pre>
<div class="block">Writes a list separator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sep</code> - List separator, typically ","</dd>
<dd><code>printFirst</code> - Whether to print the first occurrence of the separator</dd>
</dl>
</li>
</ul>
<a id="setNeedWhitespace(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNeedWhitespace</h4>
<pre class="methodSignature">void&nbsp;setNeedWhitespace&#8203;(boolean&nbsp;needWhitespace)</pre>
<div class="block">Sets whether whitespace is needed before the next token.</div>
</li>
</ul>
<a id="getIndentation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndentation</h4>
<pre class="methodSignature">int&nbsp;getIndentation()</pre>
<div class="block">Returns the offset for each level of indentation. Default 4.</div>
</li>
</ul>
<a id="isAlwaysUseParentheses()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAlwaysUseParentheses</h4>
<pre class="methodSignature">boolean&nbsp;isAlwaysUseParentheses()</pre>
<div class="block">Returns whether to enclose all expressions in parentheses, even if the
operator has high enough precedence that the parentheses are not
required.
<p>For example, the parentheses are required in the expression <code>(a +
b) * c</code> because the '*' operator has higher precedence than the '+'
operator, and so without the parentheses, the expression would be
equivalent to <code>a + (b * c)</code>. The fully-parenthesized
expression, <code>((a + b) * c)</code> is unambiguous even if you don't
know the precedence of every operator.</div>
</li>
</ul>
<a id="inQuery()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>inQuery</h4>
<pre class="methodSignature">boolean&nbsp;inQuery()</pre>
<div class="block">Returns whether we are currently in a query context (SELECT, INSERT,
UNION, INTERSECT, EXCEPT, and the ORDER BY operator).</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SqlWriter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>