| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>KuduClient (Kudu 0.8.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="KuduClient (Kudu 0.8.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/KuduClient.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/kududb/client/IsAlterTableDoneResponse.html" title="class in org.kududb.client"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/kududb/client/KuduException.html" title="class in org.kududb.client"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/kududb/client/KuduClient.html" target="_top">Frames</a></li> |
| <li><a href="KuduClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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.kududb.client</div> |
| <h2 title="Class KuduClient" class="title">Class KuduClient</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/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.kududb.client.KuduClient</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| public class <span class="strong">KuduClient</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre> |
| <div class="block">A synchronous and thread-safe client for Kudu. |
| <p> |
| This class acts as a wrapper around <a href="../../../org/kududb/client/AsyncKuduClient.html" title="class in org.kududb.client"><code>AsyncKuduClient</code></a>. The <code>Deferred</code> objects are |
| joined against using the default admin operation timeout |
| (see <code>KuduClient.KuduClientBuilder.defaultAdminOperationTimeoutMs(long)</code> (long)}).</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#LOG">LOG</a></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/AlterTableResponse.html" title="class in org.kududb.client">AlterTableResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#alterTable(java.lang.String,%20org.kududb.client.AlterTableOptions)">alterTable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../org/kududb/client/AlterTableOptions.html" title="class in org.kududb.client">AlterTableOptions</a> ato)</code> |
| <div class="block">Alter a table on the cluster as specified by the builder.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#close()">close</a></strong>()</code> |
| <div class="block">Analogous to <a href="../../../org/kududb/client/KuduClient.html#shutdown()"><code>shutdown()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#createTable(java.lang.String,%20org.kududb.Schema)">createTable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../org/kududb/Schema.html" title="class in org.kududb">Schema</a> schema)</code> |
| <div class="block">Create a table on the cluster with the specified name and schema.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#createTable(java.lang.String,%20org.kududb.Schema,%20org.kududb.client.CreateTableOptions)">createTable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../org/kududb/Schema.html" title="class in org.kududb">Schema</a> schema, |
| <a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a> builder)</code> |
| <div class="block">Create a table on the cluster with the specified name, schema, and table configurations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/DeleteTableResponse.html" title="class in org.kududb.client">DeleteTableResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#deleteTable(java.lang.String)">deleteTable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Delete a table on the cluster with the specified name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#getDefaultAdminOperationTimeoutMs()">getDefaultAdminOperationTimeoutMs</a></strong>()</code> |
| <div class="block">Get the timeout used for admin operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#getDefaultOperationTimeoutMs()">getDefaultOperationTimeoutMs</a></strong>()</code> |
| <div class="block">Get the timeout used for operations on sessions and scanners.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/ListTablesResponse.html" title="class in org.kududb.client">ListTablesResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#getTablesList()">getTablesList</a></strong>()</code> |
| <div class="block">Get the list of all the tables.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/ListTablesResponse.html" title="class in org.kududb.client">ListTablesResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#getTablesList(java.lang.String)">getTablesList</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nameFilter)</code> |
| <div class="block">Get a list of table names.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#isAlterTableDone(java.lang.String)">isAlterTableDone</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Helper method that checks and waits until the completion of an alter command.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/ListTabletServersResponse.html" title="class in org.kududb.client">ListTabletServersResponse</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#listTabletServers()">listTabletServers</a></strong>()</code> |
| <div class="block">Get the list of running tablet servers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/KuduScanner.KuduScannerBuilder.html" title="class in org.kududb.client">KuduScanner.KuduScannerBuilder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#newScannerBuilder(org.kududb.client.KuduTable)">newScannerBuilder</a></strong>(<a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a> table)</code> |
| <div class="block">Creates a new <a href="../../../org/kududb/client/KuduScanner.KuduScannerBuilder.html" title="class in org.kududb.client"><code>KuduScanner.KuduScannerBuilder</code></a> for a particular table.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/KuduSession.html" title="class in org.kududb.client">KuduSession</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#newSession()">newSession</a></strong>()</code> |
| <div class="block">Create a new session for interacting with the cluster.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#openTable(java.lang.String)">openTable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Open the table with the given name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#shutdown()">shutdown</a></strong>()</code> |
| <div class="block">Performs a graceful shutdown of this instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/kududb/client/KuduClient.html#tableExists(java.lang.String)">tableExists</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Test if a table exists.</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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="LOG"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>public static final org.slf4j.Logger LOG</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createTable(java.lang.String, org.kududb.Schema)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>public <a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a> createTable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../org/kududb/Schema.html" title="class in org.kududb">Schema</a> schema) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Create a table on the cluster with the specified name and schema. Default table |
| configurations are used, mainly the table will have one tablet.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Table's name</dd><dd><code>schema</code> - Table's schema</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an object to communicate with the created table</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="createTable(java.lang.String, org.kududb.Schema, org.kududb.client.CreateTableOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createTable</h4> |
| <pre>public <a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a> createTable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../org/kududb/Schema.html" title="class in org.kududb">Schema</a> schema, |
| <a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a> builder) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Create a table on the cluster with the specified name, schema, and table configurations.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the table's name</dd><dd><code>schema</code> - the table's schema</dd><dd><code>builder</code> - a builder containing the table's configurations</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an object to communicate with the created table</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="deleteTable(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteTable</h4> |
| <pre>public <a href="../../../org/kududb/client/DeleteTableResponse.html" title="class in org.kududb.client">DeleteTableResponse</a> deleteTable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Delete a table on the cluster with the specified name.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the table's name</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an rpc response object</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="alterTable(java.lang.String, org.kududb.client.AlterTableOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>alterTable</h4> |
| <pre>public <a href="../../../org/kududb/client/AlterTableResponse.html" title="class in org.kududb.client">AlterTableResponse</a> alterTable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../org/kududb/client/AlterTableOptions.html" title="class in org.kududb.client">AlterTableOptions</a> ato) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Alter a table on the cluster as specified by the builder. |
| |
| When the method returns it only indicates that the master accepted the alter |
| command, use <a href="../../../org/kududb/client/KuduClient.html#isAlterTableDone(java.lang.String)"><code>isAlterTableDone(String)</code></a> to know when the alter finishes.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the table's name, if this is a table rename then the old table name must be passed</dd><dd><code>ato</code> - the alter table builder</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an rpc response object</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="isAlterTableDone(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAlterTableDone</h4> |
| <pre>public boolean isAlterTableDone(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Helper method that checks and waits until the completion of an alter command. |
| It will block until the alter command is done or the timeout is reached.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Table's name, if the table was renamed then that name must be checked against</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a boolean indicating if the table is done being altered</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="listTabletServers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listTabletServers</h4> |
| <pre>public <a href="../../../org/kududb/client/ListTabletServersResponse.html" title="class in org.kududb.client">ListTabletServersResponse</a> listTabletServers() |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Get the list of running tablet servers.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a list of tablet servers</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getTablesList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTablesList</h4> |
| <pre>public <a href="../../../org/kududb/client/ListTablesResponse.html" title="class in org.kududb.client">ListTablesResponse</a> getTablesList() |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Get the list of all the tables.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a list of all the tables</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getTablesList(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTablesList</h4> |
| <pre>public <a href="../../../org/kududb/client/ListTablesResponse.html" title="class in org.kududb.client">ListTablesResponse</a> getTablesList(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nameFilter) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Get a list of table names. Passing a null filter returns all the tables. When a filter is |
| specified, it only returns tables that satisfy a substring match.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>nameFilter</code> - an optional table name filter</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a deferred that contains the list of table names</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="tableExists(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tableExists</h4> |
| <pre>public boolean tableExists(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Test if a table exists.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a non-null table name</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the table exists, else false</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="openTable(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openTable</h4> |
| <pre>public <a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a> openTable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Open the table with the given name. If the table was just created, this method will block until |
| all its tablets have also been created.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - table to open</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a KuduTable if the table exists, else a MasterErrorException</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="newSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newSession</h4> |
| <pre>public <a href="../../../org/kududb/client/KuduSession.html" title="class in org.kududb.client">KuduSession</a> newSession()</pre> |
| <div class="block">Create a new session for interacting with the cluster. |
| User is responsible for destroying the session object. |
| This is a fully local operation (no RPCs or blocking).</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a synchronous wrapper around KuduSession.</dd></dl> |
| </li> |
| </ul> |
| <a name="newScannerBuilder(org.kududb.client.KuduTable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newScannerBuilder</h4> |
| <pre>public <a href="../../../org/kududb/client/KuduScanner.KuduScannerBuilder.html" title="class in org.kududb.client">KuduScanner.KuduScannerBuilder</a> newScannerBuilder(<a href="../../../org/kududb/client/KuduTable.html" title="class in org.kududb.client">KuduTable</a> table)</pre> |
| <div class="block">Creates a new <a href="../../../org/kududb/client/KuduScanner.KuduScannerBuilder.html" title="class in org.kududb.client"><code>KuduScanner.KuduScannerBuilder</code></a> for a particular table.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>table</code> - the name of the table you intend to scan. |
| The string is assumed to use the platform's default charset.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new scanner builder for this table</dd></dl> |
| </li> |
| </ul> |
| <a name="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Analogous to <a href="../../../org/kududb/client/KuduClient.html#shutdown()"><code>shutdown()</code></a>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an error happens while closing the connections</dd></dl> |
| </li> |
| </ul> |
| <a name="shutdown()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>public void shutdown() |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Performs a graceful shutdown of this instance.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getDefaultOperationTimeoutMs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultOperationTimeoutMs</h4> |
| <pre>public long getDefaultOperationTimeoutMs()</pre> |
| <div class="block">Get the timeout used for operations on sessions and scanners.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a timeout in milliseconds</dd></dl> |
| </li> |
| </ul> |
| <a name="getDefaultAdminOperationTimeoutMs()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDefaultAdminOperationTimeoutMs</h4> |
| <pre>public long getDefaultAdminOperationTimeoutMs()</pre> |
| <div class="block">Get the timeout used for admin operations.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a timeout in milliseconds</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/KuduClient.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/kududb/client/IsAlterTableDoneResponse.html" title="class in org.kududb.client"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/kududb/client/KuduException.html" title="class in org.kududb.client"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/kududb/client/KuduClient.html" target="_top">Frames</a></li> |
| <li><a href="KuduClient.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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 © 2016. All rights reserved.</small></p> |
| </body> |
| </html> |