| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SqlBuilder (Apache Calcite calcite API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SqlBuilder (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/sql/util/SqlBasicVisitor.ArgHandlerImpl.html" title="class in org.apache.calcite.sql.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/sql/util/SqlShuttle.html" title="class in org.apache.calcite.sql.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/sql/util/SqlBuilder.html" target="_top">Frames</a></li> |
| <li><a href="SqlBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.sql.util</div> |
| <h2 title="Class SqlBuilder" class="title">Class SqlBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.sql.util.SqlBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SqlBuilder</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Extension to <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang"><code>StringBuilder</code></a> for the purposes of creating SQL queries |
| and expressions. |
| |
| <p>Using this class helps to prevent SQL injection attacks, incorrectly |
| quoted identifiers and strings. These problems occur when you build SQL by |
| concatenating strings, and you forget to treat identifers and string literals |
| correctly. SqlBuilder has special methods for appending identifiers and |
| literals.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#SqlBuilder-org.apache.calcite.sql.SqlDialect-">SqlBuilder</a></span>(<a href="../../../../../org/apache/calcite/sql/SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</code> |
| <div class="block">Creates a SqlBuilder.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#SqlBuilder-org.apache.calcite.sql.SqlDialect-java.lang.String-">SqlBuilder</a></span>(<a href="../../../../../org/apache/calcite/sql/SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</code> |
| <div class="block">Creates a SqlBuilder with a given string.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#append-char-">append</a></span>(char c)</code> |
| <div class="block">Appends a character, without any quoting.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#append-long-">append</a></span>(long n)</code> |
| <div class="block">Appends a number, per <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true#append-long-" title="class or interface in java.lang"><code>StringBuilder.append(long)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#append-org.apache.calcite.sql.util.SqlString-">append</a></span>(<a href="../../../../../org/apache/calcite/sql/util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a> s)</code> |
| <div class="block">Appends a hygienic SQL string.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#append-java.lang.String-">append</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</code> |
| <div class="block">Appends a string, without any quoting.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#clear--">clear</a></span>()</code> |
| <div class="block">Clears the contents of the buffer.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#getDialect--">getDialect</a></span>()</code> |
| <div class="block">Returns the dialect.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#getSql--">getSql</a></span>()</code> |
| <div class="block">Returns the SQL.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#getSqlAndClear--">getSqlAndClear</a></span>()</code> |
| <div class="block">Returns the SQL and clears the buffer.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#identifier-java.util.List-">identifier</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> names)</code> |
| <div class="block">Appends a compound identifier to this buffer, quoting accordingly.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#identifier-java.lang.String...-">identifier</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... names)</code> |
| <div class="block">Appends one or more identifiers to this buffer, quoting accordingly.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#identifier-java.lang.String-">identifier</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Appends an identifier to this buffer, quoting accordingly.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#indexOf-java.lang.String-">indexOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</code> |
| <div class="block">Returns the index within this string of the first occurrence of the |
| specified substring.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#indexOf-java.lang.String-int-">indexOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| int fromIndex)</code> |
| <div class="block">Returns the index within this string of the first occurrence of the |
| specified substring, starting at the specified index.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#insert-int-java.lang.String-">insert</a></span>(int offset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</code> |
| <div class="block">Inserts the string into this character sequence.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#length--">length</a></span>()</code> |
| <div class="block">Returns the length (character count).</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#literal-java.lang.String-">literal</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</code> |
| <div class="block">Appends a string literal to this buffer.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#literal-java.sql.Timestamp-">literal</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html?is-external=true" title="class or interface in java.sql">Timestamp</a> timestamp)</code> |
| <div class="block">Appends a timestamp literal to this buffer.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#toSqlString--">toSqlString</a></span>()</code> |
| <div class="block">Returns the contents of this SQL buffer as a 'certified kocher' SQL |
| string.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#toString--">toString</a></span>()</code></td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SqlBuilder-org.apache.calcite.sql.SqlDialect-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SqlBuilder</h4> |
| <pre>public SqlBuilder(<a href="../../../../../org/apache/calcite/sql/SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</pre> |
| <div class="block">Creates a SqlBuilder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dialect</code> - Dialect</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SqlBuilder-org.apache.calcite.sql.SqlDialect-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SqlBuilder</h4> |
| <pre>public SqlBuilder(<a href="../../../../../org/apache/calcite/sql/SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</pre> |
| <div class="block">Creates a SqlBuilder with a given string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dialect</code> - Dialect</dd> |
| <dd><code>s</code> - Initial contents of the buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getDialect--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDialect</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> getDialect()</pre> |
| <div class="block">Returns the dialect.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>dialect</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="length--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>length</h4> |
| <pre>public int length()</pre> |
| <div class="block">Returns the length (character count).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the length of the sequence of characters currently |
| represented by this object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void clear()</pre> |
| <div class="block">Clears the contents of the buffer.</div> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <div class="block"> |
| |
| <p>Returns the SQL string.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SQL string</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#getSql--"><code>getSql()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSql--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSql</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSql()</pre> |
| <div class="block">Returns the SQL.</div> |
| </li> |
| </ul> |
| <a name="getSqlAndClear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlAndClear</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSqlAndClear()</pre> |
| <div class="block">Returns the SQL and clears the buffer. |
| |
| <p>Convenient if you are reusing the same SQL builder in a loop.</div> |
| </li> |
| </ul> |
| <a name="append-org.apache.calcite.sql.util.SqlString-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> append(<a href="../../../../../org/apache/calcite/sql/util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a> s)</pre> |
| <div class="block">Appends a hygienic SQL string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>s</code> - SQL string to append</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="append-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> append(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</pre> |
| <div class="block">Appends a string, without any quoting. |
| |
| <p>Calls to this method are dubious.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>s</code> - String to append</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="append-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> append(char c)</pre> |
| <div class="block">Appends a character, without any quoting.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>c</code> - Character to append</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="append-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>append</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> append(long n)</pre> |
| <div class="block">Appends a number, per <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true#append-long-" title="class or interface in java.lang"><code>StringBuilder.append(long)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="identifier-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>identifier</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> identifier(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Appends an identifier to this buffer, quoting accordingly.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="identifier-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>identifier</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> identifier(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... names)</pre> |
| <div class="block">Appends one or more identifiers to this buffer, quoting accordingly.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - Varargs array of identifiers</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="identifier-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>identifier</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> identifier(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> names)</pre> |
| <div class="block">Appends a compound identifier to this buffer, quoting accordingly.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - Parts of a compound identifier</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toSqlString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toSqlString</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a> toSqlString()</pre> |
| <div class="block">Returns the contents of this SQL buffer as a 'certified kocher' SQL |
| string. |
| |
| <p>Use this method in preference to <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html#toString--"><code>toString()</code></a>. It indicates |
| that the SQL string has been constructed using good hygiene, and is |
| therefore less likely to contain SQL injection or badly quoted |
| identifiers or strings.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Contents of this builder as a SQL string.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="literal-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>literal</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> literal(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</pre> |
| <div class="block">Appends a string literal to this buffer. |
| |
| <p>For example, calling <code>literal("can't")</code> |
| would convert the buffer |
| <blockquote><code>SELECT </code></blockquote> |
| to |
| <blockquote><code>SELECT 'can''t'</code></blockquote></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>s</code> - String to append</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="literal-java.sql.Timestamp-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>literal</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> literal(<a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html?is-external=true" title="class or interface in java.sql">Timestamp</a> timestamp)</pre> |
| <div class="block">Appends a timestamp literal to this buffer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timestamp</code> - Timestamp to append</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This buffer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="indexOf-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>indexOf</h4> |
| <pre>public int indexOf(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</pre> |
| <div class="block">Returns the index within this string of the first occurrence of the |
| specified substring.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true#indexOf-java.lang.String-" title="class or interface in java.lang"><code>StringBuilder.indexOf(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="indexOf-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>indexOf</h4> |
| <pre>public int indexOf(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str, |
| int fromIndex)</pre> |
| <div class="block">Returns the index within this string of the first occurrence of the |
| specified substring, starting at the specified index.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true#indexOf-java.lang.String-int-" title="class or interface in java.lang"><code>StringBuilder.indexOf(String, int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="insert-int-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>insert</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/util/SqlBuilder.html" title="class in org.apache.calcite.sql.util">SqlBuilder</a> insert(int offset, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> str)</pre> |
| <div class="block">Inserts the string into this character sequence.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true#insert-int-java.lang.String-" title="class or interface in java.lang"><code>StringBuilder.insert(int, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/sql/util/SqlBasicVisitor.ArgHandlerImpl.html" title="class in org.apache.calcite.sql.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/sql/util/SqlShuttle.html" title="class in org.apache.calcite.sql.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/sql/util/SqlBuilder.html" target="_top">Frames</a></li> |
| <li><a href="SqlBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |
