Repository: accumulo-website Updated Branches: refs/heads/asf-site 3e4443c11 -> 2d7cc3d5a refs/heads/master 036341f26 -> 18942e837
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/18942e83 Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/18942e83 Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/18942e83 Branch: refs/heads/master Commit: 18942e8371e5561dfff755568916c26dc0031066 Parents: 036341f Author: Mike Walch <mwa...@apache.org> Authored: Tue May 23 09:49:28 2017 -0400 Committer: Mike Walch <mwa...@apache.org> Committed: Tue May 23 09:49:28 2017 -0400 ---------------------------------------------------------------------- _config.yml | 2 + _docs-unreleased/development/sampling.md | 53 +++++++++++--------- .../getting-started/table_configuration.md | 41 +++++++-------- 3 files changed, 53 insertions(+), 43 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/18942e83/_config.yml ---------------------------------------------------------------------- diff --git a/_config.yml b/_config.yml index ef56ee4..bae061c 100644 --- a/_config.yml +++ b/_config.yml @@ -60,6 +60,7 @@ defaults: title_prefix: "Accumulo Documentation - " version: "unreleased" docs_baseurl: "/docs/unreleased" + javadoc_core: "https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1"; skiph1fortitle: "true" # - # scope: @@ -70,6 +71,7 @@ defaults: # title_prefix: "Accumulo Documentation - " # version: "2.0" # docs_baseurl: "/docs/2.0" +# javadoc_core: "https://static.javadoc.io/org.apache.accumulo/accumulo-core/2.0.0"; # skiph1fortitle: "true" whitelist: [jekyll-redirect-from] http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/18942e83/_docs-unreleased/development/sampling.md ---------------------------------------------------------------------- diff --git a/_docs-unreleased/development/sampling.md b/_docs-unreleased/development/sampling.md index 95f6d93..4a76c39 100644 --- a/_docs-unreleased/development/sampling.md +++ b/_docs-unreleased/development/sampling.md @@ -23,20 +23,19 @@ estimate, and then making decisions based on the estimate. ## Configuring -Inorder to use sampling, an Accumulo table must be configured with a class that -implements `org.apache.accumulo.core.sample.Sampler` 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 `org.apache.accumulo.core.sample` and consult the javadoc of the -classes there. See the [sampling example][example] for examples of how to -configure a Sampler on a table. - -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 +In order to use sampling, an Accumulo table must be configured with a class that +implements [Sampler] along with options for that class. For guidance on +implementing a Sampler, see the [Sampler interface javadoc][Sampler]. 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 [org.apache.accumulo.core.client.sample][sample-package] +and consult the javadoc of the classes there. See the [sampling example][example] +for examples of how to configure a [Sampler] on a table. + +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 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. +files in the table that do not have sample data. The [sampling example][example] +shows how to do this. 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 @@ -45,19 +44,18 @@ compaction can also be issued in this case to regenerate the sample data. ## Scanning sample data -Inorder to scan sample data, use the `setSamplerConfiguration(...)` method on -`Scanner` or `BatchScanner`. Please consult this methods javadocs for more +In order to scan sample data, use `setSamplerConfiguration(...)` method of +[Scanner] or [BatchScanner]. Please consult the javadoc of this method for more information. -Sample data can also be scanned from within an Accumulo `SortedKeyValueIterator`. +Sample data can also be scanned from within an Accumulo [SortedKeyValueIterator][skv-iterator]. To see how to do this, look at the example iterator referenced in the [sampling example][example]. -Also, consult the javadoc on `org.apache.accumulo.core.iterators.IteratorEnvironment.cloneWithSamplingEnabled()`. +Also, consult the javadoc on [IteratorEnvironment.cloneWithSamplingEnabled()][clone-sampling]. -Map reduce jobs using the `AccumuloInputFormat` can also read sample data. See -the javadoc for the `setSamplerConfiguration()` method on -`AccumuloInputFormat`. +Map reduce jobs using the [AccumuloInputFormat] can also read sample data. See +the javadoc for the `setSamplerConfiguration()` method of [AccumuloInputFormat]. -Scans over sample data will throw a `SampleNotPresentException` in the following cases : +Scans over sample data will throw a [SampleNotPresentException] in the following cases : 1. sample data is not present, 2. sample data is present but was generated with multiple configurations @@ -69,7 +67,16 @@ generated with the same configuration. ## Bulk import When generating rfiles to bulk import into Accumulo, those rfiles can contain -sample data. To use this feature, look at the javadoc on the -`AccumuloFileOutputFormat.setSampler(...)` method. +sample data. To use this feature, look at the javadoc of the `setSampler(...)` +method of [AccumuloFileOutputFormat]. [example]: https://github.com/apache/accumulo-examples/blob/master/docs/sample.md +[Sampler]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/sample/Sampler.html +[sample-package]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/sample/package-summary.html +[skv-iterator]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/SortedKeyValueIterator.html +[clone-sampling]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/IteratorEnvironment.html#cloneWithSamplingEnabled() +[AccumuloInputFormat]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/mapred/AccumuloInputFormat.html +[AccumuloFileOutputFormat]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/mapred/AccumuloFileOutputFormat.html +[SampleNotPresentException]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/SampleNotPresentException.html +[BatchScanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/BatchScanner.html +[Scanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Scanner.html http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/18942e83/_docs-unreleased/getting-started/table_configuration.md ---------------------------------------------------------------------- diff --git a/_docs-unreleased/getting-started/table_configuration.md b/_docs-unreleased/getting-started/table_configuration.md index e86a1fb..9b629fc 100644 --- a/_docs-unreleased/getting-started/table_configuration.md +++ b/_docs-unreleased/getting-started/table_configuration.md @@ -83,17 +83,14 @@ com.test.AnotherConstraint=2 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: +the [Constraint][constraint] interface. - org.apache.accumulo.core.constraints.Constraint - -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 +To deploy a new constraint, create a jar file containing a class implementing [Constraint][constraint] +and place it in the `lib/` 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. -See the [contraints examples](https://github.com/apache/accumulo-examples/blob/master/docs/contraints.md) -for example code. +See the [constraints examples][constraints-example] for example code. ## Bloom Filters @@ -106,8 +103,7 @@ To enable bloom filters, enter the following command in the Shell: user@myinstance> config -t mytable -s table.bloom.enabled=true -The [bloom filter examples](https://github.com/apache/accumulo-examples/blob/master/docs/bloom.md) -contains an extensive example of using Bloom Filters. +The [bloom filter examples][bloom-filter-example] contains an extensive example of using Bloom Filters. ## Iterators @@ -116,7 +112,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 -*`org.apache.accumulo.core.iterators.user`* package. +[org.apache.accumulo.core.iterators.user][iterators-user] package. In each case, any custom Iterators must be included in Accumulo's classpath, typically by including a jar in `lib/` or `lib/ext/`, although the VFS classloader allows for classpath manipulation using a variety of schemes including URLs and HDFS URIs. @@ -124,7 +120,7 @@ allows for classpath manipulation using a variety of schemes including URLs and ### Setting Iterators via the Shell 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 [OptionDescriber][option-describer] interface, the setiter command can be used which will interactively prompt the user to provide values for the given necessary options. @@ -135,7 +131,7 @@ values for the given necessary options. user@myinstance mytable> setiter -t mytable -scan -p 15 -n myiter -class com.company.MyIterator 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. +in cases where the Iterator does not implement the [OptionDescriber][option-describer] interface. config -t mytable -s table.iterator.scan.myiter=15,com.company.MyIterator config -t mytable -s table.iterator.minc.myiter=15,com.company.MyIterator @@ -233,11 +229,10 @@ are removed from disk as part of the regular garbage collection process. ### Filters 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 [Filter][filter]. 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 -`org.apache.accumulo.core.iterators.Filter` class. +by writing a Java class that extends the [Filter][filter] class. 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 @@ -338,14 +333,12 @@ foo day:20080103 [] 1 ``` Accumulo includes some useful Combiners out of the box. To find these look in -the *`org.apache.accumulo.core.iterators.user`* package. +the [org.apache.accumulo.core.iterators.user][iterators-user] package. Additional Combiners can be added by creating a Java class that extends -`org.apache.accumulo.core.iterators.Combiner` and adding a jar containing that -class to Accumulo's lib/ext directory. +[Combiner][combiner] and adding a jar containing that class to Accumulo's `lib/ext` directory. -See the [combiner example](https://github.com/apache/accumulo-examples/blob/master/docs/combiner.md) -for example code. +See the [combiner example][combiner-example] for example code. ## Block Cache @@ -661,4 +654,12 @@ deleted. A table can be cloned and the clone taken offline inorder to avoid losing access to the table. See the [export example](https://github.com/apache/accumulo-examples/blob/master/docs/export.md) for example code. +[bloom-filter-example]: https://github.com/apache/accumulo-examples/blob/master/docs/bloom.md [config]: /docs/{{ page.version }}/config/ +[constraint]: {{ page.javadoc_core }}/org/apache/accumulo/core/constraints/Constraint.html +[constraints-example]: https://github.com/apache/accumulo-examples/blob/master/docs/contraints.md +[iterators-user]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/user/package-summary.html +[option-describer]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/OptionDescriber.html +[combiner]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/Combiner.html +[combiner-example]: https://github.com/apache/accumulo-examples/blob/master/docs/combiner.md +[filter]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/Filter.html
