Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / exec / client / DrillClient.html
blob: 1eb6eda8a6394370d8abfbe3371587bea360c2d1 [file] [log] [blame]
<!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>DrillClient (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="DrillClient (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":42,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/DrillClient.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/drill/exec/client/DrillSqlLineApplication.html" title="class in org.apache.drill.exec.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/client/DrillClient.html" target="_top">Frames</a></li>
<li><a href="DrillClient.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.client</div>
<h2 title="Class DrillClient" class="title">Class DrillClient</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.client.DrillClient</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/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <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>, <a href="../../../../../org/apache/drill/exec/rpc/ConnectionThrottle.html" title="interface in org.apache.drill.exec.rpc">ConnectionThrottle</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DrillClient</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/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="../../../../../org/apache/drill/exec/rpc/ConnectionThrottle.html" title="interface in org.apache.drill.exec.rpc">ConnectionThrottle</a></pre>
<div class="block">Thin wrapper around a UserClient that handles connect/close and transforms
String into ByteBuf.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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">&nbsp;</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>static <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/client/DrillClient.html#DEFAULT_CLIENT_NAME">DEFAULT_CLIENT_NAME</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#DrillClient--">DrillClient</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#DrillClient-boolean-">DrillClient</a></span>(boolean&nbsp;isDirect)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#DrillClient-org.apache.drill.common.config.DrillConfig-">DrillClient</a></span>(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#DrillClient-org.apache.drill.common.config.DrillConfig-boolean-">DrillClient</a></span>(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
boolean&nbsp;isDirect)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#DrillClient-org.apache.drill.common.config.DrillConfig-org.apache.drill.exec.coord.ClusterCoordinator-">DrillClient</a></span>(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
<a href="../../../../../org/apache/drill/exec/coord/ClusterCoordinator.html" title="class in org.apache.drill.exec.coord">ClusterCoordinator</a>&nbsp;coordinator)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#DrillClient-org.apache.drill.common.config.DrillConfig-org.apache.drill.exec.coord.ClusterCoordinator-boolean-">DrillClient</a></span>(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
<a href="../../../../../org/apache/drill/exec/coord/ClusterCoordinator.html" title="class in org.apache.drill.exec.coord">ClusterCoordinator</a>&nbsp;coordinator,
boolean&nbsp;isDirect)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#DrillClient-org.apache.drill.common.config.DrillConfig-org.apache.drill.exec.coord.ClusterCoordinator-org.apache.drill.exec.memory.BufferAllocator-">DrillClient</a></span>(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
<a href="../../../../../org/apache/drill/exec/coord/ClusterCoordinator.html" title="class in org.apache.drill.exec.coord">ClusterCoordinator</a>&nbsp;coordinator,
<a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a>&nbsp;allocator)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#DrillClient-org.apache.drill.common.config.DrillConfig-org.apache.drill.exec.coord.ClusterCoordinator-org.apache.drill.exec.memory.BufferAllocator-boolean-">DrillClient</a></span>(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
<a href="../../../../../org/apache/drill/exec/coord/ClusterCoordinator.html" title="class in org.apache.drill.exec.coord">ClusterCoordinator</a>&nbsp;coordinator,
<a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a>&nbsp;allocator,
boolean&nbsp;isDirect)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#DrillClient-java.lang.String-">DrillClient</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>&nbsp;fileName)</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/GeneralRPCProtos.Ack.html" title="class in org.apache.drill.exec.proto">GeneralRPCProtos.Ack</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#cancelQuery-org.apache.drill.exec.proto.UserBitShared.QueryId-">cancelQuery</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a>&nbsp;id)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#close--">close</a></span>()</code>
<div class="block">Closes this client's connection to the server</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#connect--">connect</a></span>()</code>
<div class="block">Connects the client to a Drillbit server</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#connect-java.util.Properties-">connect</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)</code>
<div class="block">Start's a connection from client to server</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#connect-java.lang.String-java.util.Properties-">connect</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>&nbsp;connect,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)</code>
<div class="block">Start's a connection from client to server</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#connectionIsActive--">connectionIsActive</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected static io.netty.channel.EventLoopGroup</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#createEventLoop-int-java.lang.String-">createEventLoop</a></span>(int&nbsp;size,
<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>&nbsp;prefix)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.CreatePreparedStatementResp.html" title="class in org.apache.drill.exec.proto">UserProtos.CreatePreparedStatementResp</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#createPreparedStatement-java.lang.String-">createPreparedStatement</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>&nbsp;query)</code>
<div class="block">Create a prepared statement for given the <code>query</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/drill/exec/rpc/user/QueryDataBatch.html" title="class in org.apache.drill.exec.rpc.user">QueryDataBatch</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#executePreparedStatement-org.apache.drill.exec.proto.UserProtos.PreparedStatementHandle-">executePreparedStatement</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.PreparedStatementHandle.html" title="class in org.apache.drill.exec.proto">UserProtos.PreparedStatementHandle</a>&nbsp;preparedStatementHandle)</code>
<div class="block">Execute the given prepared statement and return the results.</div>
</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/client/DrillClient.html#executePreparedStatement-org.apache.drill.exec.proto.UserProtos.PreparedStatementHandle-org.apache.drill.exec.rpc.user.UserResultsListener-">executePreparedStatement</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.PreparedStatementHandle.html" title="class in org.apache.drill.exec.proto">UserProtos.PreparedStatementHandle</a>&nbsp;preparedStatementHandle,
<a href="../../../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a>&nbsp;resultsListener)</code>
<div class="block">Execute the given prepared statement.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getAllocator--">getAllocator</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetCatalogsResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetCatalogsResp</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getCatalogs-org.apache.drill.exec.proto.UserProtos.LikeFilter-">getCatalogs</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;catalogNameFilter)</code>
<div class="block">Get the list of catalogs in <code>INFORMATION_SCHEMA.CATALOGS</code> table satisfying the given filters.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetColumnsResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetColumnsResp</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getColumns-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-">getColumns</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;catalogNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;schemaNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;tableNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;columnNameFilter)</code>
<div class="block">Get the list of columns in <code>INFORMATION_SCHEMA.COLUMNS</code> table satisfying the given filters.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getConfig--">getConfig</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetSchemasResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetSchemasResp</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getSchemas-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-">getSchemas</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;catalogNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;schemaNameFilter)</code>
<div class="block">Get the list of schemas in <code>INFORMATION_SCHEMA.SCHEMATA</code> table satisfying the given filters.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/proto/UserProtos.RpcEndpointInfos.html" title="class in org.apache.drill.exec.proto">UserProtos.RpcEndpointInfos</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getServerInfos--">getServerInfos</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <code>DrillClient#getServerVersion()</code></span></div>
</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetServerMetaResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetServerMetaResp</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getServerMeta--">getServerMeta</a></span>()</code>
<div class="block">Get server meta information
Get meta information about the server like the the available functions
or the identifier quoting string used by the current session</div>
</td>
</tr>
<tr id="i17" 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/client/DrillClient.html#getServerName--">getServerName</a></span>()</code>
<div class="block">Return the server name.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/common/Version.html" title="class in org.apache.drill.common">Version</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getServerVersion--">getServerVersion</a></span>()</code>
<div class="block">Return the server version.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/apache/drill/exec/client/ServerMethod.html" title="enum in org.apache.drill.exec.client">ServerMethod</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getSupportedMethods--">getSupportedMethods</a></span>()</code>
<div class="block">Returns the list of methods supported by the server based on its advertised information.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetTablesResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetTablesResp</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#getTables-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-java.util.List-">getTables</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;catalogNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;schemaNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;tableNameFilter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;tableTypeFilter)</code>
<div class="block">Get the list of tables in <code>INFORMATION_SCHEMA.TABLES</code> table satisfying the given filters.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#hasPing-long-">hasPing</a></span>(long&nbsp;timeoutSec)</code>
<div class="block">Verify connection with request-answer.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.QueryPlanFragments.html" title="class in org.apache.drill.exec.proto">UserProtos.QueryPlanFragments</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#planQuery-org.apache.drill.exec.proto.UserBitShared.QueryType-java.lang.String-boolean-">planQuery</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryType</a>&nbsp;type,
<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>&nbsp;query,
boolean&nbsp;isSplitPlan)</code>
<div class="block">API to just plan a query without execution</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#reconnect--">reconnect</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/GeneralRPCProtos.Ack.html" title="class in org.apache.drill.exec.proto">GeneralRPCProtos.Ack</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#resumeQuery-org.apache.drill.exec.proto.UserBitShared.QueryId-">resumeQuery</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a>&nbsp;queryId)</code>&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#runQuery-org.apache.drill.exec.proto.UserBitShared.QueryType-java.util.List-org.apache.drill.exec.rpc.user.UserResultsListener-">runQuery</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryType</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/BitControl.PlanFragment.html" title="class in org.apache.drill.exec.proto">BitControl.PlanFragment</a>&gt;&nbsp;planFragments,
<a href="../../../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a>&nbsp;resultsListener)</code>
<div class="block">Run query based on list of fragments that were supposedly produced during query planning phase.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/drill/exec/rpc/user/QueryDataBatch.html" title="class in org.apache.drill.exec.rpc.user">QueryDataBatch</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#runQuery-org.apache.drill.exec.proto.UserBitShared.QueryType-java.lang.String-">runQuery</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryType</a>&nbsp;type,
<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>&nbsp;plan)</code>
<div class="block">Submits a string based query plan for execution and returns the result batches.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#runQuery-org.apache.drill.exec.proto.UserBitShared.QueryType-java.lang.String-org.apache.drill.exec.rpc.user.UserResultsListener-">runQuery</a></span>(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryType</a>&nbsp;type,
<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>&nbsp;plan,
<a href="../../../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a>&nbsp;resultsListener)</code>
<div class="block">Submits a Logical plan for direct execution (bypasses parsing)</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#setAutoRead-boolean-">setAutoRead</a></span>(boolean&nbsp;enableAutoRead)</code>&nbsp;</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#setClientName-java.lang.String-">setClientName</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>&nbsp;name)</code>
<div class="block">Sets the client name.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/drill/exec/client/DrillClient.html#setSupportComplexTypes-boolean-">setSupportComplexTypes</a></span>(boolean&nbsp;supportComplexTypes)</code>
<div class="block">Sets whether the application is willing to accept complex types (Map,
Arrays) in the returned result set.</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&nbsp;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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_CLIENT_NAME">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_CLIENT_NAME</h4>
<pre>public static final&nbsp;<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> DEFAULT_CLIENT_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.drill.exec.client.DrillClient.DEFAULT_CLIENT_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DrillClient--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrillClient</h4>
<pre>public&nbsp;DrillClient()
throws <a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="DrillClient-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrillClient</h4>
<pre>public&nbsp;DrillClient(boolean&nbsp;isDirect)
throws <a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="DrillClient-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrillClient</h4>
<pre>public&nbsp;DrillClient(<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>&nbsp;fileName)
throws <a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="DrillClient-org.apache.drill.common.config.DrillConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrillClient</h4>
<pre>public&nbsp;DrillClient(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config)
throws <a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="DrillClient-org.apache.drill.common.config.DrillConfig-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrillClient</h4>
<pre>public&nbsp;DrillClient(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
boolean&nbsp;isDirect)
throws <a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="DrillClient-org.apache.drill.common.config.DrillConfig-org.apache.drill.exec.coord.ClusterCoordinator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrillClient</h4>
<pre>public&nbsp;DrillClient(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
<a href="../../../../../org/apache/drill/exec/coord/ClusterCoordinator.html" title="class in org.apache.drill.exec.coord">ClusterCoordinator</a>&nbsp;coordinator)
throws <a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="DrillClient-org.apache.drill.common.config.DrillConfig-org.apache.drill.exec.coord.ClusterCoordinator-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrillClient</h4>
<pre>public&nbsp;DrillClient(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
<a href="../../../../../org/apache/drill/exec/coord/ClusterCoordinator.html" title="class in org.apache.drill.exec.coord">ClusterCoordinator</a>&nbsp;coordinator,
boolean&nbsp;isDirect)
throws <a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="DrillClient-org.apache.drill.common.config.DrillConfig-org.apache.drill.exec.coord.ClusterCoordinator-org.apache.drill.exec.memory.BufferAllocator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DrillClient</h4>
<pre>public&nbsp;DrillClient(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
<a href="../../../../../org/apache/drill/exec/coord/ClusterCoordinator.html" title="class in org.apache.drill.exec.coord">ClusterCoordinator</a>&nbsp;coordinator,
<a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a>&nbsp;allocator)
throws <a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/exception/OutOfMemoryException.html" title="class in org.apache.drill.exec.exception">OutOfMemoryException</a></code></dd>
</dl>
</li>
</ul>
<a name="DrillClient-org.apache.drill.common.config.DrillConfig-org.apache.drill.exec.coord.ClusterCoordinator-org.apache.drill.exec.memory.BufferAllocator-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DrillClient</h4>
<pre>public&nbsp;DrillClient(<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;config,
<a href="../../../../../org/apache/drill/exec/coord/ClusterCoordinator.html" title="class in org.apache.drill.exec.coord">ClusterCoordinator</a>&nbsp;coordinator,
<a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a>&nbsp;allocator,
boolean&nbsp;isDirect)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/common/config/DrillConfig.html" title="class in org.apache.drill.common.config">DrillConfig</a>&nbsp;getConfig()</pre>
</li>
</ul>
<a name="setAutoRead-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoRead</h4>
<pre>public&nbsp;void&nbsp;setAutoRead(boolean&nbsp;enableAutoRead)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/rpc/ConnectionThrottle.html#setAutoRead-boolean-">setAutoRead</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/drill/exec/rpc/ConnectionThrottle.html" title="interface in org.apache.drill.exec.rpc">ConnectionThrottle</a></code></dd>
</dl>
</li>
</ul>
<a name="setClientName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setClientName</h4>
<pre>public&nbsp;void&nbsp;setClientName(<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>&nbsp;name)</pre>
<div class="block">Sets the client name.
If not set, default is <code>DrillClient#DEFAULT_CLIENT_NAME</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the client name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if called after a connection has been established.</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 client name is null</dd>
</dl>
</li>
</ul>
<a name="setSupportComplexTypes-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSupportComplexTypes</h4>
<pre>public&nbsp;void&nbsp;setSupportComplexTypes(boolean&nbsp;supportComplexTypes)</pre>
<div class="block">Sets whether the application is willing to accept complex types (Map,
Arrays) in the returned result set. Default is <code>true</code>. If set to
<code>false</code>, the complex types are returned as JSON encoded VARCHAR type.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if called after a connection has been established.</dd>
</dl>
</li>
</ul>
<a name="connect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public&nbsp;void&nbsp;connect()
throws <a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre>
<div class="block">Connects the client to a Drillbit server</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code></dd>
</dl>
</li>
</ul>
<a name="connect-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public&nbsp;void&nbsp;connect(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)
throws <a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre>
<div class="block">Start's a connection from client to server</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>props</code> - - not null <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> filled with connection url parameters</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code></dd>
</dl>
</li>
</ul>
<a name="connect-java.lang.String-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect</h4>
<pre>public&nbsp;void&nbsp;connect(<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>&nbsp;connect,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)
throws <a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre>
<div class="block">Start's a connection from client to server</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connect</code> - - Zookeeper connection string provided at connection URL</dd>
<dd><code>props</code> - - not null <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> filled with connection url parameters</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code></dd>
</dl>
</li>
</ul>
<a name="createEventLoop-int-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createEventLoop</h4>
<pre>protected static&nbsp;io.netty.channel.EventLoopGroup&nbsp;createEventLoop(int&nbsp;size,
<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>&nbsp;prefix)</pre>
</li>
</ul>
<a name="reconnect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reconnect</h4>
<pre>public&nbsp;boolean&nbsp;reconnect()</pre>
</li>
</ul>
<a name="getAllocator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllocator</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/memory/BufferAllocator.html" title="interface in org.apache.drill.exec.memory">BufferAllocator</a>&nbsp;getAllocator()</pre>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block">Closes this client's connection to the server</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
<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>&nbsp;in interface&nbsp;<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="getServerInfos--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerInfos</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.RpcEndpointInfos.html" title="class in org.apache.drill.exec.proto">UserProtos.RpcEndpointInfos</a>&nbsp;getServerInfos()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <code>DrillClient#getServerVersion()</code></span></div>
<div class="block">Return the server infos. Only available after connecting
The result might be null if the server doesn't provide the informations.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the server informations, or null if not connected or if the server
doesn't provide the information</dd>
</dl>
</li>
</ul>
<a name="getServerName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerName</h4>
<pre>public&nbsp;<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>&nbsp;getServerName()</pre>
<div class="block">Return the server name. Only available after connecting
The result might be null if the server doesn't provide the name information.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the server name, or null if not connected or if the server
doesn't provide the name</dd>
</dl>
</li>
</ul>
<a name="getServerVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerVersion</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/common/Version.html" title="class in org.apache.drill.common">Version</a>&nbsp;getServerVersion()</pre>
<div class="block">Return the server version. Only available after connecting
The result might be null if the server doesn't provide the version information.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the server version, or null if not connected or if the server
doesn't provide the version</dd>
</dl>
</li>
</ul>
<a name="getServerMeta--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerMeta</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetServerMetaResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetServerMetaResp</a>&gt;&nbsp;getServerMeta()</pre>
<div class="block">Get server meta information
Get meta information about the server like the the available functions
or the identifier quoting string used by the current session</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a future to the server meta response</dd>
</dl>
</li>
</ul>
<a name="getSupportedMethods--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSupportedMethods</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../org/apache/drill/exec/client/ServerMethod.html" title="enum in org.apache.drill.exec.client">ServerMethod</a>&gt;&nbsp;getSupportedMethods()</pre>
<div class="block">Returns the list of methods supported by the server based on its advertised information.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an immutable set of capabilities</dd>
</dl>
</li>
</ul>
<a name="runQuery-org.apache.drill.exec.proto.UserBitShared.QueryType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runQuery</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/drill/exec/rpc/user/QueryDataBatch.html" title="class in org.apache.drill.exec.rpc.user">QueryDataBatch</a>&gt;&nbsp;runQuery(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryType</a>&nbsp;type,
<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>&nbsp;plan)
throws <a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre>
<div class="block">Submits a string based query plan for execution and returns the result batches. Supported query types are:
<p><ul>
<li><a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html#LOGICAL"><code>UserBitShared.QueryType.LOGICAL</code></a>
<li><a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html#PHYSICAL"><code>UserBitShared.QueryType.PHYSICAL</code></a>
<li><a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html#SQL"><code>UserBitShared.QueryType.SQL</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Query type</dd>
<dd><code>plan</code> - Query to execute</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a handle for the query result</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code></dd>
</dl>
</li>
</ul>
<a name="planQuery-org.apache.drill.exec.proto.UserBitShared.QueryType-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>planQuery</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.QueryPlanFragments.html" title="class in org.apache.drill.exec.proto">UserProtos.QueryPlanFragments</a>&gt;&nbsp;planQuery(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryType</a>&nbsp;type,
<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>&nbsp;query,
boolean&nbsp;isSplitPlan)</pre>
<div class="block">API to just plan a query without execution</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - </dd>
<dd><code>query</code> - </dd>
<dd><code>isSplitPlan</code> - option to tell whether to return single or split plans for a query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of PlanFragments that can be used later on in
<a href="../../../../../org/apache/drill/exec/client/DrillClient.html#runQuery-org.apache.drill.exec.proto.UserBitShared.QueryType-java.util.List-org.apache.drill.exec.rpc.user.UserResultsListener-"><code>runQuery(org.apache.drill.exec.proto.UserBitShared.QueryType,
java.util.List, org.apache.drill.exec.rpc.user.UserResultsListener)</code></a>
to run a query without additional planning</dd>
</dl>
</li>
</ul>
<a name="runQuery-org.apache.drill.exec.proto.UserBitShared.QueryType-java.util.List-org.apache.drill.exec.rpc.user.UserResultsListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runQuery</h4>
<pre>public&nbsp;void&nbsp;runQuery(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryType</a>&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/BitControl.PlanFragment.html" title="class in org.apache.drill.exec.proto">BitControl.PlanFragment</a>&gt;&nbsp;planFragments,
<a href="../../../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a>&nbsp;resultsListener)
throws <a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre>
<div class="block">Run query based on list of fragments that were supposedly produced during query planning phase. Supported
query type is <a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html#EXECUTION"><code>UserBitShared.QueryType.EXECUTION</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - </dd>
<dd><code>planFragments</code> - </dd>
<dd><code>resultsListener</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code></dd>
</dl>
</li>
</ul>
<a name="cancelQuery-org.apache.drill.exec.proto.UserBitShared.QueryId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancelQuery</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/GeneralRPCProtos.Ack.html" title="class in org.apache.drill.exec.proto">GeneralRPCProtos.Ack</a>&gt;&nbsp;cancelQuery(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a>&nbsp;id)</pre>
</li>
</ul>
<a name="resumeQuery-org.apache.drill.exec.proto.UserBitShared.QueryId-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resumeQuery</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/GeneralRPCProtos.Ack.html" title="class in org.apache.drill.exec.proto">GeneralRPCProtos.Ack</a>&gt;&nbsp;resumeQuery(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryId.html" title="class in org.apache.drill.exec.proto">UserBitShared.QueryId</a>&nbsp;queryId)</pre>
</li>
</ul>
<a name="getCatalogs-org.apache.drill.exec.proto.UserProtos.LikeFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCatalogs</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetCatalogsResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetCatalogsResp</a>&gt;&nbsp;getCatalogs(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;catalogNameFilter)</pre>
<div class="block">Get the list of catalogs in <code>INFORMATION_SCHEMA.CATALOGS</code> table satisfying the given filters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalogNameFilter</code> - Filter on <code>catalog name</code>. Pass null to apply no filter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of catalogs in <code>INFORMATION_SCHEMA.CATALOGS</code> table satisfying the given filters.</dd>
</dl>
</li>
</ul>
<a name="getSchemas-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchemas</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetSchemasResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetSchemasResp</a>&gt;&nbsp;getSchemas(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;catalogNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;schemaNameFilter)</pre>
<div class="block">Get the list of schemas in <code>INFORMATION_SCHEMA.SCHEMATA</code> table satisfying the given filters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalogNameFilter</code> - Filter on <code>catalog name</code>. Pass null to apply no filter.</dd>
<dd><code>schemaNameFilter</code> - Filter on <code>schema name</code>. Pass null to apply no filter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of schemas in <code>INFORMATION_SCHEMA.SCHEMATA</code> table satisfying the given filters.</dd>
</dl>
</li>
</ul>
<a name="getTables-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTables</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetTablesResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetTablesResp</a>&gt;&nbsp;getTables(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;catalogNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;schemaNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;tableNameFilter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;tableTypeFilter)</pre>
<div class="block">Get the list of tables in <code>INFORMATION_SCHEMA.TABLES</code> table satisfying the given filters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalogNameFilter</code> - Filter on <code>catalog name</code>. Pass null to apply no filter.</dd>
<dd><code>schemaNameFilter</code> - Filter on <code>schema name</code>. Pass null to apply no filter.</dd>
<dd><code>tableNameFilter</code> - Filter in <code>table name</code>. Pass null to apply no filter.</dd>
<dd><code>tableTypeFilter</code> - Filter in <code>table type</code>. Pass null to apply no filter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of tables in <code>INFORMATION_SCHEMA.TABLES</code> table satisfying the given filters.</dd>
</dl>
</li>
</ul>
<a name="getColumns-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-org.apache.drill.exec.proto.UserProtos.LikeFilter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumns</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.GetColumnsResp.html" title="class in org.apache.drill.exec.proto">UserProtos.GetColumnsResp</a>&gt;&nbsp;getColumns(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;catalogNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;schemaNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;tableNameFilter,
<a href="../../../../../org/apache/drill/exec/proto/UserProtos.LikeFilter.html" title="class in org.apache.drill.exec.proto">UserProtos.LikeFilter</a>&nbsp;columnNameFilter)</pre>
<div class="block">Get the list of columns in <code>INFORMATION_SCHEMA.COLUMNS</code> table satisfying the given filters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>catalogNameFilter</code> - Filter on <code>catalog name</code>. Pass null to apply no filter.</dd>
<dd><code>schemaNameFilter</code> - Filter on <code>schema name</code>. Pass null to apply no filter.</dd>
<dd><code>tableNameFilter</code> - Filter in <code>table name</code>. Pass null to apply no filter.</dd>
<dd><code>columnNameFilter</code> - Filter in <code>column name</code>. Pass null to apply no filter.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The list of columns in <code>INFORMATION_SCHEMA.COLUMNS</code> table satisfying the given filters.</dd>
</dl>
</li>
</ul>
<a name="createPreparedStatement-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createPreparedStatement</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/drill/exec/rpc/DrillRpcFuture.html" title="interface in org.apache.drill.exec.rpc">DrillRpcFuture</a>&lt;<a href="../../../../../org/apache/drill/exec/proto/UserProtos.CreatePreparedStatementResp.html" title="class in org.apache.drill.exec.proto">UserProtos.CreatePreparedStatementResp</a>&gt;&nbsp;createPreparedStatement(<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>&nbsp;query)</pre>
<div class="block">Create a prepared statement for given the <code>query</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>query</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The prepared statement for given the <code>query</code>.</dd>
</dl>
</li>
</ul>
<a name="executePreparedStatement-org.apache.drill.exec.proto.UserProtos.PreparedStatementHandle-org.apache.drill.exec.rpc.user.UserResultsListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executePreparedStatement</h4>
<pre>public&nbsp;void&nbsp;executePreparedStatement(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.PreparedStatementHandle.html" title="class in org.apache.drill.exec.proto">UserProtos.PreparedStatementHandle</a>&nbsp;preparedStatementHandle,
<a href="../../../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a>&nbsp;resultsListener)</pre>
<div class="block">Execute the given prepared statement.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preparedStatementHandle</code> - Prepared statement handle returned in response to
<a href="../../../../../org/apache/drill/exec/client/DrillClient.html#createPreparedStatement-java.lang.String-"><code>createPreparedStatement(String)</code></a>.</dd>
<dd><code>resultsListener</code> - <a href="../../../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user"><code>UserResultsListener</code></a> instance for listening for query results.</dd>
</dl>
</li>
</ul>
<a name="executePreparedStatement-org.apache.drill.exec.proto.UserProtos.PreparedStatementHandle-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executePreparedStatement</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/drill/exec/rpc/user/QueryDataBatch.html" title="class in org.apache.drill.exec.rpc.user">QueryDataBatch</a>&gt;&nbsp;executePreparedStatement(<a href="../../../../../org/apache/drill/exec/proto/UserProtos.PreparedStatementHandle.html" title="class in org.apache.drill.exec.proto">UserProtos.PreparedStatementHandle</a>&nbsp;preparedStatementHandle)
throws <a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></pre>
<div class="block">Execute the given prepared statement and return the results.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preparedStatementHandle</code> - Prepared statement handle returned in response to
<a href="../../../../../org/apache/drill/exec/client/DrillClient.html#createPreparedStatement-java.lang.String-"><code>createPreparedStatement(String)</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of <a href="../../../../../org/apache/drill/exec/rpc/user/QueryDataBatch.html" title="class in org.apache.drill.exec.rpc.user"><code>QueryDataBatch</code></a>s. It is responsibility of the caller to release query data batches.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/exec/rpc/RpcException.html" title="class in org.apache.drill.exec.rpc">RpcException</a></code></dd>
</dl>
</li>
</ul>
<a name="runQuery-org.apache.drill.exec.proto.UserBitShared.QueryType-java.lang.String-org.apache.drill.exec.rpc.user.UserResultsListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runQuery</h4>
<pre>public&nbsp;void&nbsp;runQuery(<a href="../../../../../org/apache/drill/exec/proto/UserBitShared.QueryType.html" title="enum in org.apache.drill.exec.proto">UserBitShared.QueryType</a>&nbsp;type,
<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>&nbsp;plan,
<a href="../../../../../org/apache/drill/exec/rpc/user/UserResultsListener.html" title="interface in org.apache.drill.exec.rpc.user">UserResultsListener</a>&nbsp;resultsListener)</pre>
<div class="block">Submits a Logical plan for direct execution (bypasses parsing)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plan</code> - the plan to execute</dd>
</dl>
</li>
</ul>
<a name="connectionIsActive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionIsActive</h4>
<pre>public&nbsp;boolean&nbsp;connectionIsActive()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if client has connection and it is connected, false otherwise</dd>
</dl>
</li>
</ul>
<a name="hasPing-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hasPing</h4>
<pre>public&nbsp;boolean&nbsp;hasPing(long&nbsp;timeoutSec)
throws <a href="../../../../../org/apache/drill/common/exceptions/DrillRuntimeException.html" title="class in org.apache.drill.common.exceptions">DrillRuntimeException</a></pre>
<div class="block">Verify connection with request-answer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeoutSec</code> - time in seconds to wait answer receiving. If 0 then won't wait.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if <code>PONG</code> received until timeout, false otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/drill/common/exceptions/DrillRuntimeException.html" title="class in org.apache.drill.common.exceptions">DrillRuntimeException</a></code></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/DrillClient.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/drill/exec/client/DrillSqlLineApplication.html" title="class in org.apache.drill.exec.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/drill/exec/client/DrillClient.html" target="_top">Frames</a></li>
<li><a href="DrillClient.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>