cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>CliClient (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/CliClient.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 Class</li> <li><a href="../../../../org/apache/cassandra/cli/CliClient.ColumnFamilyArgument.html" title="enum in org.apache.cassandra.cli"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cli/CliClient.html" target="_top">Frames</a></li> <li><a href="CliClient.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top">  </a></div>   <div class="header"> <div class="subTitle">org.apache.cassandra.cli</div> <h2 title="Class CliClient" class="title">Class CliClient</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cli.CliClient</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">CliClient</span> extends java.lang.Object</pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="nested_class_summary">  </a> <h3>Nested Class Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected static class </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.ColumnFamilyArgument.html" title="enum in org.apache.cassandra.cli">CliClient.ColumnFamilyArgument</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.Function.html" title="enum in org.apache.cassandra.cli">CliClient.Function</a></strong></code> <div class="block">Available value conversion functions Used by convertValueByFunction(Tree functionCall) method</div> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_summary">  </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#CliClient(org.apache.cassandra.cli.CliSessionState,%20org.apache.cassandra.thrift.Cassandra.Client)">CliClient</a></strong>(<a href="../../../../org/apache/cassandra/cli/CliSessionState.html" title="class in org.apache.cassandra.cli">CliSessionState</a> cliSessionState, <a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a> thriftClient)</code> </td> </tr> </table> </li> </ul>  <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>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#executeCLIStatement(java.lang.String)">executeCLIStatement</a></strong>(java.lang.String statement)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#getKeyAsBytes(java.lang.String,%20org.antlr.runtime.tree.Tree)">getKeyAsBytes</a></strong>(java.lang.String columnFamily, org.antlr.runtime.tree.Tree keyTree)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#getKeySpace()">getKeySpace</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#getKSMetaData(java.lang.String)">getKSMetaData</a></strong>(java.lang.String keyspace)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#getTypeByFunction(java.lang.String)">getTypeByFunction</a></strong>(java.lang.String functionName)</code> <div class="block">Get AbstractType by function name</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#getUsername()">getUsername</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.util.Map<java.lang.String,<a href="../../../../org/apache/cassandra/thrift/CfDef.html" title="class in org.apache.cassandra.thrift">CfDef</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#loadCql3Defs(org.apache.cassandra.thrift.Cassandra.Client,%20org.apache.cassandra.thrift.KsDef)">loadCql3Defs</a></strong>(<a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a> thriftClient, <a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a> thriftKs)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.util.Map<java.lang.String,<a href="../../../../org/apache/cassandra/thrift/CfDef.html" title="class in org.apache.cassandra.thrift">CfDef</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#loadCql3DefsUnchecked(org.apache.cassandra.thrift.Cassandra.Client,%20org.apache.cassandra.thrift.KsDef)">loadCql3DefsUnchecked</a></strong>(<a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a> thriftClient, <a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a> thriftKs)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#printBanner()">printBanner</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#setKeySpace(java.lang.String)">setKeySpace</a></strong>(java.lang.String keySpace)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliClient.html#setUsername(java.lang.String)">setUsername</a></strong>(java.lang.String username)</code> </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.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="CliClient(org.apache.cassandra.cli.CliSessionState, org.apache.cassandra.thrift.Cassandra.Client)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>CliClient</h4> <pre>public CliClient(<a href="../../../../org/apache/cassandra/cli/CliSessionState.html" title="class in org.apache.cassandra.cli">CliSessionState</a> cliSessionState, <a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a> thriftClient)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="printBanner()">  </a> <ul class="blockList"> <li class="blockList"> <h4>printBanner</h4> <pre>public void printBanner()</pre> </li> </ul> <a name="executeCLIStatement(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>executeCLIStatement</h4> <pre>public void executeCLIStatement(java.lang.String statement) throws java.nio.charset.CharacterCodingException, org.apache.thrift.TException, <a href="../../../../org/apache/cassandra/thrift/TimedOutException.html" title="class in org.apache.cassandra.thrift">TimedOutException</a>, <a href="../../../../org/apache/cassandra/thrift/NotFoundException.html" title="class in org.apache.cassandra.thrift">NotFoundException</a>, java.lang.NoSuchFieldException, <a href="../../../../org/apache/cassandra/thrift/InvalidRequestException.html" title="class in org.apache.cassandra.thrift">InvalidRequestException</a>, <a href="../../../../org/apache/cassandra/thrift/UnavailableException.html" title="class in org.apache.cassandra.thrift">UnavailableException</a>, java.lang.InstantiationException, java.lang.IllegalAccessException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.nio.charset.CharacterCodingException</code></dd> <dd><code>org.apache.thrift.TException</code></dd> <dd><code><a href="../../../../org/apache/cassandra/thrift/TimedOutException.html" title="class in org.apache.cassandra.thrift">TimedOutException</a></code></dd> <dd><code><a href="../../../../org/apache/cassandra/thrift/NotFoundException.html" title="class in org.apache.cassandra.thrift">NotFoundException</a></code></dd> <dd><code>java.lang.NoSuchFieldException</code></dd> <dd><code><a href="../../../../org/apache/cassandra/thrift/InvalidRequestException.html" title="class in org.apache.cassandra.thrift">InvalidRequestException</a></code></dd> <dd><code><a href="../../../../org/apache/cassandra/thrift/UnavailableException.html" title="class in org.apache.cassandra.thrift">UnavailableException</a></code></dd> <dd><code>java.lang.InstantiationException</code></dd> <dd><code>java.lang.IllegalAccessException</code></dd></dl> </li> </ul> <a name="getKSMetaData(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKSMetaData</h4> <pre>public <a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a> getKSMetaData(java.lang.String keyspace) throws <a href="../../../../org/apache/cassandra/thrift/NotFoundException.html" title="class in org.apache.cassandra.thrift">NotFoundException</a>, <a href="../../../../org/apache/cassandra/thrift/InvalidRequestException.html" title="class in org.apache.cassandra.thrift">InvalidRequestException</a>, org.apache.thrift.TException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../org/apache/cassandra/thrift/NotFoundException.html" title="class in org.apache.cassandra.thrift">NotFoundException</a></code></dd> <dd><code><a href="../../../../org/apache/cassandra/thrift/InvalidRequestException.html" title="class in org.apache.cassandra.thrift">InvalidRequestException</a></code></dd> <dd><code>org.apache.thrift.TException</code></dd></dl> </li> </ul> <a name="loadCql3Defs(org.apache.cassandra.thrift.Cassandra.Client, org.apache.cassandra.thrift.KsDef)">  </a> <ul class="blockList"> <li class="blockList"> <h4>loadCql3Defs</h4> <pre>public static java.util.Map<java.lang.String,<a href="../../../../org/apache/cassandra/thrift/CfDef.html" title="class in org.apache.cassandra.thrift">CfDef</a>> loadCql3Defs(<a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a> thriftClient, <a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a> thriftKs)</pre> </li> </ul> <a name="loadCql3DefsUnchecked(org.apache.cassandra.thrift.Cassandra.Client, org.apache.cassandra.thrift.KsDef)">  </a> <ul class="blockList"> <li class="blockList"> <h4>loadCql3DefsUnchecked</h4> <pre>public static java.util.Map<java.lang.String,<a href="../../../../org/apache/cassandra/thrift/CfDef.html" title="class in org.apache.cassandra.thrift">CfDef</a>> loadCql3DefsUnchecked(<a href="../../../../org/apache/cassandra/thrift/Cassandra.Client.html" title="class in org.apache.cassandra.thrift">Cassandra.Client</a> thriftClient, <a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a> thriftKs) throws java.lang.Exception</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.Exception</code></dd></dl> </li> </ul> <a name="getKeySpace()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKeySpace</h4> <pre>public java.lang.String getKeySpace()</pre> </li> </ul> <a name="setKeySpace(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setKeySpace</h4> <pre>public void setKeySpace(java.lang.String keySpace) throws <a href="../../../../org/apache/cassandra/thrift/NotFoundException.html" title="class in org.apache.cassandra.thrift">NotFoundException</a>, <a href="../../../../org/apache/cassandra/thrift/InvalidRequestException.html" title="class in org.apache.cassandra.thrift">InvalidRequestException</a>, org.apache.thrift.TException</pre> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../org/apache/cassandra/thrift/NotFoundException.html" title="class in org.apache.cassandra.thrift">NotFoundException</a></code></dd> <dd><code><a href="../../../../org/apache/cassandra/thrift/InvalidRequestException.html" title="class in org.apache.cassandra.thrift">InvalidRequestException</a></code></dd> <dd><code>org.apache.thrift.TException</code></dd></dl> </li> </ul> <a name="getUsername()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getUsername</h4> <pre>public java.lang.String getUsername()</pre> </li> </ul> <a name="setUsername(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setUsername</h4> <pre>public void setUsername(java.lang.String username)</pre> </li> </ul> <a name="getTypeByFunction(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTypeByFunction</h4> <pre>public static <a href="../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?> getTypeByFunction(java.lang.String functionName)</pre> <div class="block">Get AbstractType by function name</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>functionName</code> - - name of the function e.g. utf8, integer, long etc.</dd> <dt><span class="strong">Returns:</span></dt><dd>AbstractType type corresponding to the function name</dd></dl> </li> </ul> <a name="getKeyAsBytes(java.lang.String, org.antlr.runtime.tree.Tree)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>getKeyAsBytes</h4> <pre>public java.nio.ByteBuffer getKeyAsBytes(java.lang.String columnFamily, org.antlr.runtime.tree.Tree keyTree)</pre> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/CliClient.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 Class</li> <li><a href="../../../../org/apache/cassandra/cli/CliClient.ColumnFamilyArgument.html" title="enum in org.apache.cassandra.cli"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/cli/CliClient.html" target="_top">Frames</a></li> <li><a href="CliClient.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom">  </a></div>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>