cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>CqlRecordReader (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"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/CqlRecordReader.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/hadoop/cql3/CqlOutputFormat.html" title="class in org.apache.cassandra.hadoop.cql3"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/hadoop/cql3/CqlRecordReader.html" target="_top">Frames</a></li> <li><a href="CqlRecordReader.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field_summary">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><a href="#field_detail">Field</a> | </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>   <div class="header"> <div class="subTitle">org.apache.cassandra.hadoop.cql3</div> <h2 title="Class CqlRecordReader" class="title">Class CqlRecordReader</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.hadoop.mapreduce.RecordReader<java.lang.Long,com.datastax.driver.core.Row></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.hadoop.cql3.CqlRecordReader</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.mapred.RecordReader<java.lang.Long,com.datastax.driver.core.Row></dd> </dl> <hr> <br> <pre>public class <span class="strong">CqlRecordReader</span> extends org.apache.hadoop.mapreduce.RecordReader<java.lang.Long,com.datastax.driver.core.Row> implements org.apache.hadoop.mapred.RecordReader<java.lang.Long,com.datastax.driver.core.Row></pre> <div class="block">CqlRecordReader reads the rows return from the CQL query It uses CQL auto-paging. <p/> Return a Long as a local CQL row key starts from 0; <p/> Row as C* java driver CQL result set row 1) select clause must include partition key columns (to calculate the progress based on the actual CF row processed) 2) where clause must include token(partition_key1, ... , partition_keyn) > ? and token(partition_key1, ... , partition_keyn) <= ? (in the right order)</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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"> </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 int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#DEFAULT_CQL_PAGE_LIMIT">DEFAULT_CQL_PAGE_LIMIT</a></strong></code> </td> </tr> </table> </li> </ul>  <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/hadoop/cql3/CqlRecordReader.html#CqlRecordReader()">CqlRecordReader</a></strong>()</code> </td> </tr> </table> </li> </ul>  <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/hadoop/cql3/CqlRecordReader.html#close()">close</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.Long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#createKey()">createKey</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>com.datastax.driver.core.Row</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#createValue()">createValue</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.Long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#getCurrentKey()">getCurrentKey</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>com.datastax.driver.core.Row</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#getCurrentValue()">getCurrentValue</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#getPos()">getPos</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>float</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#getProgress()">getProgress</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#initialize(org.apache.hadoop.mapreduce.InputSplit,%20org.apache.hadoop.mapreduce.TaskAttemptContext)">initialize</a></strong>(org.apache.hadoop.mapreduce.InputSplit split, org.apache.hadoop.mapreduce.TaskAttemptContext context)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#next(java.lang.Long,%20com.datastax.driver.core.Row)">next</a></strong>(java.lang.Long key, com.datastax.driver.core.Row value)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html#nextKeyValue()">nextKeyValue</a></strong>()</code> </td> </tr> </table> <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, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="DEFAULT_CQL_PAGE_LIMIT">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>DEFAULT_CQL_PAGE_LIMIT</h4> <pre>public static final int DEFAULT_CQL_PAGE_LIMIT</pre> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.hadoop.cql3.CqlRecordReader.DEFAULT_CQL_PAGE_LIMIT">Constant Field Values</a></dd></dl> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="CqlRecordReader()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>CqlRecordReader</h4> <pre>public CqlRecordReader()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="initialize(org.apache.hadoop.mapreduce.InputSplit, org.apache.hadoop.mapreduce.TaskAttemptContext)">  </a> <ul class="blockList"> <li class="blockList"> <h4>initialize</h4> <pre>public void initialize(org.apache.hadoop.mapreduce.InputSplit split, org.apache.hadoop.mapreduce.TaskAttemptContext context) throws java.io.IOException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>initialize</code> in class <code>org.apache.hadoop.mapreduce.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="close()">  </a> <ul class="blockList"> <li class="blockList"> <h4>close</h4> <pre>public void close()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>close</code> in interface <code>java.io.Closeable</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code>close</code> in interface <code>org.apache.hadoop.mapred.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> <dt><strong>Specified by:</strong></dt> <dd><code>close</code> in class <code>org.apache.hadoop.mapreduce.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> </dl> </li> </ul> <a name="getCurrentKey()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCurrentKey</h4> <pre>public java.lang.Long getCurrentKey()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>getCurrentKey</code> in class <code>org.apache.hadoop.mapreduce.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> </dl> </li> </ul> <a name="getCurrentValue()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCurrentValue</h4> <pre>public com.datastax.driver.core.Row getCurrentValue()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>getCurrentValue</code> in class <code>org.apache.hadoop.mapreduce.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> </dl> </li> </ul> <a name="getProgress()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getProgress</h4> <pre>public float getProgress()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>getProgress</code> in interface <code>org.apache.hadoop.mapred.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> <dt><strong>Specified by:</strong></dt> <dd><code>getProgress</code> in class <code>org.apache.hadoop.mapreduce.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> </dl> </li> </ul> <a name="nextKeyValue()">  </a> <ul class="blockList"> <li class="blockList"> <h4>nextKeyValue</h4> <pre>public boolean nextKeyValue() throws java.io.IOException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>nextKeyValue</code> in class <code>org.apache.hadoop.mapreduce.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="next(java.lang.Long, com.datastax.driver.core.Row)">  </a> <ul class="blockList"> <li class="blockList"> <h4>next</h4> <pre>public boolean next(java.lang.Long key, com.datastax.driver.core.Row value) throws java.io.IOException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>next</code> in interface <code>org.apache.hadoop.mapred.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="getPos()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getPos</h4> <pre>public long getPos() throws java.io.IOException</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>getPos</code> in interface <code>org.apache.hadoop.mapred.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code></dd></dl> </li> </ul> <a name="createKey()">  </a> <ul class="blockList"> <li class="blockList"> <h4>createKey</h4> <pre>public java.lang.Long createKey()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>createKey</code> in interface <code>org.apache.hadoop.mapred.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> </dl> </li> </ul> <a name="createValue()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>createValue</h4> <pre>public com.datastax.driver.core.Row createValue()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>createValue</code> in interface <code>org.apache.hadoop.mapred.RecordReader<java.lang.Long,com.datastax.driver.core.Row></code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/CqlRecordReader.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/hadoop/cql3/CqlOutputFormat.html" title="class in org.apache.cassandra.hadoop.cql3"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/hadoop/cql3/CqlRecordReader.html" target="_top">Frames</a></li> <li><a href="CqlRecordReader.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field_summary">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><a href="#field_detail">Field</a> | </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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>