cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
306 lines (305 loc) • 20.6 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>CQLStatement (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="CQLStatement (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/CQLStatement.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/cql3/CQL3Type.UserDefined.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql3/IndexName.html" title="class in org.apache.cassandra.cql3"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cql3/CQLStatement.html" target="_top">Frames</a></li>
<li><a href="CQLStatement.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.cql3</div>
<h2 title="Interface CQLStatement" class="title">Interface CQLStatement</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/cassandra/cql3/statements/AlterKeyspaceStatement.html" title="class in org.apache.cassandra.cql3.statements">AlterKeyspaceStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/AlterTableStatement.html" title="class in org.apache.cassandra.cql3.statements">AlterTableStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/AlterTypeStatement.html" title="class in org.apache.cassandra.cql3.statements">AlterTypeStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/AlterUserStatement.html" title="class in org.apache.cassandra.cql3.statements">AlterUserStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/AuthenticationStatement.html" title="class in org.apache.cassandra.cql3.statements">AuthenticationStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/AuthorizationStatement.html" title="class in org.apache.cassandra.cql3.statements">AuthorizationStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/BatchStatement.html" title="class in org.apache.cassandra.cql3.statements">BatchStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/CreateIndexStatement.html" title="class in org.apache.cassandra.cql3.statements">CreateIndexStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/CreateKeyspaceStatement.html" title="class in org.apache.cassandra.cql3.statements">CreateKeyspaceStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/CreateTableStatement.html" title="class in org.apache.cassandra.cql3.statements">CreateTableStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/CreateTriggerStatement.html" title="class in org.apache.cassandra.cql3.statements">CreateTriggerStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/CreateTypeStatement.html" title="class in org.apache.cassandra.cql3.statements">CreateTypeStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/CreateUserStatement.html" title="class in org.apache.cassandra.cql3.statements">CreateUserStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/DeleteStatement.html" title="class in org.apache.cassandra.cql3.statements">DeleteStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/DropIndexStatement.html" title="class in org.apache.cassandra.cql3.statements">DropIndexStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/DropKeyspaceStatement.html" title="class in org.apache.cassandra.cql3.statements">DropKeyspaceStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/DropTableStatement.html" title="class in org.apache.cassandra.cql3.statements">DropTableStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/DropTriggerStatement.html" title="class in org.apache.cassandra.cql3.statements">DropTriggerStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/DropTypeStatement.html" title="class in org.apache.cassandra.cql3.statements">DropTypeStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/DropUserStatement.html" title="class in org.apache.cassandra.cql3.statements">DropUserStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/GrantStatement.html" title="class in org.apache.cassandra.cql3.statements">GrantStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/ListPermissionsStatement.html" title="class in org.apache.cassandra.cql3.statements">ListPermissionsStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/ListUsersStatement.html" title="class in org.apache.cassandra.cql3.statements">ListUsersStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html" title="class in org.apache.cassandra.cql3.statements">ModificationStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/PermissionAlteringStatement.html" title="class in org.apache.cassandra.cql3.statements">PermissionAlteringStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/RevokeStatement.html" title="class in org.apache.cassandra.cql3.statements">RevokeStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/SchemaAlteringStatement.html" title="class in org.apache.cassandra.cql3.statements">SchemaAlteringStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/SelectStatement.html" title="class in org.apache.cassandra.cql3.statements">SelectStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/TruncateStatement.html" title="class in org.apache.cassandra.cql3.statements">TruncateStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/UpdateStatement.html" title="class in org.apache.cassandra.cql3.statements">UpdateStatement</a>, <a href="../../../../org/apache/cassandra/cql3/statements/UseStatement.html" title="class in org.apache.cassandra.cql3.statements">UseStatement</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">CQLStatement</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/CQLStatement.html#checkAccess(org.apache.cassandra.service.ClientState)">checkAccess</a></strong>(<a href="../../../../org/apache/cassandra/service/ClientState.html" title="class in org.apache.cassandra.service">ClientState</a> state)</code>
<div class="block">Perform any access verification necessary for the statement.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/CQLStatement.html#execute(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">execute</a></strong>(<a href="../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a> state,
<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</code>
<div class="block">Execute the statement and return the resulting result or null if there is no result.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/CQLStatement.html#executeInternal(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">executeInternal</a></strong>(<a href="../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a> state,
<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)</code>
<div class="block">Variante of execute used for internal query against the system tables, and thus only query the local node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/CQLStatement.html#getBoundTerms()">getBoundTerms</a></strong>()</code>
<div class="block">Returns the number of bound terms in this statement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/CQLStatement.html#validate(org.apache.cassandra.service.ClientState)">validate</a></strong>(<a href="../../../../org/apache/cassandra/service/ClientState.html" title="class in org.apache.cassandra.service">ClientState</a> state)</code>
<div class="block">Perform additional validation required by the statment.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getBoundTerms()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoundTerms</h4>
<pre>int getBoundTerms()</pre>
<div class="block">Returns the number of bound terms in this statement.</div>
</li>
</ul>
<a name="checkAccess(org.apache.cassandra.service.ClientState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkAccess</h4>
<pre>void checkAccess(<a href="../../../../org/apache/cassandra/service/ClientState.html" title="class in org.apache.cassandra.service">ClientState</a> state)
throws <a href="../../../../org/apache/cassandra/exceptions/UnauthorizedException.html" title="class in org.apache.cassandra.exceptions">UnauthorizedException</a>,
<a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre>
<div class="block">Perform any access verification necessary for the statement.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - the current client state</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/UnauthorizedException.html" title="class in org.apache.cassandra.exceptions">UnauthorizedException</a></code></dd>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></code></dd></dl>
</li>
</ul>
<a name="validate(org.apache.cassandra.service.ClientState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre>void validate(<a href="../../../../org/apache/cassandra/service/ClientState.html" title="class in org.apache.cassandra.service">ClientState</a> state)
throws <a href="../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a></pre>
<div class="block">Perform additional validation required by the statment.
To be overriden by subclasses if needed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - the current client state</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a></code></dd></dl>
</li>
</ul>
<a name="execute(org.apache.cassandra.service.QueryState, org.apache.cassandra.cql3.QueryOptions)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre><a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a> execute(<a href="../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a> state,
<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)
throws <a href="../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a>,
<a href="../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a></pre>
<div class="block">Execute the statement and return the resulting result or null if there is no result.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - the current query state</dd><dd><code>options</code> - options for this query (consistency, variables, pageSize, ...)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a></code></dd>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a></code></dd></dl>
</li>
</ul>
<a name="executeInternal(org.apache.cassandra.service.QueryState, org.apache.cassandra.cql3.QueryOptions)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>executeInternal</h4>
<pre><a href="../../../../org/apache/cassandra/transport/messages/ResultMessage.html" title="class in org.apache.cassandra.transport.messages">ResultMessage</a> executeInternal(<a href="../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a> state,
<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options)
throws <a href="../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a>,
<a href="../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a></pre>
<div class="block">Variante of execute used for internal query against the system tables, and thus only query the local node.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - the current query state</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a></code></dd>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</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><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/CQLStatement.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/cql3/CQL3Type.UserDefined.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql3/IndexName.html" title="class in org.apache.cassandra.cql3"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cql3/CQLStatement.html" target="_top">Frames</a></li>
<li><a href="CQLStatement.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>