UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

311 lines (310 loc) 20.5 kB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:31 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/cql3/statements/CreateUserStatement.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/cql3/statements/DeleteStatement.Parsed.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/cql3/statements/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:&nbsp;</li> <li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.cql3.statements.ModificationStatement">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</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.statements</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/cql3/statements/ModificationStatement.html" title="class in org.apache.cassandra.cql3.statements">org.apache.cassandra.cql3.statements.ModificationStatement</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cql3.statements.DeleteStatement</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../../org/apache/cassandra/cql3/CQLStatement.html" title="interface in org.apache.cassandra.cql3">CQLStatement</a>, <a href="../../../../../org/apache/cassandra/cql3/MeasurableForPreparedCache.html" title="interface in org.apache.cassandra.cql3">MeasurableForPreparedCache</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">DeleteStatement</span> extends <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html" title="class in org.apache.cassandra.cql3.statements">ModificationStatement</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"> <!-- ======== NESTED CLASS SUMMARY ======== --> <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">&nbsp;</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>static class&nbsp;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/DeleteStatement.Parsed.html" title="class in org.apache.cassandra.cql3.statements">DeleteStatement.Parsed</a></strong></code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.cassandra.cql3.statements.ModificationStatement"> <!-- --> </a> <h3>Nested classes/interfaces inherited from class&nbsp;org.apache.cassandra.cql3.statements.<a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html" title="class in org.apache.cassandra.cql3.statements">ModificationStatement</a></h3> <code><a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.StatementType.html" title="enum in org.apache.cassandra.cql3.statements">ModificationStatement.StatementType</a></code></li> </ul> </li> </ul> <!-- =========== 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.cql3.statements.ModificationStatement"> <!-- --> </a> <h3>Fields inherited from class&nbsp;org.apache.cassandra.cql3.statements.<a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html" title="class in org.apache.cassandra.cql3.statements">ModificationStatement</a></h3> <code><a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#attrs">attrs</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#cfm">cfm</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#type">type</a></code></li> </ul> </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">&nbsp;</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/statements/DeleteStatement.html#addUpdateForKey(org.apache.cassandra.db.ColumnFamily,%20java.nio.ByteBuffer,%20org.apache.cassandra.db.composites.Composite,%20org.apache.cassandra.cql3.UpdateParameters)">addUpdateForKey</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a>&nbsp;cf, java.nio.ByteBuffer&nbsp;key, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a>&nbsp;prefix, <a href="../../../../../org/apache/cassandra/cql3/UpdateParameters.html" title="class in org.apache.cassandra.cql3">UpdateParameters</a>&nbsp;params)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/cql3/statements/DeleteStatement.html#requireFullClusteringKey()">requireFullClusteringKey</a></strong>()</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.cql3.statements.ModificationStatement"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.cql3.statements.<a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html" title="class in org.apache.cassandra.cql3.statements">ModificationStatement</a></h3> <code><a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#addCondition(org.apache.cassandra.cql3.ColumnCondition)">addCondition</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#addKeyValue(org.apache.cassandra.config.ColumnDefinition,%20org.apache.cassandra.cql3.Term)">addKeyValue</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#addOperation(org.apache.cassandra.cql3.Operation)">addOperation</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#addUpdatesAndConditions(java.nio.ByteBuffer,%20org.apache.cassandra.db.composites.Composite,%20org.apache.cassandra.db.ColumnFamily,%20org.apache.cassandra.cql3.statements.CQL3CasConditions,%20org.apache.cassandra.cql3.QueryOptions,%20long)">addUpdatesAndConditions</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#buildCasResultSet(java.lang.String,%20java.nio.ByteBuffer,%20java.lang.String,%20org.apache.cassandra.db.ColumnFamily,%20java.lang.Iterable,%20boolean,%20org.apache.cassandra.cql3.QueryOptions)">buildCasResultSet</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#buildPartitionKeyNames(org.apache.cassandra.cql3.QueryOptions)">buildPartitionKeyNames</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#checkAccess(org.apache.cassandra.service.ClientState)">checkAccess</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#columnFamily()">columnFamily</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#createClusteringPrefix(org.apache.cassandra.cql3.QueryOptions)">createClusteringPrefix</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#execute(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">execute</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#executeInternal(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">executeInternal</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#executeWithCondition(org.apache.cassandra.service.QueryState,%20org.apache.cassandra.cql3.QueryOptions)">executeWithCondition</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#getBoundTerms()">getBoundTerms</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#getColumnsWithConditions()">getColumnsWithConditions</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#getFirstEmptyKey()">getFirstEmptyKey</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#getOperations()">getOperations</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#getTimestamp(long,%20org.apache.cassandra.cql3.QueryOptions)">getTimestamp</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#getTimeToLive(org.apache.cassandra.cql3.QueryOptions)">getTimeToLive</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#hasConditions()">hasConditions</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#hasIfExistCondition()">hasIfExistCondition</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#hasIfNotExistCondition()">hasIfNotExistCondition</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#isCounter()">isCounter</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#isTimestampSet()">isTimestampSet</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#keyspace()">keyspace</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#makeUpdateParameters(java.util.Collection,%20org.apache.cassandra.db.composites.Composite,%20org.apache.cassandra.cql3.QueryOptions,%20boolean,%20long)">makeUpdateParameters</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#measureForPreparedCache(org.github.jamm.MemoryMeter)">measureForPreparedCache</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#processWhereClause(java.util.List,%20org.apache.cassandra.cql3.VariableSpecifications)">processWhereClause</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#readRequiredRows(java.util.Collection,%20org.apache.cassandra.db.composites.Composite,%20boolean,%20org.apache.cassandra.db.ConsistencyLevel)">readRequiredRows</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#readRows(java.util.Collection,%20org.apache.cassandra.db.composites.Composite,%20org.apache.cassandra.config.CFMetaData,%20boolean,%20org.apache.cassandra.db.ConsistencyLevel)">readRows</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#requiresRead()">requiresRead</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#setIfExistCondition()">setIfExistCondition</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#setIfNotExistCondition()">setIfNotExistCondition</a>, <a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#validate(org.apache.cassandra.service.ClientState)">validate</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&nbsp;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"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="requireFullClusteringKey()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>requireFullClusteringKey</h4> <pre>public&nbsp;boolean&nbsp;requireFullClusteringKey()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#requireFullClusteringKey()">requireFullClusteringKey</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html" title="class in org.apache.cassandra.cql3.statements">ModificationStatement</a></code></dd> </dl> </li> </ul> <a name="addUpdateForKey(org.apache.cassandra.db.ColumnFamily, java.nio.ByteBuffer, org.apache.cassandra.db.composites.Composite, org.apache.cassandra.cql3.UpdateParameters)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>addUpdateForKey</h4> <pre>public&nbsp;void&nbsp;addUpdateForKey(<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a>&nbsp;cf, java.nio.ByteBuffer&nbsp;key, <a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a>&nbsp;prefix, <a href="../../../../../org/apache/cassandra/cql3/UpdateParameters.html" title="class in org.apache.cassandra.cql3">UpdateParameters</a>&nbsp;params) throws <a href="../../../../../org/apache/cassandra/exceptions/InvalidRequestException.html" title="class in org.apache.cassandra.exceptions">InvalidRequestException</a></pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html#addUpdateForKey(org.apache.cassandra.db.ColumnFamily,%20java.nio.ByteBuffer,%20org.apache.cassandra.db.composites.Composite,%20org.apache.cassandra.cql3.UpdateParameters)">addUpdateForKey</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/cql3/statements/ModificationStatement.html" title="class in org.apache.cassandra.cql3.statements">ModificationStatement</a></code></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></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/cql3/statements/CreateUserStatement.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/cql3/statements/DeleteStatement.Parsed.html" title="class in org.apache.cassandra.cql3.statements"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/cql3/statements/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:&nbsp;</li> <li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.cql3.statements.ModificationStatement">Field</a>&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li>Constr&nbsp;|&nbsp;</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 &copy; 2014 The Apache Software Foundation</small></p> </body> </html>