| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>DataContext.Variable (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite, interface: DataContext, enum: Variable"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </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="sub-nav-list"> |
| <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> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite</a></div> |
| <h1 title="Enum DataContext.Variable" class="title">Enum DataContext.Variable</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>> |
| <div class="inheritance">org.apache.calcite.DataContext.Variable</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="DataContext.html" title="interface in org.apache.calcite">DataContext</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">DataContext.Variable</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>></span></div> |
| <div class="block">Variable that may be asked for in a call to <a href="DataContext.html#get(java.lang.String)"><code>DataContext.get(java.lang.String)</code></a>.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> |
| </section> |
| </li> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <li> |
| <section class="constants-summary" id="enum-constant-summary"> |
| <h2>Enum Constant Summary</h2> |
| <div class="caption"><span>Enum Constants</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Enum Constant</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="#CANCEL_FLAG" class="member-name-link">CANCEL_FLAG</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A mutable flag that indicates whether user has requested that the |
| current statement be canceled.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#CURRENT_TIMESTAMP" class="member-name-link">CURRENT_TIMESTAMP</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The time at which the current statement started executing.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#LOCAL_TIMESTAMP" class="member-name-link">LOCAL_TIMESTAMP</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The time at which the current statement started executing.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#LOCALE" class="member-name-link">LOCALE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Locale in which the current statement is executing.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#SPARK_CONTEXT" class="member-name-link">SPARK_CONTEXT</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The Spark engine.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#SQL_ADVISOR" class="member-name-link">SQL_ADVISOR</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Advisor that suggests completion hints for SQL statements.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#STDERR" class="member-name-link">STDERR</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Writer to the standard error (stderr).</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#STDIN" class="member-name-link">STDIN</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Reader on the standard input (stdin).</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#STDOUT" class="member-name-link">STDOUT</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Writer to the standard output (stdout).</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#SYSTEM_USER" class="member-name-link">SYSTEM_USER</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The system user.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#TIME_FRAME_SET" class="member-name-link">TIME_FRAME_SET</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Set of built-in and custom time frames for use in functions such as |
| <code>FLOOR</code> and <code>EXTRACT</code>.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#TIME_ZONE" class="member-name-link">TIME_ZONE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Time zone in which the current statement is executing.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#TIMEOUT" class="member-name-link">TIMEOUT</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Query timeout in milliseconds.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#USER" class="member-name-link">USER</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The query user.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#UTC_TIMESTAMP" class="member-name-link">UTC_TIMESTAMP</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#camelName" class="member-name-link">camelName</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#clazz" class="member-name-link">clazz</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(org.apache.calcite.DataContext)" class="member-name-link">get</a><wbr>(<a href="DataContext.html" title="interface in org.apache.calcite">DataContext</a> dataContext)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the value of this variable in a given data context.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <li> |
| <section class="constant-details" id="enum-constant-detail"> |
| <h2>Enum Constant Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="UTC_TIMESTAMP"> |
| <h3>UTC_TIMESTAMP</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">UTC_TIMESTAMP</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CURRENT_TIMESTAMP"> |
| <h3>CURRENT_TIMESTAMP</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">CURRENT_TIMESTAMP</span></div> |
| <div class="block">The time at which the current statement started executing. In |
| milliseconds after 1970-01-01 00:00:00, UTC. Required.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOCAL_TIMESTAMP"> |
| <h3>LOCAL_TIMESTAMP</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">LOCAL_TIMESTAMP</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SPARK_CONTEXT"> |
| <h3>SPARK_CONTEXT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">SPARK_CONTEXT</span></div> |
| <div class="block">The Spark engine. Available if Spark is on the class path.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CANCEL_FLAG"> |
| <h3>CANCEL_FLAG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">CANCEL_FLAG</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TIMEOUT"> |
| <h3>TIMEOUT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">TIMEOUT</span></div> |
| <div class="block">Query timeout in milliseconds. |
| When no timeout is set, the value is 0 or not present.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SQL_ADVISOR"> |
| <h3>SQL_ADVISOR</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">SQL_ADVISOR</span></div> |
| <div class="block">Advisor that suggests completion hints for SQL statements.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="STDERR"> |
| <h3>STDERR</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">STDERR</span></div> |
| <div class="block">Writer to the standard error (stderr).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="STDIN"> |
| <h3>STDIN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">STDIN</span></div> |
| <div class="block">Reader on the standard input (stdin).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="STDOUT"> |
| <h3>STDOUT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">STDOUT</span></div> |
| <div class="block">Writer to the standard output (stdout).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOCALE"> |
| <h3>LOCALE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">LOCALE</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TIME_ZONE"> |
| <h3>TIME_ZONE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">TIME_ZONE</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TIME_FRAME_SET"> |
| <h3>TIME_FRAME_SET</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">TIME_FRAME_SET</span></div> |
| <div class="block">Set of built-in and custom time frames for use in functions such as |
| <code>FLOOR</code> and <code>EXTRACT</code>. Required; defaults to |
| <a href="rel/type/TimeFrames.html#CORE"><code>TimeFrames.CORE</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="USER"> |
| <h3>USER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">USER</span></div> |
| <div class="block">The query user. |
| |
| <p>Default value is "sa".</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SYSTEM_USER"> |
| <h3>SYSTEM_USER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">SYSTEM_USER</span></div> |
| <div class="block">The system user. |
| |
| <p>Default value is "user.name" from |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/System.html#getProperty(java.lang.String)" title="class or interface in java.lang" class="external-link"><code>System.getProperty(String)</code></a>.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="camelName"> |
| <h3>camelName</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">camelName</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clazz"> |
| <h3>clazz</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a></span> <span class="element-name">clazz</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="values()"> |
| <h3>values</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a>[]</span> <span class="element-name">values</span>()</div> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueOf(java.lang.String)"> |
| <h3>valueOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DataContext.Variable.html" title="enum in org.apache.calcite">DataContext.Variable</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(org.apache.calcite.DataContext)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">get</span><wbr><span class="parameters">(<a href="DataContext.html" title="interface in org.apache.calcite">DataContext</a> dataContext)</span></div> |
| <div class="block">Returns the value of this variable in a given data context.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
