cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
485 lines (483 loc) • 19.6 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:35 CEST 2014 -->
<title>AbstractColumnFamilyRecordWriter (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="AbstractColumnFamilyRecordWriter (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/AbstractColumnFamilyRecordWriter.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/AbstractColumnFamilyOutputFormat.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html" target="_top">Frames</a></li>
<li><a href="AbstractColumnFamilyRecordWriter.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><a href="#nested_class_summary">Nested</a> | </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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.hadoop</div>
<h2 title="Class AbstractColumnFamilyRecordWriter" class="title">Class AbstractColumnFamilyRecordWriter<K,Y></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.mapreduce.RecordWriter<K,Y></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.hadoop.AbstractColumnFamilyRecordWriter<K,Y></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.hadoop.mapred.RecordWriter<K,Y></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractColumnFamilyRecordWriter<K,Y></span>
extends org.apache.hadoop.mapreduce.RecordWriter<K,Y>
implements org.apache.hadoop.mapred.RecordWriter<K,Y></pre>
<div class="block">The <code>ColumnFamilyRecordWriter</code> maps the output <key, value>
pairs to a Cassandra column family. In particular, it applies all mutations
in the value, which it associates with the key, and in turn the responsible
endpoint.
<p>
Furthermore, this writer groups the mutations by the endpoint responsible for
the rows being affected. This allows the mutations to be executed in parallel,
directly to a responsible endpoint.
</p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/cassandra/hadoop/ColumnFamilyOutputFormat.html" title="class in org.apache.cassandra.hadoop"><code>ColumnFamilyOutputFormat</code></a></dd></dl>
</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"> </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>class </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="class in org.apache.cassandra.hadoop">AbstractColumnFamilyRecordWriter.AbstractRangeClient</a><<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="type parameter in AbstractColumnFamilyRecordWriter.AbstractRangeClient">K</a>></strong></code>
<div class="block">A client that runs in a threadpool and connects to the list of endpoints for a particular
range.</div>
</td>
</tr>
</table>
</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"> </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>protected long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#batchThreshold">batchThreshold</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.hadoop.conf.Configuration</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#conf">conf</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/thrift/ConsistencyLevel.html" title="enum in org.apache.cassandra.thrift">ConsistencyLevel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#consistencyLevel">consistencyLevel</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.hadoop.mapreduce.TaskAttemptContext</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#context">context</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.apache.hadoop.util.Progressable</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#progressable">progressable</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#queueSize">queueSize</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/client/RingCache.html" title="class in org.apache.cassandra.client">RingCache</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#ringCache">ringCache</a></strong></code> </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"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#AbstractColumnFamilyRecordWriter(org.apache.hadoop.conf.Configuration)">AbstractColumnFamilyRecordWriter</a></strong>(org.apache.hadoop.conf.Configuration conf)</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>protected abstract void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#close()">close</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/AbstractColumnFamilyRecordWriter.html#close(org.apache.hadoop.mapred.Reporter)">close</a></strong>(org.apache.hadoop.mapred.Reporter reporter)</code>
<div class="block"><strong>Deprecated.</strong> </div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html#close(org.apache.hadoop.mapreduce.TaskAttemptContext)">close</a></strong>(org.apache.hadoop.mapreduce.TaskAttemptContext context)</code>
<div class="block">Close this <code>RecordWriter</code> to future operations, but not before
flushing out the batched mutations.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.mapreduce.RecordWriter">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.hadoop.mapreduce.RecordWriter</h3>
<code>write</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, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.hadoop.mapred.RecordWriter">
<!-- -->
</a>
<h3>Methods inherited from interface org.apache.hadoop.mapred.RecordWriter</h3>
<code>write</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="conf">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>conf</h4>
<pre>protected final org.apache.hadoop.conf.Configuration conf</pre>
</li>
</ul>
<a name="ringCache">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ringCache</h4>
<pre>protected final <a href="../../../../org/apache/cassandra/client/RingCache.html" title="class in org.apache.cassandra.client">RingCache</a> ringCache</pre>
</li>
</ul>
<a name="queueSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queueSize</h4>
<pre>protected final int queueSize</pre>
</li>
</ul>
<a name="batchThreshold">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>batchThreshold</h4>
<pre>protected final long batchThreshold</pre>
</li>
</ul>
<a name="consistencyLevel">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>consistencyLevel</h4>
<pre>protected final <a href="../../../../org/apache/cassandra/thrift/ConsistencyLevel.html" title="enum in org.apache.cassandra.thrift">ConsistencyLevel</a> consistencyLevel</pre>
</li>
</ul>
<a name="progressable">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>progressable</h4>
<pre>protected org.apache.hadoop.util.Progressable progressable</pre>
</li>
</ul>
<a name="context">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>context</h4>
<pre>protected org.apache.hadoop.mapreduce.TaskAttemptContext context</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractColumnFamilyRecordWriter(org.apache.hadoop.conf.Configuration)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractColumnFamilyRecordWriter</h4>
<pre>protected AbstractColumnFamilyRecordWriter(org.apache.hadoop.conf.Configuration conf)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close(org.apache.hadoop.mapreduce.TaskAttemptContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close(org.apache.hadoop.mapreduce.TaskAttemptContext context)
throws java.io.IOException,
java.lang.InterruptedException</pre>
<div class="block">Close this <code>RecordWriter</code> to future operations, but not before
flushing out the batched mutations.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in class <code>org.apache.hadoop.mapreduce.RecordWriter<<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html" title="type parameter in AbstractColumnFamilyRecordWriter">K</a>,<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html" title="type parameter in AbstractColumnFamilyRecordWriter">Y</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the context of the task</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>java.lang.InterruptedException</code></dd></dl>
</li>
</ul>
<a name="close(org.apache.hadoop.mapred.Reporter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>@Deprecated
public void close(org.apache.hadoop.mapred.Reporter reporter)
throws java.io.IOException</pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Fills the deprecated RecordWriter interface for streaming.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code> in interface <code>org.apache.hadoop.mapred.RecordWriter<<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html" title="type parameter in AbstractColumnFamilyRecordWriter">K</a>,<a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html" title="type parameter in AbstractColumnFamilyRecordWriter">Y</a>></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="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>protected abstract void close()
throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</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/AbstractColumnFamilyRecordWriter.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/AbstractColumnFamilyOutputFormat.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.AbstractRangeClient.html" title="class in org.apache.cassandra.hadoop"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/hadoop/AbstractColumnFamilyRecordWriter.html" target="_top">Frames</a></li>
<li><a href="AbstractColumnFamilyRecordWriter.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><a href="#nested_class_summary">Nested</a> | </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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>