accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [2/2] accumulo-website git commit: Jekyll build from master:b52d466
Date Wed, 31 May 2017 13:36:00 GMT
Jekyll build from master:b52d466

Added more links to javadocs in documentation


Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/1e7c974f
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/1e7c974f
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/1e7c974f

Branch: refs/heads/asf-site
Commit: 1e7c974f1273a6c50d5e4014d705198128f97ed9
Parents: 3f99b6c
Author: Mike Walch <mwalch@apache.org>
Authored: Tue May 30 11:37:01 2017 -0400
Committer: Mike Walch <mwalch@apache.org>
Committed: Tue May 30 11:37:01 2017 -0400

----------------------------------------------------------------------
 docs/unreleased/development/iterators.html | 18 +++++++++---------
 docs/unreleased/development/mapreduce.html | 15 +++++++--------
 docs/unreleased/development/proxy.html     |  4 ++--
 feed.xml                                   |  4 ++--
 4 files changed, 20 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/1e7c974f/docs/unreleased/development/iterators.html
----------------------------------------------------------------------
diff --git a/docs/unreleased/development/iterators.html b/docs/unreleased/development/iterators.html
index 64cbea4..e94ac8d 100644
--- a/docs/unreleased/development/iterators.html
+++ b/docs/unreleased/development/iterators.html
@@ -403,7 +403,7 @@ a Key-Value pair to return.</p>
 
 <p>The TabletServer first provides a <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/data/Range.html">Range</a>,
an object which defines some collection of Accumulo <code class="highlighter-rouge">Key</code>s,
which defines the
 Key-Value pairs that this Iterator should return. Each <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/data/Range.html">Range</a>
has a <code class="highlighter-rouge">startKey</code> and <code class="highlighter-rouge">endKey</code>
with an inclusive flag for
-both. While this Range is often similar to the Range(s) set by the client on a Scanner or
BatchScanner, it is not
+both. While this Range is often similar to the Range(s) set by the client on a <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/Scanner.html">Scanner</a>
or <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/BatchScanner.html">BatchScanner</a>,
it is not
 guaranteed to be a Range that the client set. Accumulo will split up larger ranges and group
them together based on
 Tablet boundaries per TabletServer. Iterators should not attempt to implement any custom
logic based on the Range(s)
 provided to <code class="highlighter-rouge">seek</code> and Iterators should
not return any Keys that fall outside of the provided Range.</p>
@@ -420,8 +420,8 @@ Range. For example, a regular expression Iterator would consume all records
whic
 pattern before returning from <code class="highlighter-rouge">seek</code>.</p>
 
 <p>It is important to retain the original <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/data/Range.html">Range</a>
passed to this method to know when this Iterator should stop
-reading more Key-Value pairs. Ignoring this typically does not affect scans from a Scanner,
but it
-will result in duplicate keys emitting from a BatchScan if the scanned table has more than
one tablet.
+reading more Key-Value pairs. Ignoring this typically does not affect scans from a <a
href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/Scanner.html">Scanner</a>,
but it
+will result in duplicate keys emitting from a <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/BatchScanner.html">BatchScanner</a>
if the scanned table has more than one tablet.
 Best practice is to never emit entries outside the seek range.</p>
 
 <h3 id="next">next</h3>
@@ -637,13 +637,13 @@ combining iterator.</p>
 
 <h2 id="best-practices">Best practices</h2>
 
-<p>Because of the flexibility that the [SortedKeyValueInterface] provides, it doesn’t
directly disallow
+<p>Because of the flexibility that the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/SortedKeyValueIterator.html">SortedKeyValueIterator</a>
interface provides, it doesn’t directly disallow
 many implementations which are poor design decisions. The following are some common recommendations
to
 follow and pitfalls to avoid in Iterator implementations.</p>
 
 <h4 id="avoid-special-logic-encoded-in-ranges">Avoid special logic encoded in Ranges</h4>
 
-<p>Commonly, granular Ranges that a client passes to an Iterator from a <code class="highlighter-rouge">Scanner</code>
or <code class="highlighter-rouge">BatchScanner</code> are unmodified.
+<p>Commonly, granular Ranges that a client passes to an Iterator from a <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/Scanner.html">Scanner</a>
or <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/BatchScanner.html">BatchScanner</a>
are unmodified.
 If a <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/data/Range.html">Range</a>
