UNPKG

cassandra-server

Version:

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

428 lines (427 loc) 21.1 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>UpdateParameters (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="UpdateParameters (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/UpdateParameters.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/UntypedResultSet.Row.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql3/UserOptions.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/UpdateParameters.html" target="_top">Frames</a></li> <li><a href="UpdateParameters.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>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&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</div> <h2 title="Class UpdateParameters" class="title">Class UpdateParameters</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cql3.UpdateParameters</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">UpdateParameters</span> extends java.lang.Object</pre> <div class="block">A simple container that simplify passing parameters for collections methods.</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> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#localDeletionTime">localDeletionTime</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#metadata">metadata</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#options">options</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#timestamp">timestamp</a></strong></code>&nbsp;</td> </tr> </table> </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">&nbsp;</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/cql3/UpdateParameters.html#UpdateParameters(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.cql3.QueryOptions,%20long,%20int,%20java.util.Map)">UpdateParameters</a></strong>(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>&nbsp;metadata, <a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a>&nbsp;options, long&nbsp;timestamp, int&nbsp;ttl, java.util.Map&lt;java.nio.ByteBuffer,<a href="../../../../org/apache/cassandra/cql3/CQL3Row.html" title="interface in org.apache.cassandra.cql3">CQL3Row</a>&gt;&nbsp;prefetchedLists)</code>&nbsp;</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">&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>java.util.List&lt;<a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#getPrefetchedList(java.nio.ByteBuffer,%20org.apache.cassandra.cql3.ColumnIdentifier)">getPrefetchedList</a></strong>(java.nio.ByteBuffer&nbsp;rowKey, <a href="../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>&nbsp;cql3ColumnName)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#makeColumn(org.apache.cassandra.db.composites.CellName,%20java.nio.ByteBuffer)">makeColumn</a></strong>(<a href="../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>&nbsp;name, java.nio.ByteBuffer&nbsp;value)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#makeCounter(org.apache.cassandra.db.composites.CellName,%20long)">makeCounter</a></strong>(<a href="../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>&nbsp;name, long&nbsp;delta)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/RangeTombstone.html" title="class in org.apache.cassandra.db">RangeTombstone</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#makeRangeTombstone(org.apache.cassandra.db.filter.ColumnSlice)">makeRangeTombstone</a></strong>(<a href="../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a>&nbsp;slice)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#makeTombstone(org.apache.cassandra.db.composites.CellName)">makeTombstone</a></strong>(<a href="../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>&nbsp;name)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/RangeTombstone.html" title="class in org.apache.cassandra.db">RangeTombstone</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cql3/UpdateParameters.html#makeTombstoneForOverwrite(org.apache.cassandra.db.filter.ColumnSlice)">makeTombstoneForOverwrite</a></strong>(<a href="../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a>&nbsp;slice)</code>&nbsp;</td> </tr> </table> <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"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="metadata"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>metadata</h4> <pre>public final&nbsp;<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metadata</pre> </li> </ul> <a name="options"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>options</h4> <pre>public final&nbsp;<a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a> options</pre> </li> </ul> <a name="timestamp"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>timestamp</h4> <pre>public final&nbsp;long timestamp</pre> </li> </ul> <a name="localDeletionTime"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>localDeletionTime</h4> <pre>public final&nbsp;int localDeletionTime</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="UpdateParameters(org.apache.cassandra.config.CFMetaData, org.apache.cassandra.cql3.QueryOptions, long, int, java.util.Map)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>UpdateParameters</h4> <pre>public&nbsp;UpdateParameters(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>&nbsp;metadata, <a href="../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a>&nbsp;options, long&nbsp;timestamp, int&nbsp;ttl, java.util.Map&lt;java.nio.ByteBuffer,<a href="../../../../org/apache/cassandra/cql3/CQL3Row.html" title="interface in org.apache.cassandra.cql3">CQL3Row</a>&gt;&nbsp;prefetchedLists)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="makeColumn(org.apache.cassandra.db.composites.CellName, java.nio.ByteBuffer)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>makeColumn</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>&nbsp;makeColumn(<a href="../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>&nbsp;name, java.nio.ByteBuffer&nbsp;value) 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="makeCounter(org.apache.cassandra.db.composites.CellName, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>makeCounter</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>&nbsp;makeCounter(<a href="../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>&nbsp;name, long&nbsp;delta) 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="makeTombstone(org.apache.cassandra.db.composites.CellName)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>makeTombstone</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>&nbsp;makeTombstone(<a href="../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>&nbsp;name) 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="makeRangeTombstone(org.apache.cassandra.db.filter.ColumnSlice)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>makeRangeTombstone</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/db/RangeTombstone.html" title="class in org.apache.cassandra.db">RangeTombstone</a>&nbsp;makeRangeTombstone(<a href="../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a>&nbsp;slice) 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="makeTombstoneForOverwrite(org.apache.cassandra.db.filter.ColumnSlice)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>makeTombstoneForOverwrite</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/db/RangeTombstone.html" title="class in org.apache.cassandra.db">RangeTombstone</a>&nbsp;makeTombstoneForOverwrite(<a href="../../../../org/apache/cassandra/db/filter/ColumnSlice.html" title="class in org.apache.cassandra.db.filter">ColumnSlice</a>&nbsp;slice) 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="getPrefetchedList(java.nio.ByteBuffer, org.apache.cassandra.cql3.ColumnIdentifier)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getPrefetchedList</h4> <pre>public&nbsp;java.util.List&lt;<a href="../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>&gt;&nbsp;getPrefetchedList(java.nio.ByteBuffer&nbsp;rowKey, <a href="../../../../org/apache/cassandra/cql3/ColumnIdentifier.html" title="class in org.apache.cassandra.cql3">ColumnIdentifier</a>&nbsp;cql3ColumnName)</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/UpdateParameters.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/UntypedResultSet.Row.html" title="class in org.apache.cassandra.cql3"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cql3/UserOptions.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/UpdateParameters.html" target="_top">Frames</a></li> <li><a href="UpdateParameters.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>Nested&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&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>