cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
416 lines (415 loc) • 24.2 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:32 CEST 2014 -->
<title>DeleteStatement (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="DeleteStatement (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/DeleteStatement.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/cql/CreateKeyspaceStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql/DropIndexStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cql/DeleteStatement.html" target="_top">Frames</a></li>
<li><a href="DeleteStatement.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="#fields_inherited_from_class_org.apache.cassandra.cql.AbstractModification">Field</a> | </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.cql</div>
<h2 title="Class DeleteStatement" class="title">Class DeleteStatement</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/cassandra/cql/AbstractModification.html" title="class in org.apache.cassandra.cql">org.apache.cassandra.cql.AbstractModification</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.cql.DeleteStatement</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">DeleteStatement</span>
extends <a href="../../../../org/apache/cassandra/cql/AbstractModification.html" title="class in org.apache.cassandra.cql">AbstractModification</a></pre>
<div class="block">A <code>DELETE</code> parsed from a CQL query statement.</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.cql.AbstractModification">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.cassandra.cql.<a href="../../../../org/apache/cassandra/cql/AbstractModification.html" title="class in org.apache.cassandra.cql">AbstractModification</a></h3>
<code><a href="../../../../org/apache/cassandra/cql/AbstractModification.html#cLevel">cLevel</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#columnFamily">columnFamily</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#defaultConsistency">defaultConsistency</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#keyName">keyName</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#keyspace">keyspace</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#timestamp">timestamp</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#timeToLive">timeToLive</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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/cql/DeleteStatement.html#DeleteStatement(java.util.List,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.util.List,%20org.apache.cassandra.cql.Attributes)">DeleteStatement</a></strong>(java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>> columns,
java.lang.String keyspace,
java.lang.String columnFamily,
java.lang.String keyName,
java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>> keys,
<a href="../../../../org/apache/cassandra/cql/Attributes.html" title="class in org.apache.cassandra.cql">Attributes</a> attrs)</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>java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/DeleteStatement.html#getColumns()">getColumns</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/DeleteStatement.html#getKeys()">getKeys</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/Mutation.html" title="class in org.apache.cassandra.db">Mutation</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/DeleteStatement.html#mutationForKey(java.nio.ByteBuffer,%20java.lang.String,%20java.lang.Long,%20org.apache.cassandra.thrift.ThriftClientState,%20java.util.List,%20org.apache.cassandra.config.CFMetaData)">mutationForKey</a></strong>(java.nio.ByteBuffer key,
java.lang.String keyspace,
java.lang.Long timestamp,
<a href="../../../../org/apache/cassandra/thrift/ThriftClientState.html" title="class in org.apache.cassandra.thrift">ThriftClientState</a> clientState,
java.util.List<java.nio.ByteBuffer> variables,
<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metadata)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/db/IMutation.html" title="interface in org.apache.cassandra.db">IMutation</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/DeleteStatement.html#prepareRowMutations(java.lang.String,%20org.apache.cassandra.thrift.ThriftClientState,%20java.util.List)">prepareRowMutations</a></strong>(java.lang.String keyspace,
<a href="../../../../org/apache/cassandra/thrift/ThriftClientState.html" title="class in org.apache.cassandra.thrift">ThriftClientState</a> clientState,
java.util.List<java.nio.ByteBuffer> variables)</code>
<div class="block">Convert statement into a list of mutations to apply on the server</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/cassandra/db/IMutation.html" title="interface in org.apache.cassandra.db">IMutation</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql/DeleteStatement.html#prepareRowMutations(java.lang.String,%20org.apache.cassandra.thrift.ThriftClientState,%20java.lang.Long,%20java.util.List)">prepareRowMutations</a></strong>(java.lang.String keyspace,
<a href="../../../../org/apache/cassandra/thrift/ThriftClientState.html" title="class in org.apache.cassandra.thrift">ThriftClientState</a> clientState,
java.lang.Long timestamp,
java.util.List<java.nio.ByteBuffer> variables)</code>
<div class="block">Convert statement into a list of mutations to apply on the server</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/cql/DeleteStatement.html#toString()">toString</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.cql.AbstractModification">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.cassandra.cql.<a href="../../../../org/apache/cassandra/cql/AbstractModification.html" title="class in org.apache.cassandra.cql">AbstractModification</a></h3>
<code><a href="../../../../org/apache/cassandra/cql/AbstractModification.html#getColumnFamily()">getColumnFamily</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#getConsistencyLevel()">getConsistencyLevel</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#getKeyName()">getKeyName</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#getKeyspace()">getKeyspace</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#getTimestamp(org.apache.cassandra.thrift.ThriftClientState)">getTimestamp</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#getTimeToLive()">getTimeToLive</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#isSetConsistencyLevel()">isSetConsistencyLevel</a>, <a href="../../../../org/apache/cassandra/cql/AbstractModification.html#isSetTimestamp()">isSetTimestamp</a></code></li>
</ul>
<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, 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="DeleteStatement(java.util.List, java.lang.String, java.lang.String, java.lang.String, java.util.List, org.apache.cassandra.cql.Attributes)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DeleteStatement</h4>
<pre>public DeleteStatement(java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>> columns,
java.lang.String keyspace,
java.lang.String columnFamily,
java.lang.String keyName,
java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>> keys,
<a href="../../../../org/apache/cassandra/cql/Attributes.html" title="class in org.apache.cassandra.cql">Attributes</a> attrs)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getColumns()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumns</h4>
<pre>public java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>> getColumns()</pre>
</li>
</ul>
<a name="getKeys()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKeys</h4>
<pre>public java.util.List<<a href="../../../../org/apache/cassandra/cql/Term.html" title="class in org.apache.cassandra.cql">Term</a>> getKeys()</pre>
</li>
</ul>
<a name="prepareRowMutations(java.lang.String, org.apache.cassandra.thrift.ThriftClientState, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareRowMutations</h4>
<pre>public java.util.List<<a href="../../../../org/apache/cassandra/db/IMutation.html" title="interface in org.apache.cassandra.db">IMutation</a>> prepareRowMutations(java.lang.String keyspace,
<a href="../../../../org/apache/cassandra/thrift/ThriftClientState.html" title="class in org.apache.cassandra.thrift">ThriftClientState</a> clientState,
java.util.List<java.nio.ByteBuffer> variables)
throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a>,
<a href="../../../../org/apache/cassandra/exceptions/UnauthorizedException.html" title="class in org.apache.cassandra.exceptions">UnauthorizedException</a></pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/cassandra/cql/AbstractModification.html#prepareRowMutations(java.lang.String,%20org.apache.cassandra.thrift.ThriftClientState,%20java.util.List)">AbstractModification</a></code></strong></div>
<div class="block">Convert statement into a list of mutations to apply on the server</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/cql/AbstractModification.html#prepareRowMutations(java.lang.String,%20org.apache.cassandra.thrift.ThriftClientState,%20java.util.List)">prepareRowMutations</a></code> in class <code><a href="../../../../org/apache/cassandra/cql/AbstractModification.html" title="class in org.apache.cassandra.cql">AbstractModification</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>keyspace</code> - The working keyspace</dd><dd><code>clientState</code> - current client status</dd>
<dt><span class="strong">Returns:</span></dt><dd>list of the mutations</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></code> - on the wrong request</dd>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/UnauthorizedException.html" title="class in org.apache.cassandra.exceptions">UnauthorizedException</a></code></dd></dl>
</li>
</ul>
<a name="prepareRowMutations(java.lang.String, org.apache.cassandra.thrift.ThriftClientState, java.lang.Long, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareRowMutations</h4>
<pre>public java.util.List<<a href="../../../../org/apache/cassandra/db/IMutation.html" title="interface in org.apache.cassandra.db">IMutation</a>> prepareRowMutations(java.lang.String keyspace,
<a href="../../../../org/apache/cassandra/thrift/ThriftClientState.html" title="class in org.apache.cassandra.thrift">ThriftClientState</a> clientState,
java.lang.Long timestamp,
java.util.List<java.nio.ByteBuffer> variables)
throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a>,
<a href="../../../../org/apache/cassandra/exceptions/UnauthorizedException.html" title="class in org.apache.cassandra.exceptions">UnauthorizedException</a></pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/cassandra/cql/AbstractModification.html#prepareRowMutations(java.lang.String,%20org.apache.cassandra.thrift.ThriftClientState,%20java.lang.Long,%20java.util.List)">AbstractModification</a></code></strong></div>
<div class="block">Convert statement into a list of mutations to apply on the server</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/cassandra/cql/AbstractModification.html#prepareRowMutations(java.lang.String,%20org.apache.cassandra.thrift.ThriftClientState,%20java.lang.Long,%20java.util.List)">prepareRowMutations</a></code> in class <code><a href="../../../../org/apache/cassandra/cql/AbstractModification.html" title="class in org.apache.cassandra.cql">AbstractModification</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>keyspace</code> - The working keyspace</dd><dd><code>clientState</code> - current client status</dd><dd><code>timestamp</code> - global timestamp to use for all mutations</dd>
<dt><span class="strong">Returns:</span></dt><dd>list of the mutations</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></code> - on the wrong request</dd>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/UnauthorizedException.html" title="class in org.apache.cassandra.exceptions">UnauthorizedException</a></code></dd></dl>
</li>
</ul>
<a name="mutationForKey(java.nio.ByteBuffer, java.lang.String, java.lang.Long, org.apache.cassandra.thrift.ThriftClientState, java.util.List, org.apache.cassandra.config.CFMetaData)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mutationForKey</h4>
<pre>public <a href="../../../../org/apache/cassandra/db/Mutation.html" title="class in org.apache.cassandra.db">Mutation</a> mutationForKey(java.nio.ByteBuffer key,
java.lang.String keyspace,
java.lang.Long timestamp,
<a href="../../../../org/apache/cassandra/thrift/ThriftClientState.html" title="class in org.apache.cassandra.thrift">ThriftClientState</a> clientState,
java.util.List<java.nio.ByteBuffer> variables,
<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metadata)
throws <a href="../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<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="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</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/DeleteStatement.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/cql/CreateKeyspaceStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/cql/DropIndexStatement.html" title="class in org.apache.cassandra.cql"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cql/DeleteStatement.html" target="_top">Frames</a></li>
<li><a href="DeleteStatement.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="#fields_inherited_from_class_org.apache.cassandra.cql.AbstractModification">Field</a> | </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>