| <!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>UserSession (Drill : 1.20.3 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="UserSession (Drill : 1.20.3 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}; |
| 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="class-use/UserSession.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnectionConfig.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.Builder.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/rpc/user/UserSession.html" target="_top">Frames</a></li> |
| <li><a href="UserSession.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.drill.exec.rpc.user</div> |
| <h2 title="Class UserSession" class="title">Class UserSession</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.drill.exec.rpc.user.UserSession</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/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">UserSession</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> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.Builder.html" title="class in org.apache.drill.exec.rpc.user">UserSession.Builder</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.QueryCountIncrementer.html" title="interface in org.apache.drill.exec.rpc.user">UserSession.QueryCountIncrementer</a></span></code> |
| <div class="block">Implementations of this interface are allowed to increment queryCount.</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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#close--">close</a></span>()</code> |
| <div class="block">On session close deletes all session temporary locations recursively and clears temporary locations list.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.UserCredentials.html" title="class in org.apache.drill.exec.proto">UserBitShared.UserCredentials</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#getCredentials--">getCredentials</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.calcite.schema.SchemaPlus</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#getDefaultSchema-org.apache.calcite.schema.SchemaPlus-">getDefaultSchema</a></span>(org.apache.calcite.schema.SchemaPlus rootSchema)</code> |
| <div class="block">Get default schema from current default schema path and given schema tree.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/drill/exec/rpc/user/UserSession.html#getDefaultSchemaPath--">getDefaultSchemaPath</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/server/options/SessionOptionManager.html" title="class in org.apache.drill.exec.server.options">SessionOptionManager</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#getOptions--">getOptions</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" 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/drill/exec/rpc/user/UserSession.html#getOriginalTableNameFromTemporaryTable-java.lang.String-">getOriginalTableNameFromTemporaryTable</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> tableName)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#getQueryCount--">getQueryCount</a></span>()</code> </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/drill/exec/rpc/user/UserSession.html#getSessionId--">getSessionId</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" 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/drill/exec/rpc/user/UserSession.html#getTargetUserName--">getTargetUserName</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#incrementQueryCount-org.apache.drill.exec.rpc.user.UserSession.QueryCountIncrementer-">incrementQueryCount</a></span>(<a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.QueryCountIncrementer.html" title="interface in org.apache.drill.exec.rpc.user">UserSession.QueryCountIncrementer</a> incrementer)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#isSupportComplexTypes--">isSupportComplexTypes</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#isTemporaryTable-org.apache.drill.exec.store.AbstractSchema-org.apache.drill.common.config.DrillConfig-java.lang.String-">isTemporaryTable</a></span>(<a href="../../../../../../org/apache/drill/exec/store/AbstractSchema.html" title="class in org.apache.drill.exec.store">AbstractSchema</a> drillSchema, |
| <a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a> config, |
| <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> tableName)</code> |
| <div class="block">Checks if passed table is temporary, table name is case-insensitive.</div> |
| </td> |
| </tr> |
| <tr id="i12" 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/drill/exec/rpc/user/UserSession.html#registerTemporaryTable-org.apache.drill.exec.store.AbstractSchema-java.lang.String-org.apache.drill.common.config.DrillConfig-">registerTemporaryTable</a></span>(<a href="../../../../../../org/apache/drill/exec/store/AbstractSchema.html" title="class in org.apache.drill.exec.store">AbstractSchema</a> schema, |
| <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> tableName, |
| <a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a> config)</code> |
| <div class="block">Creates and adds session temporary location if absent using schema configuration.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#removeTemporaryTable-org.apache.drill.exec.store.AbstractSchema-java.lang.String-org.apache.drill.common.config.DrillConfig-">removeTemporaryTable</a></span>(<a href="../../../../../../org/apache/drill/exec/store/AbstractSchema.html" title="class in org.apache.drill.exec.store">AbstractSchema</a> schema, |
| <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> tableName, |
| <a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a> config)</code> |
| <div class="block">Removes temporary table name from the list of session temporary tables.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#replaceUserCredentials-org.apache.drill.exec.rpc.user.InboundImpersonationManager-org.apache.drill.exec.proto.UserBitShared.UserCredentials-">replaceUserCredentials</a></span>(<a href="../../../../../../org/apache/drill/exec/rpc/user/InboundImpersonationManager.html" title="class in org.apache.drill.exec.rpc.user">InboundImpersonationManager</a> impersonationManager, |
| <a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.UserCredentials.html" title="class in org.apache.drill.exec.proto">UserBitShared.UserCredentials</a> newCredentials)</code> |
| <div class="block">Replace current user credentials with the given user's credentials.</div> |
| </td> |
| </tr> |
| <tr id="i15" 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/drill/exec/rpc/user/UserSession.html#resolveTemporaryTableName-java.lang.String-">resolveTemporaryTableName</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> tableName)</code> |
| <div class="block">Returns generated temporary table name from the list of session temporary tables, null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#setDefaultSchemaPath-java.lang.String-org.apache.calcite.schema.SchemaPlus-">setDefaultSchemaPath</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> newDefaultSchemaPath, |
| org.apache.calcite.schema.SchemaPlus currentDefaultSchema)</code> |
| <div class="block">Update the schema path for the session.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.html#setSessionOption-java.lang.String-java.lang.String-">setSessionOption</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, |
| <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> value)</code> |
| <div class="block">Set the option of a session level.</div> |
| </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#toString--" title="class or interface in java.lang">toString</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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block">On session close deletes all session temporary locations recursively and clears temporary locations list.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSupportComplexTypes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSupportComplexTypes</h4> |
| <pre>public boolean isSupportComplexTypes()</pre> |
| </li> |
| </ul> |
| <a name="getOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOptions</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/server/options/SessionOptionManager.html" title="class in org.apache.drill.exec.server.options">SessionOptionManager</a> getOptions()</pre> |
| </li> |
| </ul> |
| <a name="getCredentials--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCredentials</h4> |
| <pre>public <a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.UserCredentials.html" title="class in org.apache.drill.exec.proto">UserBitShared.UserCredentials</a> getCredentials()</pre> |
| </li> |
| </ul> |
| <a name="replaceUserCredentials-org.apache.drill.exec.rpc.user.InboundImpersonationManager-org.apache.drill.exec.proto.UserBitShared.UserCredentials-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replaceUserCredentials</h4> |
| <pre>public void replaceUserCredentials(<a href="../../../../../../org/apache/drill/exec/rpc/user/InboundImpersonationManager.html" title="class in org.apache.drill.exec.rpc.user">InboundImpersonationManager</a> impersonationManager, |
| <a href="../../../../../../org/apache/drill/exec/proto/UserBitShared.UserCredentials.html" title="class in org.apache.drill.exec.proto">UserBitShared.UserCredentials</a> newCredentials)</pre> |
| <div class="block">Replace current user credentials with the given user's credentials. Meant to be called only by a |
| <a href="../../../../../../org/apache/drill/exec/rpc/user/InboundImpersonationManager.html" title="class in org.apache.drill.exec.rpc.user"><code>impersonation manager</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>impersonationManager</code> - impersonation manager making this call</dd> |
| <dd><code>newCredentials</code> - user credentials to change to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTargetUserName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTargetUserName</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> getTargetUserName()</pre> |
| </li> |
| </ul> |
| <a name="incrementQueryCount-org.apache.drill.exec.rpc.user.UserSession.QueryCountIncrementer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>incrementQueryCount</h4> |
| <pre>public void incrementQueryCount(<a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.QueryCountIncrementer.html" title="interface in org.apache.drill.exec.rpc.user">UserSession.QueryCountIncrementer</a> incrementer)</pre> |
| </li> |
| </ul> |
| <a name="getQueryCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryCount</h4> |
| <pre>public int getQueryCount()</pre> |
| </li> |
| </ul> |
| <a name="setDefaultSchemaPath-java.lang.String-org.apache.calcite.schema.SchemaPlus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDefaultSchemaPath</h4> |
| <pre>public void setDefaultSchemaPath(<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> newDefaultSchemaPath, |
| org.apache.calcite.schema.SchemaPlus currentDefaultSchema) |
| throws org.apache.calcite.tools.ValidationException</pre> |
| <div class="block">Update the schema path for the session.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newDefaultSchemaPath</code> - New default schema path to set. It could be relative to the current default schema or |
| absolute schema.</dd> |
| <dd><code>currentDefaultSchema</code> - Current default schema.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.calcite.tools.ValidationException</code> - If the given default schema path is invalid in current schema tree.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultSchemaPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultSchemaPath</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> getDefaultSchemaPath()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Get current default schema path.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultSchema-org.apache.calcite.schema.SchemaPlus-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultSchema</h4> |
| <pre>public org.apache.calcite.schema.SchemaPlus getDefaultSchema(org.apache.calcite.schema.SchemaPlus rootSchema)</pre> |
| <div class="block">Get default schema from current default schema path and given schema tree.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rootSchema</code> - root schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>SchemaPlus</code> object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSessionOption-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSessionOption</h4> |
| <pre>public void setSessionOption(<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, |
| <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> value)</pre> |
| <div class="block">Set the option of a session level. |
| Note: Option's kind is automatically detected if such option exists.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - option name</dd> |
| <dd><code>value</code> - option value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSessionId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSessionId</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> getSessionId()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>unique session identifier</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerTemporaryTable-org.apache.drill.exec.store.AbstractSchema-java.lang.String-org.apache.drill.common.config.DrillConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerTemporaryTable</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> registerTemporaryTable(<a href="../../../../../../org/apache/drill/exec/store/AbstractSchema.html" title="class in org.apache.drill.exec.store">AbstractSchema</a> schema, |
| <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> tableName, |
| <a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a> config) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Creates and adds session temporary location if absent using schema configuration. |
| Before any actions, checks if passed table schema is valid default temporary workspace. |
| Generates temporary table name and stores it's original name as key |
| and generated name as value in session temporary tables cache. |
| Original temporary name is converted to lower case to achieve case-insensitivity. |
| If original table name already exists, new name is not regenerated and is reused. |
| This can happen if default temporary workspace was changed (file system or location) or |
| orphan temporary table name has remained (name was registered but table creation did not succeed).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - table schema</dd> |
| <dd><code>tableName</code> - original table name</dd> |
| <dd><code>config</code> - drill config</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>generated temporary table name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if error during session temporary location creation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveTemporaryTableName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveTemporaryTableName</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> resolveTemporaryTableName(<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> tableName)</pre> |
| <div class="block">Returns generated temporary table name from the list of session temporary tables, null otherwise. |
| Original temporary name is converted to lower case to achieve case-insensitivity.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableName</code> - original table name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>generated temporary table name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOriginalTableNameFromTemporaryTable-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOriginalTableNameFromTemporaryTable</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> getOriginalTableNameFromTemporaryTable(<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> tableName)</pre> |
| </li> |
| </ul> |
| <a name="isTemporaryTable-org.apache.drill.exec.store.AbstractSchema-org.apache.drill.common.config.DrillConfig-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTemporaryTable</h4> |
| <pre>public boolean isTemporaryTable(<a href="../../../../../../org/apache/drill/exec/store/AbstractSchema.html" title="class in org.apache.drill.exec.store">AbstractSchema</a> drillSchema, |
| <a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a> config, |
| <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> tableName)</pre> |
| <div class="block">Checks if passed table is temporary, table name is case-insensitive. |
| Before looking for table checks if passed schema is temporary and returns false if not |
| since temporary tables are allowed to be created in temporary workspace only. |
| If passed workspace is temporary, looks for temporary table. |
| First checks if table name is among temporary tables, if not returns false. |
| If temporary table named was resolved, checks that temporary table exists on disk, |
| to ensure that temporary table actually exists and resolved table name is not orphan |
| (for example, in result of unsuccessful temporary table creation).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>drillSchema</code> - table schema</dd> |
| <dd><code>config</code> - drill config</dd> |
| <dd><code>tableName</code> - original table name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if temporary table exists in schema, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeTemporaryTable-org.apache.drill.exec.store.AbstractSchema-java.lang.String-org.apache.drill.common.config.DrillConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeTemporaryTable</h4> |
| <pre>public void removeTemporaryTable(<a href="../../../../../../org/apache/drill/exec/store/AbstractSchema.html" title="class in org.apache.drill.exec.store">AbstractSchema</a> schema, |
| <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> tableName, |
| <a href="../../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a> config)</pre> |
| <div class="block">Removes temporary table name from the list of session temporary tables. |
| Original temporary name is converted to lower case to achieve case-insensitivity. |
| Before temporary table drop, checks if passed table schema is valid default temporary workspace.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - table schema</dd> |
| <dd><code>tableName</code> - original table name</dd> |
| <dd><code>config</code> - drill config</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="class-use/UserSession.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserServer.BitToUserConnectionConfig.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/rpc/user/UserSession.Builder.html" title="class in org.apache.drill.exec.rpc.user"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/rpc/user/UserSession.html" target="_top">Frames</a></li> |
| <li><a href="UserSession.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
