cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
357 lines (354 loc) • 17.1 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:29 CEST 2014 -->
<title>CqlOutputFormat (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="CqlOutputFormat (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/CqlOutputFormat.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/CqlInputFormat.html" title="class in org.apache.cassandra.hadoop.cql3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html" title="class in org.apache.cassandra.hadoop.cql3"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/hadoop/cql3/CqlOutputFormat.html" target="_top">Frames</a></li>
<li><a href="CqlOutputFormat.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>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.cassandra.hadoop.AbstractColumnFamilyOutputFormat">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>Field | </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.cql3</div>
<h2 title="Class CqlOutputFormat" class="title">Class CqlOutputFormat</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.mapreduce.OutputFormat<K,Y></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html" title="class in org.apache.cassandra.hadoop">org.apache.cassandra.hadoop.AbstractColumnFamilyOutputFormat</a><java.util.Map<java.lang.String,java.nio.ByteBuffer>,java.util.List<java.nio.ByteBuffer>></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.hadoop.cql3.CqlOutputFormat</li>
</ul>
</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.OutputFormat<java.util.Map<java.lang.String,java.nio.ByteBuffer>,java.util.List<java.nio.ByteBuffer>></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">CqlOutputFormat</span>
extends <a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html" title="class in org.apache.cassandra.hadoop">AbstractColumnFamilyOutputFormat</a><java.util.Map<java.lang.String,java.nio.ByteBuffer>,java.util.List<java.nio.ByteBuffer>></pre>
<div class="block">The <code>ColumnFamilyOutputFormat</code> acts as a Hadoop-specific
OutputFormat that allows reduce tasks to store keys (and corresponding
binded variable values) as CQL rows (and respective columns) in a given
ColumnFamily.
<p>
As is the case with the <a href="../../../../../org/apache/cassandra/hadoop/ColumnFamilyInputFormat.html" title="class in org.apache.cassandra.hadoop"><code>ColumnFamilyInputFormat</code></a>,
you need to set the prepared statement in your
Hadoop job Configuration. The <a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlConfigHelper.html" title="class in org.apache.cassandra.hadoop.cql3"><code>CqlConfigHelper</code></a> class, through its
<a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlConfigHelper.html#setOutputCql(org.apache.hadoop.conf.Configuration,%20java.lang.String)"><code>CqlConfigHelper.setOutputCql(org.apache.hadoop.conf.Configuration, java.lang.String)</code></a> method, is provided to make this
simple.
you need to set the Keyspace. The <a href="../../../../../org/apache/cassandra/hadoop/ConfigHelper.html" title="class in org.apache.cassandra.hadoop"><code>ConfigHelper</code></a> class, through its
<a href="../../../../../org/apache/cassandra/hadoop/ConfigHelper.html#setOutputColumnFamily(org.apache.hadoop.conf.Configuration,%20java.lang.String)"><code>ConfigHelper.setOutputColumnFamily(org.apache.hadoop.conf.Configuration, java.lang.String)</code></a> method, is provided to make this
simple.
</p>
<p>
For the sake of performance, this class employs a lazy write-back caching
mechanism, where its record writer prepared statement binded variable values
created based on the reduce's inputs (in a task-specific map), and periodically
makes the changes official by sending a execution of prepared statement request
to Cassandra.
</p></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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.hadoop.AbstractColumnFamilyOutputFormat">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.cassandra.hadoop.<a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html" title="class in org.apache.cassandra.hadoop">AbstractColumnFamilyOutputFormat</a></h3>
<code><a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html#BATCH_THRESHOLD">BATCH_THRESHOLD</a>, <a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html#QUEUE_SIZE">QUEUE_SIZE</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"> </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/CqlOutputFormat.html#CqlOutputFormat()">CqlOutputFormat</a></strong>()</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>org.apache.cassandra.hadoop.cql3.CqlRecordWriter</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlOutputFormat.html#getRecordWriter(org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.mapred.JobConf,%20java.lang.String,%20org.apache.hadoop.util.Progressable)">getRecordWriter</a></strong>(org.apache.hadoop.fs.FileSystem filesystem,
org.apache.hadoop.mapred.JobConf job,
java.lang.String name,
org.apache.hadoop.util.Progressable progress)</code>
<div class="block"><strong>Deprecated.</strong> </div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.apache.cassandra.hadoop.cql3.CqlRecordWriter</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlOutputFormat.html#getRecordWriter(org.apache.hadoop.mapreduce.TaskAttemptContext)">getRecordWriter</a></strong>(org.apache.hadoop.mapreduce.TaskAttemptContext context)</code>
<div class="block">Get the <code>RecordWriter</code> for the given task.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.hadoop.AbstractColumnFamilyOutputFormat">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.cassandra.hadoop.<a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html" title="class in org.apache.cassandra.hadoop">AbstractColumnFamilyOutputFormat</a></h3>
<code><a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html#checkOutputSpecs(org.apache.hadoop.conf.Configuration)">checkOutputSpecs</a>, <a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html#checkOutputSpecs(org.apache.hadoop.fs.FileSystem,%20org.apache.hadoop.mapred.JobConf)">checkOutputSpecs</a>, <a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html#checkOutputSpecs(org.apache.hadoop.mapreduce.JobContext)">checkOutputSpecs</a>, <a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html#createAuthenticatedClient(java.lang.String,%20int,%20org.apache.hadoop.conf.Configuration)">createAuthenticatedClient</a>, <a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html#getOutputCommitter(org.apache.hadoop.mapreduce.TaskAttemptContext)">getOutputCommitter</a>, <a href="../../../../../org/apache/cassandra/hadoop/AbstractColumnFamilyOutputFormat.html#login(java.lang.String,%20java.lang.String,%20org.apache.cassandra.thrift.Cassandra.Client)">login</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 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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CqlOutputFormat()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CqlOutputFormat</h4>
<pre>public CqlOutputFormat()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRecordWriter(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.mapred.JobConf, java.lang.String, org.apache.hadoop.util.Progressable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordWriter</h4>
<pre>@Deprecated
public org.apache.cassandra.hadoop.cql3.CqlRecordWriter getRecordWriter(org.apache.hadoop.fs.FileSystem filesystem,
org.apache.hadoop.mapred.JobConf job,
java.lang.String name,
org.apache.hadoop.util.Progressable progress)
throws java.io.IOException</pre>
<div class="block"><span class="strong">Deprecated.</span> </div>
<div class="block">Fills the deprecated OutputFormat interface for streaming.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getRecordWriter(org.apache.hadoop.mapreduce.TaskAttemptContext)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRecordWriter</h4>
<pre>public org.apache.cassandra.hadoop.cql3.CqlRecordWriter getRecordWriter(org.apache.hadoop.mapreduce.TaskAttemptContext context)
throws java.io.IOException,
java.lang.InterruptedException</pre>
<div class="block">Get the <code>RecordWriter</code> for the given task.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getRecordWriter</code> in class <code>org.apache.hadoop.mapreduce.OutputFormat<java.util.Map<java.lang.String,java.nio.ByteBuffer>,java.util.List<java.nio.ByteBuffer>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - the information about the current task.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>RecordWriter</code> to write the output for the job.</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>
</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/CqlOutputFormat.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/CqlInputFormat.html" title="class in org.apache.cassandra.hadoop.cql3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/hadoop/cql3/CqlRecordReader.html" title="class in org.apache.cassandra.hadoop.cql3"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/hadoop/cql3/CqlOutputFormat.html" target="_top">Frames</a></li>
<li><a href="CqlOutputFormat.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>Nested | </li>
<li><a href="#fields_inherited_from_class_org.apache.cassandra.hadoop.AbstractColumnFamilyOutputFormat">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>Field | </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>