| <!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>DataContext.Variable (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="DataContext.Variable (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":9,"i2":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/DataContext.html" title="interface in org.apache.calcite"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/calcite/Demo.html" title="class in org.apache.calcite"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/calcite/DataContext.Variable.html" target="_top">Frames</a></li> |
| <li><a href="DataContext.Variable.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><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li><a href="#field.detail">Field</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</div> |
| <h2 title="Enum DataContext.Variable" class="title">Enum DataContext.Variable</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.DataContext.Variable</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../org/apache/calcite/DataContext.html" title="interface in org.apache.calcite">DataContext</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static enum <span class="typeNameLabel">DataContext.Variable</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>></pre> |
| <div class="block">Variable that may be asked for in a call to <a href="../../../org/apache/calcite/DataContext.html#get-java.lang.String-"><code>DataContext.get(java.lang.String)</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Enum Constant and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#CANCEL_FLAG">CANCEL_FLAG</a></span></code> |
| <div class="block">A mutable flag that indicates whether user has requested that the |
| current statement be canceled.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#CURRENT_TIMESTAMP">CURRENT_TIMESTAMP</a></span></code> |
| <div class="block">The time at which the current statement started executing.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#LOCAL_TIMESTAMP">LOCAL_TIMESTAMP</a></span></code> |
| <div class="block">The time at which the current statement started executing.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#LOCALE">LOCALE</a></span></code> |
| <div class="block">Locale in which the current statement is executing.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#SPARK_CONTEXT">SPARK_CONTEXT</a></span></code> |
| <div class="block">The Spark engine.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#SQL_ADVISOR">SQL_ADVISOR</a></span></code> |
| <div class="block">Advisor that suggests completion hints for SQL statements.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#STDERR">STDERR</a></span></code> |
| <div class="block">Writer to the standard error (stderr).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#STDIN">STDIN</a></span></code> |
| <div class="block">Reader on the standard input (stdin).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#STDOUT">STDOUT</a></span></code> |
| <div class="block">Writer to the standard output (stdout).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#SYSTEM_USER">SYSTEM_USER</a></span></code> |
| <div class="block">The system user.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#TIME_ZONE">TIME_ZONE</a></span></code> |
| <div class="block">Time zone in which the current statement is executing.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#TIMEOUT">TIMEOUT</a></span></code> |
| <div class="block">Query timeout in milliseconds.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#USER">USER</a></span></code> |
| <div class="block">The query user.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#UTC_TIMESTAMP">UTC_TIMESTAMP</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr 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/DataContext.Variable.html#camelName">camelName</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#clazz">clazz</a></span></code> </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#get-org.apache.calcite.DataContext-">get</a></span>(<a href="../../../org/apache/calcite/DataContext.html" title="interface in org.apache.calcite">DataContext</a> dataContext)</code> |
| <div class="block">Returns the value of this variable in a given data context.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#valueOf-java.lang.String-">valueOf</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">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/calcite/DataContext.Variable.html#values--">values</a></span>()</code> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li> |
| </ul> |
| <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#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#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"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a name="UTC_TIMESTAMP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UTC_TIMESTAMP</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> UTC_TIMESTAMP</pre> |
| </li> |
| </ul> |
| <a name="CURRENT_TIMESTAMP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CURRENT_TIMESTAMP</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> CURRENT_TIMESTAMP</pre> |
| <div class="block">The time at which the current statement started executing. In |
| milliseconds after 1970-01-01 00:00:00, UTC. Required.</div> |
| </li> |
| </ul> |
| <a name="LOCAL_TIMESTAMP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCAL_TIMESTAMP</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> LOCAL_TIMESTAMP</pre> |
| <div class="block">The time at which the current statement started executing. In |
| milliseconds after 1970-01-01 00:00:00, in the time zone of the current |
| statement. Required.</div> |
| </li> |
| </ul> |
| <a name="SPARK_CONTEXT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SPARK_CONTEXT</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> SPARK_CONTEXT</pre> |
| <div class="block">The Spark engine. Available if Spark is on the class path.</div> |
| </li> |
| </ul> |
| <a name="CANCEL_FLAG"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CANCEL_FLAG</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> CANCEL_FLAG</pre> |
| <div class="block">A mutable flag that indicates whether user has requested that the |
| current statement be canceled. Cancellation may not be immediate, but |
| implementations of relational operators should check the flag fairly |
| frequently and cease execution (e.g. by returning end of data).</div> |
| </li> |
| </ul> |
| <a name="TIMEOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TIMEOUT</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> TIMEOUT</pre> |
| <div class="block">Query timeout in milliseconds. |
| When no timeout is set, the value is 0 or not present.</div> |
| </li> |
| </ul> |
| <a name="SQL_ADVISOR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SQL_ADVISOR</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> SQL_ADVISOR</pre> |
| <div class="block">Advisor that suggests completion hints for SQL statements.</div> |
| </li> |
| </ul> |
| <a name="STDERR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STDERR</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> STDERR</pre> |
| <div class="block">Writer to the standard error (stderr).</div> |
| </li> |
| </ul> |
| <a name="STDIN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STDIN</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> STDIN</pre> |
| <div class="block">Reader on the standard input (stdin).</div> |
| </li> |
| </ul> |
| <a name="STDOUT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STDOUT</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> STDOUT</pre> |
| <div class="block">Writer to the standard output (stdout).</div> |
| </li> |
| </ul> |
| <a name="LOCALE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOCALE</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> LOCALE</pre> |
| <div class="block">Locale in which the current statement is executing. |
| Affects the behavior of functions such as <code>DAYNAME</code> and |
| <code>MONTHNAME</code>. Required; defaults to the root locale if the |
| connection does not specify a locale.</div> |
| </li> |
| </ul> |
| <a name="TIME_ZONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TIME_ZONE</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> TIME_ZONE</pre> |
| <div class="block">Time zone in which the current statement is executing. Required; |
| defaults to the time zone of the JVM if the connection does not specify a |
| time zone.</div> |
| </li> |
| </ul> |
| <a name="USER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>USER</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> USER</pre> |
| <div class="block">The query user. |
| |
| <p>Default value is "sa".</div> |
| </li> |
| </ul> |
| <a name="SYSTEM_USER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SYSTEM_USER</h4> |
| <pre>public static final <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> SYSTEM_USER</pre> |
| <div class="block">The system user. |
| |
| <p>Default value is "user.name" from |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#getProperty-java.lang.String-" title="class or interface in java.lang"><code>System.getProperty(String)</code></a>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="camelName"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>camelName</h4> |
| <pre>public final <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> camelName</pre> |
| </li> |
| </ul> |
| <a name="clazz"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>clazz</h4> |
| <pre>public final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a> clazz</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="values--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>public static <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>[] values()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (DataContext.Variable c : DataContext.Variable.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueOf-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre>public static <a href="../../../org/apache/calcite/DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a> valueOf(<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">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-org.apache.calcite.DataContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <T> T get(<a href="../../../org/apache/calcite/DataContext.html" title="interface in org.apache.calcite">DataContext</a> dataContext)</pre> |
| <div class="block">Returns the value of this variable in a given data context.</div> |
| </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/DataContext.html" title="interface in org.apache.calcite"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/calcite/Demo.html" title="class in org.apache.calcite"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/calcite/DataContext.Variable.html" target="_top">Frames</a></li> |
| <li><a href="DataContext.Variable.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><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li><a href="#field.detail">Field</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> |