falls within the boundaries of a Tablet, an Iterator will often see that same Range in the
 <code class="highlighter-rouge">seek</code> method. However, there is no guarantee
that the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/data/Range.html">Range</a>
will remain unaltered from client to server. As such, Iterators
 should <em>never</em> make assumptions about the current state/context based
on the Range.</p>
@@ -679,17 +679,17 @@ Iterator’s implementation of seek.</p>
 
 <h3 id="take-caution-in-constructing-new-data-in-an-iterator">Take caution in constructing
new data in an Iterator</h3>
 
-<p>Implementations of Iterator might be tempted to open BatchWriters inside of an Iterator
as a means
+<p>Implementations of Iterator might be tempted to open <a href="/org/apache/accumulo/core/client/BatchWriter.html">BatchWriters</a>
inside of an Iterator as a means
 to implement triggers for writing additional data outside of their client application. The
lifecycle of an Iterator
 is <em>not</em> managed in such a way that guarantees that this is safe nor efficient.
Specifically, there
 is no way to guarantee that the internal ThreadPool inside of the BatchWriter is closed (and
the thread(s)
-are reaped) without calling the close() method. <code class="highlighter-rouge">close</code>‘ing
and recreating a <code class="highlighter-rouge">BatchWriter</code> after every
+are reaped) without calling the close() method. <code class="highlighter-rouge">close</code>‘ing
and recreating a <a href="/org/apache/accumulo/core/client/BatchWriter.html">BatchWriter</a>
after every
 Key-Value pair is also prohibitively performance limiting to be considered an option.</p>
 
 <p>The only safe way to generate additional data in an Iterator is to alter the current
Key-Value pair.
-For example, the <code class="highlighter-rouge">WholeRowIterator</code> serializes
the all of the Key-Values pairs that fall within each
+For example, the <a href="/org/apache/accumulo/core/iterators/user/WholeRowIterator.html">WholeRowIterator</a>
serializes the all of the Key-Values pairs that fall within each
 row. A safe way to generate more data in an Iterator would be to construct an Iterator that
is
-“higher” (at a larger priority) than the <code class="highlighter-rouge">WholeRowIterator</code>,
that is, the Iterator receives the Key-Value pairs which are
+“higher” (at a larger priority) than the WholeRowIterator, that is, the Iterator receives
the Key-Value pairs which are
 a serialization of many Key-Value pairs. The custom Iterator could deserialize the pairs,
compute
 some function, and add a new Key-Value pair to the original collection, re-serializing the
collection
 of Key-Value pairs back into a single Key-Value pair.</p>

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/1e7c974f/docs/unreleased/development/mapreduce.html
----------------------------------------------------------------------
diff --git a/docs/unreleased/development/mapreduce.html b/docs/unreleased/development/mapreduce.html
index 1094f4f..4b98054 100644
--- a/docs/unreleased/development/mapreduce.html
+++ b/docs/unreleased/development/mapreduce.html
@@ -318,10 +318,9 @@
     <h1>MapReduce</h1>
     
     <p>Accumulo tables can be used as the source and destination of MapReduce jobs.
To
-use an Accumulo table with a MapReduce job (specifically with the new Hadoop API
-as of version 0.20), configure the job parameters to use the AccumuloInputFormat
-and AccumuloOutputFormat. Accumulo specific parameters can be set via these
-two format classes to do the following:</p>
+use an Accumulo table with a MapReduce job, configure the job parameters to use
+the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/mapred/AccumuloInputFormat.html">AccumuloInputFormat</a>
and <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/mapred/AccumuloOutputFormat.html">AccumuloOutputFormat</a>.
Accumulo specific parameters
+can be set via these two format classes to do the following:</p>
 
 <ul>
   <li>Authenticate and provide user credentials for the input</li>
@@ -332,7 +331,7 @@ two format classes to do the following:</p>
 <h2 id="mapper-and-reducer-classes">Mapper and Reducer classes</h2>
 
 <p>To read from an Accumulo table create a Mapper with the following class
-parameterization and be sure to configure the AccumuloInputFormat.</p>
+parameterization and be sure to configure the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/mapred/AccumuloInputFormat.html">AccumuloInputFormat</a>.</p>
 
 <div class="language-java highlighter-rouge"><pre class="highlight"><code><span
