cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
369 lines (368 loc) • 19.9 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:31 CEST 2014 -->
<title>SSTableSimpleWriter (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="SSTableSimpleWriter (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/SSTableSimpleWriter.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/io/sstable/SSTableSimpleUnsortedWriter.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/SSTableSimpleWriter.html" target="_top">Frames</a></li>
<li><a href="SSTableSimpleWriter.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.io.sstable.AbstractSSTableSimpleWriter">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.io.sstable</div>
<h2 title="Class SSTableSimpleWriter" class="title">Class SSTableSimpleWriter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html" title="class in org.apache.cassandra.io.sstable">org.apache.cassandra.io.sstable.AbstractSSTableSimpleWriter</a></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.io.sstable.SSTableSimpleWriter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">SSTableSimpleWriter</span>
extends <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html" title="class in org.apache.cassandra.io.sstable">AbstractSSTableSimpleWriter</a></pre>
<div class="block">A SSTable writer that assumes rows are in (partitioner) sorted order.
Contrarily to SSTableSimpleUnsortedWriter, this writer does not buffer
anything into memory, however it assumes that row are added in sorted order
(an exception will be thrown otherwise), which for the RandomPartitioner
means that rows should be added by increasing md5 of the row key. This is
rarely possible and SSTableSimpleUnsortedWriter should most of the time be
prefered.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html" title="class in org.apache.cassandra.io.sstable"><code>AbstractSSTableSimpleWriter</code></a></dd></dl>
</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.io.sstable.AbstractSSTableSimpleWriter">
<!-- -->
</a>
<h3>Fields inherited from class org.apache.cassandra.io.sstable.<a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html" title="class in org.apache.cassandra.io.sstable">AbstractSSTableSimpleWriter</a></h3>
<code><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#columnFamily">columnFamily</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#counterid">counterid</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#currentKey">currentKey</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#currentSuperColumn">currentSuperColumn</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#directory">directory</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#metadata">metadata</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/io/sstable/SSTableSimpleWriter.html#SSTableSimpleWriter(java.io.File,%20org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.dht.IPartitioner)">SSTableSimpleWriter</a></strong>(java.io.File directory,
<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metadata,
<a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableSimpleWriter.html#SSTableSimpleWriter(java.io.File,%20org.apache.cassandra.dht.IPartitioner,%20java.lang.String,%20java.lang.String,%20org.apache.cassandra.db.marshal.AbstractType,%20org.apache.cassandra.db.marshal.AbstractType)">SSTableSimpleWriter</a></strong>(java.io.File directory,
<a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner,
java.lang.String keyspace,
java.lang.String columnFamily,
<a href="../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?> comparator,
<a href="../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?> subComparator)</code>
<div class="block">Create a new writer.</div>
</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableSimpleWriter.html#close()">close</a></strong>()</code>
<div class="block">Close this writer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableSimpleWriter.html#getColumnFamily()">getColumnFamily</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/SSTableSimpleWriter.html#writeRow(org.apache.cassandra.db.DecoratedKey,%20org.apache.cassandra.db.ColumnFamily)">writeRow</a></strong>(<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> columnFamily)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.io.sstable.AbstractSSTableSimpleWriter">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.cassandra.io.sstable.<a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html" title="class in org.apache.cassandra.io.sstable">AbstractSSTableSimpleWriter</a></h3>
<code><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#addColumn(java.nio.ByteBuffer,%20java.nio.ByteBuffer,%20long)">addColumn</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#addCounterColumn(java.nio.ByteBuffer,%20long)">addCounterColumn</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#addExpiringColumn(java.nio.ByteBuffer,%20java.nio.ByteBuffer,%20long,%20int,%20long)">addExpiringColumn</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#getWriter()">getWriter</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#makeFilename(java.io.File,%20java.lang.String,%20java.lang.String)">makeFilename</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#newRow(java.nio.ByteBuffer)">newRow</a>, <a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#newSuperColumn(java.nio.ByteBuffer)">newSuperColumn</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="SSTableSimpleWriter(java.io.File, org.apache.cassandra.dht.IPartitioner, java.lang.String, java.lang.String, org.apache.cassandra.db.marshal.AbstractType, org.apache.cassandra.db.marshal.AbstractType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SSTableSimpleWriter</h4>
<pre>public SSTableSimpleWriter(java.io.File directory,
<a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner,
java.lang.String keyspace,
java.lang.String columnFamily,
<a href="../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?> comparator,
<a href="../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?> subComparator)</pre>
<div class="block">Create a new writer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>directory</code> - the directory where to write the sstable</dd><dd><code>partitioner</code> - the partitioner</dd><dd><code>keyspace</code> - the keyspace name</dd><dd><code>columnFamily</code> - the column family name</dd><dd><code>comparator</code> - the column family comparator</dd><dd><code>subComparator</code> - the column family subComparator or null if not a Super column family.</dd></dl>
</li>
</ul>
<a name="SSTableSimpleWriter(java.io.File, org.apache.cassandra.config.CFMetaData, org.apache.cassandra.dht.IPartitioner)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SSTableSimpleWriter</h4>
<pre>public SSTableSimpleWriter(java.io.File directory,
<a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> metadata,
<a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner)</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()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#close()">AbstractSSTableSimpleWriter</a></code></strong></div>
<div class="block">Close this writer.
This method should be called, otherwise the produced sstables are not
guaranteed to be complete (and won't be in practice).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#close()">close</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html" title="class in org.apache.cassandra.io.sstable">AbstractSSTableSimpleWriter</a></code></dd>
</dl>
</li>
</ul>
<a name="writeRow(org.apache.cassandra.db.DecoratedKey, org.apache.cassandra.db.ColumnFamily)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeRow</h4>
<pre>protected void writeRow(<a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> key,
<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> columnFamily)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#writeRow(org.apache.cassandra.db.DecoratedKey,%20org.apache.cassandra.db.ColumnFamily)">writeRow</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html" title="class in org.apache.cassandra.io.sstable">AbstractSSTableSimpleWriter</a></code></dd>
</dl>
</li>
</ul>
<a name="getColumnFamily()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getColumnFamily</h4>
<pre>protected <a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> getColumnFamily()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html#getColumnFamily()">getColumnFamily</a></code> in class <code><a href="../../../../../org/apache/cassandra/io/sstable/AbstractSSTableSimpleWriter.html" title="class in org.apache.cassandra.io.sstable">AbstractSSTableSimpleWriter</a></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/SSTableSimpleWriter.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/io/sstable/SSTableSimpleUnsortedWriter.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/SSTableSimpleWriter.html" target="_top">Frames</a></li>
<li><a href="SSTableSimpleWriter.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.io.sstable.AbstractSSTableSimpleWriter">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>