Jekyll build from master:18942e8 Improved linking to javadocs
Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/2d7cc3d5 Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/2d7cc3d5 Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/2d7cc3d5 Branch: refs/heads/asf-site Commit: 2d7cc3d5ac357abc59c64f0d79b41925af07863e Parents: 3e4443c Author: Mike Walch <mwa...@apache.org> Authored: Tue May 23 09:50:13 2017 -0400 Committer: Mike Walch <mwa...@apache.org> Committed: Tue May 23 09:50:13 2017 -0400 ---------------------------------------------------------------------- docs/unreleased/development/sampling.html | 44 ++++++++++---------- .../getting-started/table_configuration.html | 35 ++++++---------- feed.xml | 4 +- 3 files changed, 36 insertions(+), 47 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/2d7cc3d5/docs/unreleased/development/sampling.html ---------------------------------------------------------------------- diff --git a/docs/unreleased/development/sampling.html b/docs/unreleased/development/sampling.html index 4592c40..fff24b9 100644 --- a/docs/unreleased/development/sampling.html +++ b/docs/unreleased/development/sampling.html @@ -336,20 +336,19 @@ estimate, and then making decisions based on the estimate.</p> <h2 id="configuring">Configuring</h2> -<p>Inorder to use sampling, an Accumulo table must be configured with a class that -implements <code class="highlighter-rouge">org.apache.accumulo.core.sample.Sampler</code> along with options for -that class. For guidance on implementing a Sampler see that interfaceâs -javadoc. Accumulo provides a few implementations out of the box. For -information on how to use the samplers that ship with Accumulo look in the -package <code class="highlighter-rouge">org.apache.accumulo.core.sample</code> and consult the javadoc of the -classes there. See the <a href="https://github.com/apache/accumulo-examples/blob/master/docs/sample.md";>sampling example</a> for examples of how to -configure a Sampler on a table.</p> - -<p>Once a table is configured with a sampler all writes after that point will -generate sample data. For data written before sampling was configured sample +<p>In order to use sampling, an Accumulo table must be configured with a class that +implements <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/sample/Sampler.html";>Sampler</a> along with options for that class. For guidance on +implementing a Sampler, see the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/sample/Sampler.html";>Sampler interface javadoc</a>. Accumulo provides a few +implementations of Sampler out of the box. For information on how to use the samplers that +ship with Accumulo, look in the package <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/sample/package-summary.html";>org.apache.accumulo.core.client.sample</a> +and consult the javadoc of the classes there. See the <a href="https://github.com/apache/accumulo-examples/blob/master/docs/sample.md";>sampling example</a> +for examples of how to configure a <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/sample/Sampler.html";>Sampler</a> on a table.</p> + +<p>Once a table is configured with a <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/sample/Sampler.html";>Sampler</a>, all writes after that point will +generate sample data. For data written before sampling was configured, sample data will not be present. A compaction can be initiated that only compacts the -files in the table that do not have sample data. The example readme shows how -to do this.</p> +files in the table that do not have sample data. The <a href="https://github.com/apache/accumulo-examples/blob/master/docs/sample.md";>sampling example</a> +shows how to do this.</p> <p>If the sampling configuration of a table is changed, then Accumulo will start generating new sample data with the new configuration. However old data will @@ -358,19 +357,18 @@ compaction can also be issued in this case to regenerate the sample data.</p> <h2 id="scanning-sample-data">Scanning sample data</h2> -<p>Inorder to scan sample data, use the <code class="highlighter-rouge">setSamplerConfiguration(...)</code> method on -<code class="highlighter-rouge">Scanner</code> or <code class="highlighter-rouge">BatchScanner</code>. Please consult this methods javadocs for more +<p>In order to scan sample data, use <code class="highlighter-rouge">setSamplerConfiguration(...)</code> method of +<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>. Please consult the javadoc of this method for more information.</p> -<p>Sample data can also be scanned from within an Accumulo <code class="highlighter-rouge">SortedKeyValueIterator</code>. +<p>Sample data can also be scanned from within an Accumulo <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/SortedKeyValueIterator.html";>SortedKeyValueIterator</a>. To see how to do this, look at the example iterator referenced in the <a href="https://github.com/apache/accumulo-examples/blob/master/docs/sample.md";>sampling example</a>. -Also, consult the javadoc on <code class="highlighter-rouge">org.apache.accumulo.core.iterators.IteratorEnvironment.cloneWithSamplingEnabled()</code>.</p> +Also, consult the javadoc on <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/IteratorEnvironment.html#cloneWithSamplingEnabled()">IteratorEnvironment.cloneWithSamplingEnabled()</a>.</p> -<p>Map reduce jobs using the <code class="highlighter-rouge">AccumuloInputFormat</code> can also read sample data. See -the javadoc for the <code class="highlighter-rouge">setSamplerConfiguration()</code> method on -<code class="highlighter-rouge">AccumuloInputFormat</code>.</p> +<p>Map reduce jobs using 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> can also read sample data. See +the javadoc for the <code class="highlighter-rouge">setSamplerConfiguration()</code> method of <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> -<p>Scans over sample data will throw a <code class="highlighter-rouge">SampleNotPresentException</code> in the following cases :</p> +<p>Scans over sample data will throw a <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/SampleNotPresentException.html";>SampleNotPresentException</a> in the following cases :</p> <ol> <li>sample data is not present,</li> @@ -384,8 +382,8 @@ generated with the same configuration.</p> <h2 id="bulk-import">Bulk import</h2> <p>When generating rfiles to bulk import into Accumulo, those rfiles can contain -sample data. To use this feature, look at the javadoc on the -<code class="highlighter-rouge">AccumuloFileOutputFormat.setSampler(...)</code> method.</p> +sample data. To use this feature, look at the javadoc of the <code class="highlighter-rouge">setSampler(...)</code> +method of <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/client/mapred/AccumuloFileOutputFormat.html";>AccumuloFileOutputFormat</a>.</p> </div> http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/2d7cc3d5/docs/unreleased/getting-started/table_configuration.html ---------------------------------------------------------------------- diff --git a/docs/unreleased/getting-started/table_configuration.html b/docs/unreleased/getting-started/table_configuration.html index 9c8fc2d..8a691ca 100644 --- a/docs/unreleased/getting-started/table_configuration.html +++ b/docs/unreleased/getting-started/table_configuration.html @@ -400,19 +400,14 @@ com.test.AnotherConstraint=2 <p>Currently there are no general-purpose constraints provided with the Accumulo distribution. New constraints can be created by writing a Java class that implements -the following interface:</p> +the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/constraints/Constraint.html";>Constraint</a> interface.</p> -<div class="highlighter-rouge"><pre class="highlight"><code> org.apache.accumulo.core.constraints.Constraint -</code></pre> -</div> - -<p>To deploy a new constraint, create a jar file containing the class implementing the -new constraint and place it in the lib directory of the Accumulo installation. New +<p>To deploy a new constraint, create a jar file containing a class implementing <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/constraints/Constraint.html";>Constraint</a> +and place it in the <code class="highlighter-rouge">lib/</code> directory of the Accumulo installation. New constraint jars can be added to Accumulo and enabled without restarting but any change to an existing constraint class requires Accumulo to be restarted.</p> -<p>See the <a href="https://github.com/apache/accumulo-examples/blob/master/docs/contraints.md";>contraints examples</a> -for example code.</p> +<p>See the <a href="https://github.com/apache/accumulo-examples/blob/master/docs/contraints.md";>constraints examples</a> for example code.</p> <h2 id="bloom-filters">Bloom Filters</h2> @@ -427,8 +422,7 @@ This can speed up lookups considerably.</p> </code></pre> </div> -<p>The <a href="https://github.com/apache/accumulo-examples/blob/master/docs/bloom.md";>bloom filter examples</a> -contains an extensive example of using Bloom Filters.</p> +<p>The <a href="https://github.com/apache/accumulo-examples/blob/master/docs/bloom.md";>bloom filter examples</a> contains an extensive example of using Bloom Filters.</p> <h2 id="iterators">Iterators</h2> @@ -437,7 +431,7 @@ TabletServers when scanning or compacting data. This allows users to efficiently summarize, filter, and aggregate data. In fact, the built-in features of cell-level security and column fetching are implemented using Iterators. Some useful Iterators are provided with Accumulo and can be found in the -<em><code class="highlighter-rouge">org.apache.accumulo.core.iterators.user</code></em> package. +<a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/user/package-summary.html";>org.apache.accumulo.core.iterators.user</a> package. In each case, any custom Iterators must be included in Accumuloâs classpath, typically by including a jar in <code class="highlighter-rouge">lib/</code> or <code class="highlighter-rouge">lib/ext/</code>, although the VFS classloader allows for classpath manipulation using a variety of schemes including URLs and HDFS URIs.</p> @@ -445,7 +439,7 @@ allows for classpath manipulation using a variety of schemes including URLs and <h3 id="setting-iterators-via-the-shell">Setting Iterators via the Shell</h3> <p>Iterators can be configured on a table at scan, minor compaction and/or major -compaction scopes. If the Iterator implements the OptionDescriber interface, the +compaction scopes. If the Iterator implements the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/OptionDescriber.html";>OptionDescriber</a> interface, the setiter command can be used which will interactively prompt the user to provide values for the given necessary options.</p> @@ -458,7 +452,7 @@ user@myinstance mytable> setiter -t mytable -scan -p 15 -n myiter -class com. </div> <p>The config command can always be used to manually configure iterators which is useful -in cases where the Iterator does not implement the OptionDescriber interface.</p> +in cases where the Iterator does not implement the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/OptionDescriber.html";>OptionDescriber</a> interface.</p> <div class="highlighter-rouge"><pre class="highlight"><code>config -t mytable -s table.iterator.scan.myiter=15,com.company.MyIterator config -t mytable -s table.iterator.minc.myiter=15,com.company.MyIterator @@ -560,11 +554,10 @@ are removed from disk as part of the regular garbage collection process.</p> <h3 id="filters">Filters</h3> <p>When scanning over a set of key-value pairs it is possible to apply an arbitrary -filtering policy through the use of a Filter. Filters are types of iterators that return +filtering policy through the use of a <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/Filter.html";>Filter</a>. Filters are types of iterators that return only key-value pairs that satisfy the filter logic. Accumulo has a few built-in filters that can be configured on any table: AgeOff, ColumnAgeOff, Timestamp, NoVis, and RegEx. More can be added -by writing a Java class that extends the -<code class="highlighter-rouge">org.apache.accumulo.core.iterators.Filter</code> class.</p> +by writing a Java class that extends the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/Filter.html";>Filter</a> class.</p> <p>The AgeOff filter can be configured to remove data older than a certain date or a fixed amount of time from the present. The following example sets a table to delete @@ -671,14 +664,12 @@ foo day:20080103 [] 1 </div> <p>Accumulo includes some useful Combiners out of the box. To find these look in -the <em><code class="highlighter-rouge">org.apache.accumulo.core.iterators.user</code></em> package.</p> +the <a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/user/package-summary.html";>org.apache.accumulo.core.iterators.user</a> package.</p> <p>Additional Combiners can be added by creating a Java class that extends -<code class="highlighter-rouge">org.apache.accumulo.core.iterators.Combiner</code> and adding a jar containing that -class to Accumuloâs lib/ext directory.</p> +<a href="https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1/org/apache/accumulo/core/iterators/Combiner.html";>Combiner</a> and adding a jar containing that class to Accumuloâs <code class="highlighter-rouge">lib/ext</code> directory.</p> -<p>See the <a href="https://github.com/apache/accumulo-examples/blob/master/docs/combiner.md";>combiner example</a> -for example code.</p> +<p>See the <a href="https://github.com/apache/accumulo-examples/blob/master/docs/combiner.md";>combiner example</a> for example code.</p> <h2 id="block-cache">Block Cache</h2> http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/2d7cc3d5/feed.xml ---------------------------------------------------------------------- diff --git a/feed.xml b/feed.xml index c68428d..2bf2fe2 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>Mon, 22 May 2017 16:09:46 -0400</pubDate> - <lastBuildDate>Mon, 22 May 2017 16:09:46 -0400</lastBuildDate> + <pubDate>Tue, 23 May 2017 09:49:52 -0400</pubDate> + <lastBuildDate>Tue, 23 May 2017 09:49:52 -0400</lastBuildDate> <generator>Jekyll v3.3.1</generator> <item>