class="kd">class</span> <span class="nc">MyMapper</span> <span class="kd">extends</span>
<span class="n">Mapper</span><span class="o">&lt;</span><span
class="n">Key</span><span class="o">,</span><span class="n">Value</span><span
class="o">,</span><span class="n">WritableComparable</span><span class="o">,</span><span
class="n">Writable</span><span class="o">&gt;</span> <span class="o">{</span>
     <span class="kd">public</span> <span class="kt">void</span> <span
class="nf">map</span><span class="o">(</span><span class="n">Key</span>
<span class="n">k</span><span class="o">,</span> <span class="n">Value</span>
<span class="n">v</span><span class="o">,</span> <span class="n">Context</span>
<span class="n">c</span><span class="o">)</span> <span class="o">{</span>
@@ -343,7 +342,7 @@ parameterization and be sure to configure the AccumuloInputFormat.</p>
 </div>
 
 <p>To write to an Accumulo table, create a Reducer with the following class
-parameterization and be sure to configure the AccumuloOutputFormat. The key
+parameterization and be sure to configure the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/mapred/AccumuloOutputFormat.html">AccumuloOutputFormat</a>.
The key
 emitted from the Reducer identifies the table to which the mutation is sent. This
 allows a single Reducer to write to more than one table if desired. A default table
 can be configured using the AccumuloOutputFormat, in which case the output table
@@ -361,7 +360,7 @@ name does not have to be passed to the Context object within the Reducer.</p>
 
 <p>The Text object passed as the output should contain the name of the table to which
 this mutation should be applied. The Text can be null in which case the mutation
-will be applied to the default table name specified in the AccumuloOutputFormat
+will be applied to the default table name specified in the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/mapred/AccumuloOutputFormat.html">AccumuloOutputFormat</a>
 options.</p>
 
 <h2 id="accumuloinputformat-options">AccumuloInputFormat options</h2>
@@ -406,7 +405,7 @@ options.</p>
 
 <h2 id="accumulomultitableinputformat-options">AccumuloMultiTableInputFormat options</h2>
 
-<p>The AccumuloMultiTableInputFormat allows the scanning over multiple tables
+<p>The <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/mapred/AccumuloMultiTableInputFormat.html">AccumuloMultiTableInputFormat</a>
allows the scanning over multiple tables
 in a single MapReduce job. Separate ranges, columns, and iterators can be
 used for each table.</p>
 

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/1e7c974f/docs/unreleased/development/proxy.html
----------------------------------------------------------------------
diff --git a/docs/unreleased/development/proxy.html b/docs/unreleased/development/proxy.html
index 4df16bc..2c2cbcb 100644
--- a/docs/unreleased/development/proxy.html
+++ b/docs/unreleased/development/proxy.html
@@ -319,7 +319,7 @@
     
     <p>The proxy API allows the interaction with Accumulo with languages other than
Java.
 A proxy server is provided in the codebase and a client can further be generated.
-The proxy API can also be used instead of the traditional ZooKeeperInstance class to
+The proxy API can also be used instead of the traditional <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/ZooKeeperInstance.html">ZooKeeperInstance</a>
class to
 provide a single TCP port in which clients can be securely routed through a firewall,
 without requiring access to all tablet servers in the cluster.</p>
 
@@ -345,7 +345,7 @@ zookeepers=localhost:2181
 <p>You can find a sample configuration file in your distribution at <code class="highlighter-rouge">proxy/proxy.properties</code>.</p>
 
 <p>This sample configuration file further demonstrates an ability to back the proxy
server
-by MockAccumulo or the MiniAccumuloCluster.</p>
+by MiniAccumuloCluster.</p>
 
 <h2 id="running-the-proxy-server">Running the Proxy Server</h2>
 

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/1e7c974f/feed.xml
----------------------------------------------------------------------
diff --git a/feed.xml b/feed.xml
index 07c2df6..81ee302 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
 </description>
     <link>https://accumulo.apache.org/</link>
     <atom:link href="https://accumulo.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
-    <pubDate>Fri, 26 May 2017 10:56:05 -0400</pubDate>
-    <lastBuildDate>Fri, 26 May 2017 10:56:05 -0400</lastBuildDate>
+    <pubDate>Tue, 30 May 2017 11:36:53 -0400</pubDate>
+    <lastBuildDate>Tue, 30 May 2017 11:36:53 -0400</lastBuildDate>
     <generator>Jekyll v3.3.1</generator>
     
       <item>


Mime
View raw message