cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
363 lines (362 loc) • 15.9 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:27 CEST 2014 -->
<title>SSTableExport (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="SSTableExport (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/SSTableExport.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/tools/NodeTool.Version.html" title="class in org.apache.cassandra.tools"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/tools/SSTableImport.html" title="class in org.apache.cassandra.tools"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/tools/SSTableExport.html" target="_top">Frames</a></li>
<li><a href="SSTableExport.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>Field | </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.tools</div>
<h2 title="Class SSTableExport" class="title">Class SSTableExport</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.tools.SSTableExport</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">SSTableExport</span>
extends java.lang.Object</pre>
<div class="block">Export SSTables to JSON format.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/tools/SSTableExport.html#SSTableExport()">SSTableExport</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>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/SSTableExport.html#enumeratekeys(org.apache.cassandra.io.sstable.Descriptor,%20java.io.PrintStream)">enumeratekeys</a></strong>(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> desc,
java.io.PrintStream outs)</code>
<div class="block">Enumerate row keys from an SSTableReader and write the result to a PrintStream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/SSTableExport.html#export(org.apache.cassandra.io.sstable.Descriptor,%20java.io.PrintStream,%20java.util.Collection,%20java.lang.String[])">export</a></strong>(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> desc,
java.io.PrintStream outs,
java.util.Collection<java.lang.String> toExport,
java.lang.String[] excludes)</code>
<div class="block">Export specific rows from an SSTable and write the resulting JSON to a PrintStream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/SSTableExport.html#export(org.apache.cassandra.io.sstable.Descriptor,%20java.io.PrintStream,%20java.lang.String[])">export</a></strong>(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> desc,
java.io.PrintStream outs,
java.lang.String[] excludes)</code>
<div class="block">Export an SSTable and write the resulting JSON to a PrintStream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/SSTableExport.html#export(org.apache.cassandra.io.sstable.Descriptor,%20java.lang.String[])">export</a></strong>(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> desc,
java.lang.String[] excludes)</code>
<div class="block">Export an SSTable and write the resulting JSON to standard out.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/tools/SSTableExport.html#main(java.lang.String[])">main</a></strong>(java.lang.String[] args)</code>
<div class="block">Given arguments specifying an SSTable, and optionally an output file,
export the contents of the SSTable to JSON.</div>
</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SSTableExport()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SSTableExport</h4>
<pre>public SSTableExport()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="enumeratekeys(org.apache.cassandra.io.sstable.Descriptor, java.io.PrintStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enumeratekeys</h4>
<pre>public static void enumeratekeys(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> desc,
java.io.PrintStream outs)
throws java.io.IOException</pre>
<div class="block">Enumerate row keys from an SSTableReader and write the result to a PrintStream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desc</code> - the descriptor of the file to export the rows from</dd><dd><code>outs</code> - PrintStream to write the output to</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on failure to read/write input/output</dd></dl>
</li>
</ul>
<a name="export(org.apache.cassandra.io.sstable.Descriptor, java.io.PrintStream, java.util.Collection, java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>export</h4>
<pre>public static void export(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> desc,
java.io.PrintStream outs,
java.util.Collection<java.lang.String> toExport,
java.lang.String[] excludes)
throws java.io.IOException</pre>
<div class="block">Export specific rows from an SSTable and write the resulting JSON to a PrintStream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desc</code> - the descriptor of the sstable to read from</dd><dd><code>outs</code> - PrintStream to write the output to</dd><dd><code>toExport</code> - the keys corresponding to the rows to export</dd><dd><code>excludes</code> - keys to exclude from export</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on failure to read/write input/output</dd></dl>
</li>
</ul>
<a name="export(org.apache.cassandra.io.sstable.Descriptor, java.io.PrintStream, java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>export</h4>
<pre>public static void export(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> desc,
java.io.PrintStream outs,
java.lang.String[] excludes)
throws java.io.IOException</pre>
<div class="block">Export an SSTable and write the resulting JSON to a PrintStream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desc</code> - the descriptor of the sstable to read from</dd><dd><code>outs</code> - PrintStream to write the output to</dd><dd><code>excludes</code> - keys to exclude from export</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on failure to read/write input/output</dd></dl>
</li>
</ul>
<a name="export(org.apache.cassandra.io.sstable.Descriptor, java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>export</h4>
<pre>public static void export(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> desc,
java.lang.String[] excludes)
throws java.io.IOException</pre>
<div class="block">Export an SSTable and write the resulting JSON to standard out.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desc</code> - the descriptor of the sstable to read from</dd><dd><code>excludes</code> - keys to exclude from export</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on failure to read/write SSTable/standard out</dd></dl>
</li>
</ul>
<a name="main(java.lang.String[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static void main(java.lang.String[] args)
throws <a href="../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></pre>
<div class="block">Given arguments specifying an SSTable, and optionally an output file,
export the contents of the SSTable to JSON.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - command lines arguments</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on failure to open/read/write files or output streams</dd>
<dd><code><a href="../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></code> - on configuration failure (wrong params given)</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/SSTableExport.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/tools/NodeTool.Version.html" title="class in org.apache.cassandra.tools"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/cassandra/tools/SSTableImport.html" title="class in org.apache.cassandra.tools"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/tools/SSTableExport.html" target="_top">Frames</a></li>
<li><a href="SSTableExport.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>Field | </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>