UNPKG

cassandra-server

Version:

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

397 lines (396 loc) 19.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:32 CEST 2014 --> <title>QueryMessage (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="QueryMessage (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/QueryMessage.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/transport/messages/PrepareMessage.html" title="class in org.apache.cassandra.transport.messages"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/transport/messages/ReadyMessage.html" title="class in org.apache.cassandra.transport.messages"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/transport/messages/QueryMessage.html" target="_top">Frames</a></li> <li><a href="QueryMessage.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_classes_inherited_from_class_org.apache.cassandra.transport.Message">Nested</a>&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.transport.messages</div> <h2 title="Class QueryMessage" class="title">Class QueryMessage</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/transport/Message.html" title="class in org.apache.cassandra.transport">org.apache.cassandra.transport.Message</a></li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/transport/Message.Request.html" title="class in org.apache.cassandra.transport">org.apache.cassandra.transport.Message.Request</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.transport.messages.QueryMessage</li> </ul> </li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">QueryMessage</span> extends <a href="../../../../../org/apache/cassandra/transport/Message.Request.html" title="class in org.apache.cassandra.transport">Message.Request</a></pre> <div class="block">A CQL query</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> <ul class="blockList"> <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.cassandra.transport.Message"> <!-- --> </a> <h3>Nested classes/interfaces inherited from class&nbsp;org.apache.cassandra.transport.<a href="../../../../../org/apache/cassandra/transport/Message.html" title="class in org.apache.cassandra.transport">Message</a></h3> <code><a href="../../../../../org/apache/cassandra/transport/Message.Codec.html" title="interface in org.apache.cassandra.transport">Message.Codec</a>&lt;<a href="../../../../../org/apache/cassandra/transport/Message.Codec.html" title="type parameter in Message.Codec">M</a> extends <a href="../../../../../org/apache/cassandra/transport/Message.html" title="class in org.apache.cassandra.transport">Message</a>&gt;, <a href="../../../../../org/apache/cassandra/transport/Message.Direction.html" title="enum in org.apache.cassandra.transport">Message.Direction</a>, <a href="../../../../../org/apache/cassandra/transport/Message.Dispatcher.html" title="class in org.apache.cassandra.transport">Message.Dispatcher</a>, <a href="../../../../../org/apache/cassandra/transport/Message.ProtocolDecoder.html" title="class in org.apache.cassandra.transport">Message.ProtocolDecoder</a>, <a href="../../../../../org/apache/cassandra/transport/Message.ProtocolEncoder.html" title="class in org.apache.cassandra.transport">Message.ProtocolEncoder</a>, <a href="../../../../../org/apache/cassandra/transport/Message.Request.html" title="class in org.apache.cassandra.transport">Message.Request</a>, <a href="../../../../../org/apache/cassandra/transport/Message.Response.html" title="class in org.apache.cassandra.transport">Message.Response</a>, <a href="../../../../../org/apache/cassandra/transport/Message.Type.html" title="enum in org.apache.cassandra.transport">Message.Type</a></code></li> </ul> </li> </ul> <!-- =========== 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>static <a href="../../../../../org/apache/cassandra/transport/Message.Codec.html" title="interface in org.apache.cassandra.transport">Message.Codec</a>&lt;<a href="../../../../../org/apache/cassandra/transport/messages/QueryMessage.html" title="class in org.apache.cassandra.transport.messages">QueryMessage</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/transport/messages/QueryMessage.html#codec">codec</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <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/transport/messages/QueryMessage.html#options">options</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/transport/messages/QueryMessage.html#query">query</a></strong></code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.transport.Message.Request"> <!-- --> </a> <h3>Fields inherited from class&nbsp;org.apache.cassandra.transport.<a href="../../../../../org/apache/cassandra/transport/Message.Request.html" title="class in org.apache.cassandra.transport">Message.Request</a></h3> <code><a href="../../../../../org/apache/cassandra/transport/Message.Request.html#tracingRequested">tracingRequested</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.transport.Message"> <!-- --> </a> <h3>Fields inherited from class&nbsp;org.apache.cassandra.transport.<a href="../../../../../org/apache/cassandra/transport/Message.html" title="class in org.apache.cassandra.transport">Message</a></h3> <code><a href="../../../../../org/apache/cassandra/transport/Message.html#connection">connection</a>, <a href="../../../../../org/apache/cassandra/transport/Message.html#logger">logger</a>, <a href="../../../../../org/apache/cassandra/transport/Message.html#type">type</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">&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/transport/messages/QueryMessage.html#QueryMessage(java.lang.String,%20org.apache.cassandra.cql3.QueryOptions)">QueryMessage</a></strong>(java.lang.String&nbsp;query, <a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a>&nbsp;options)</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><a href="../../../../../org/apache/cassandra/transport/Message.Response.html" title="class in org.apache.cassandra.transport">Message.Response</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/transport/messages/QueryMessage.html#execute(org.apache.cassandra.service.QueryState)">execute</a></strong>(<a href="../../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a>&nbsp;state)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/transport/messages/QueryMessage.html#toString()">toString</a></strong>()</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.transport.Message.Request"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.transport.<a href="../../../../../org/apache/cassandra/transport/Message.Request.html" title="class in org.apache.cassandra.transport">Message.Request</a></h3> <code><a href="../../../../../org/apache/cassandra/transport/Message.Request.html#isTracingRequested()">isTracingRequested</a>, <a href="../../../../../org/apache/cassandra/transport/Message.Request.html#setTracingRequested()">setTracingRequested</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.transport.Message"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.transport.<a href="../../../../../org/apache/cassandra/transport/Message.html" title="class in org.apache.cassandra.transport">Message</a></h3> <code><a href="../../../../../org/apache/cassandra/transport/Message.html#attach(org.apache.cassandra.transport.Connection)">attach</a>, <a href="../../../../../org/apache/cassandra/transport/Message.html#connection()">connection</a>, <a href="../../../../../org/apache/cassandra/transport/Message.html#getSourceFrame()">getSourceFrame</a>, <a href="../../../../../org/apache/cassandra/transport/Message.html#getStreamId()">getStreamId</a>, <a href="../../../../../org/apache/cassandra/transport/Message.html#setSourceFrame(org.apache.cassandra.transport.Frame)">setSourceFrame</a>, <a href="../../../../../org/apache/cassandra/transport/Message.html#setStreamId(int)">setStreamId</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, 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="codec"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>codec</h4> <pre>public static final&nbsp;<a href="../../../../../org/apache/cassandra/transport/Message.Codec.html" title="interface in org.apache.cassandra.transport">Message.Codec</a>&lt;<a href="../../../../../org/apache/cassandra/transport/messages/QueryMessage.html" title="class in org.apache.cassandra.transport.messages">QueryMessage</a>&gt; codec</pre> </li> </ul> <a name="query"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>query</h4> <pre>public final&nbsp;java.lang.String query</pre> </li> </ul> <a name="options"> <!-- --> </a> <ul class="blockListLast"> <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> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="QueryMessage(java.lang.String, org.apache.cassandra.cql3.QueryOptions)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>QueryMessage</h4> <pre>public&nbsp;QueryMessage(java.lang.String&nbsp;query, <a href="../../../../../org/apache/cassandra/cql3/QueryOptions.html" title="class in org.apache.cassandra.cql3">QueryOptions</a>&nbsp;options)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="execute(org.apache.cassandra.service.QueryState)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>execute</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/transport/Message.Response.html" title="class in org.apache.cassandra.transport">Message.Response</a>&nbsp;execute(<a href="../../../../../org/apache/cassandra/service/QueryState.html" title="class in org.apache.cassandra.service">QueryState</a>&nbsp;state)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/transport/Message.Request.html#execute(org.apache.cassandra.service.QueryState)">execute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/transport/Message.Request.html" title="class in org.apache.cassandra.transport">Message.Request</a></code></dd> </dl> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<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/QueryMessage.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/transport/messages/PrepareMessage.html" title="class in org.apache.cassandra.transport.messages"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/transport/messages/ReadyMessage.html" title="class in org.apache.cassandra.transport.messages"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/transport/messages/QueryMessage.html" target="_top">Frames</a></li> <li><a href="QueryMessage.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_classes_inherited_from_class_org.apache.cassandra.transport.Message">Nested</a>&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>