cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
360 lines (359 loc) • 14.1 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:30 CEST 2014 -->
<title>CliUtils (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"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CliUtils (apache-cassandra 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/CliUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/cassandra/cli/CliUserHelp.html" title="class in org.apache.cassandra.cli"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cli/CliUtils.html" target="_top">Frames</a></li>
<li><a href="CliUtils.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>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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.cli</div>
<h2 title="Class CliUtils" class="title">Class CliUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.cli.CliUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">CliUtils</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<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/CliUtils.html#CliUtils()">CliUtils</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>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliUtils.html#escapeSQLString(java.lang.String)">escapeSQLString</a></strong>(java.lang.String b)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Set<java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliUtils.html#getCfNamesByKeySpace(org.apache.cassandra.thrift.KsDef)">getCfNamesByKeySpace</a></strong>(<a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a> keySpace)</code>
<div class="block">Returns set of column family names in specified keySpace.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/thrift/IndexOperator.html" title="enum in org.apache.cassandra.thrift">IndexOperator</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliUtils.html#getIndexOperator(java.lang.String)">getIndexOperator</a></strong>(java.lang.String operator)</code>
<div class="block">Returns IndexOperator from string representation</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/CliUtils.html#getKeySpaceDef(java.lang.String,%20java.util.List)">getKeySpaceDef</a></strong>(java.lang.String keyspaceName,
java.util.List<<a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a>> keyspaces)</code>
<div class="block">Parse the statement from cli and return KsDef</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliUtils.html#maybeEscapeName(java.lang.String)">maybeEscapeName</a></strong>(java.lang.String name)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliUtils.html#quote(java.lang.String)">quote</a></strong>(java.lang.String str)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cli/CliUtils.html#unescapeSQLString(java.lang.String)">unescapeSQLString</a></strong>(java.lang.String b)</code>
<div class="block">Strips leading and trailing "'" characters, and handles
and escaped characters such as \n, \r, etc.</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.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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CliUtils()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CliUtils</h4>
<pre>public CliUtils()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="unescapeSQLString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unescapeSQLString</h4>
<pre>public static java.lang.String unescapeSQLString(java.lang.String b)</pre>
<div class="block">Strips leading and trailing "'" characters, and handles
and escaped characters such as \n, \r, etc.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - - string to unescape</dd>
<dt><span class="strong">Returns:</span></dt><dd>String - unexspaced string</dd></dl>
</li>
</ul>
<a name="escapeSQLString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>escapeSQLString</h4>
<pre>public static java.lang.String escapeSQLString(java.lang.String b)</pre>
</li>
</ul>
<a name="maybeEscapeName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maybeEscapeName</h4>
<pre>public static java.lang.String maybeEscapeName(java.lang.String name)</pre>
</li>
</ul>
<a name="getIndexOperator(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexOperator</h4>
<pre>public static <a href="../../../../org/apache/cassandra/thrift/IndexOperator.html" title="enum in org.apache.cassandra.thrift">IndexOperator</a> getIndexOperator(java.lang.String operator)</pre>
<div class="block">Returns IndexOperator from string representation</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>operator</code> - - string representing IndexOperator (=, >=, >, <, <=)</dd>
<dt><span class="strong">Returns:</span></dt><dd>IndexOperator - enum value of IndexOperator or null if not found</dd></dl>
</li>
</ul>
<a name="getCfNamesByKeySpace(org.apache.cassandra.thrift.KsDef)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCfNamesByKeySpace</h4>
<pre>public static java.util.Set<java.lang.String> getCfNamesByKeySpace(<a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a> keySpace)</pre>
<div class="block">Returns set of column family names in specified keySpace.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keySpace</code> - - keyspace definition to get column family names from.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Set - column family names</dd></dl>
</li>
</ul>
<a name="getKeySpaceDef(java.lang.String, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeySpaceDef</h4>
<pre>public static <a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a> getKeySpaceDef(java.lang.String keyspaceName,
java.util.List<<a href="../../../../org/apache/cassandra/thrift/KsDef.html" title="class in org.apache.cassandra.thrift">KsDef</a>> keyspaces)</pre>
<div class="block">Parse the statement from cli and return KsDef</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspaceName</code> - - name of the keyspace to lookup</dd><dd><code>keyspaces</code> - - List of known keyspaces</dd>
<dt><span class="strong">Returns:</span></dt><dd>metadata about keyspace or null</dd></dl>
</li>
</ul>
<a name="quote(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>quote</h4>
<pre>public static java.lang.String quote(java.lang.String str)</pre>
</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/CliUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/cassandra/cli/CliUserHelp.html" title="class in org.apache.cassandra.cli"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cli/CliUtils.html" target="_top">Frames</a></li>
<li><a href="CliUtils.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>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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>