You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by mw...@apache.org on 2016/12/06 19:14:49 UTC
[10/11] accumulo git commit: ACCUMULO-4531 Removed combiners.html
ACCUMULO-4531 Removed combiners.html
* Most documentation exists in manual but added some missing text
Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/fc1a68a9
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/fc1a68a9
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/fc1a68a9
Branch: refs/heads/master
Commit: fc1a68a99c2bdb5225cb1f19ecf9c6371a28c407
Parents: 2741998
Author: Mike Walch <mw...@apache.org>
Authored: Tue Dec 6 10:36:12 2016 -0500
Committer: Mike Walch <mw...@apache.org>
Committed: Tue Dec 6 14:04:54 2016 -0500
----------------------------------------------------------------------
.../asciidoc/chapters/table_configuration.txt | 7 +-
docs/src/main/resources/combiners.html | 87 --------------------
2 files changed, 6 insertions(+), 88 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo/blob/fc1a68a9/docs/src/main/asciidoc/chapters/table_configuration.txt
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/chapters/table_configuration.txt b/docs/src/main/asciidoc/chapters/table_configuration.txt
index a3e4dcd..adffd2e 100644
--- a/docs/src/main/asciidoc/chapters/table_configuration.txt
+++ b/docs/src/main/asciidoc/chapters/table_configuration.txt
@@ -120,6 +120,7 @@ To enable bloom filters, enter the following command in the Shell:
An extensive example of using Bloom Filters can be found at +docs/examples/bloom.md+ .
=== Iterators
+
Iterators provide a modular mechanism for adding functionality to be executed by
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
@@ -299,6 +300,10 @@ To see the iterator settings for a table, use:
==== Combiners
+Accumulo supports on the fly lazy aggregation of data using Combiners. Aggregation is
+done at compaction and scan time. No lookup is done at insert time, which` greatly
+speeds up ingest.
+
Accumulo allows Combiners to be configured on tables and column
families. When a Combiner is set it is applied across the values
associated with any keys that share rowID, column family, and column qualifier.
@@ -346,7 +351,7 @@ 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.
-An example of a Combiner can be found at +docs/examples/src/combiner/StatsCombiner.java+.
+An example of a Combiner can be found at +docs/examples/combiner.md+.
=== Block Cache
http://git-wip-us.apache.org/repos/asf/accumulo/blob/fc1a68a9/docs/src/main/resources/combiners.html
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/combiners.html b/docs/src/main/resources/combiners.html
deleted file mode 100644
index a5e3dc0..0000000
--- a/docs/src/main/resources/combiners.html
+++ /dev/null
@@ -1,87 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-<html>
-<head>
-<title>Accumulo Combiners</title>
-<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
-</head>
-<body>
-
-<h1>Apache Accumulo Documentation : Combiners</h1>
-
-<p>Accumulo supports on the fly lazy aggregation of data using Combiners. Aggregation is done at compaction and scan time. No lookup is done at insert time, which` greatly speeds up ingest.
-
-<p>Combiners are easy to use. You use the setiters command to configure a combiner for a table. Allowing a Combiner to apply to a whole column family is an interesting twist that gives the user great flexibility. The example below demonstrates this flexibility.
-
-<p><pre>
-
-Shell - Apache Accumulo Interactive Shell
-- version: 1.5.0
-- instance id: 863fc0d1-3623-4b6c-8c23-7d4fdb1c8a49
--
-- type 'help' for a list of available commands
--
-user@instance> createtable perDayCounts
-user@instance perDayCounts> setiter -t perDayCounts -p 10 -scan -minc -majc -n daycount -class org.apache.accumulo.core.iterators.user.SummingCombiner
-TypedValueCombiner can interpret Values as a variety of number encodings (VLong, Long, or String) before combining
-----------> set SummingCombiner parameter columns, <col fam>[:<col qual>]{,<col fam>[:<col qual>]} escape non aplhanum chars using %<hex>.: day
-----------> set SummingCombiner parameter type, <VARNUM|LONG|STRING>: STRING
-user@instance perDayCounts> insert foo day 20080101 1
-user@instance perDayCounts> insert foo day 20080101 1
-user@instance perDayCounts> insert foo day 20080103 1
-user@instance perDayCounts> insert bar day 20080101 1
-user@instance perDayCounts> insert bar day 20080101 1
-user@instance perDayCounts> scan
-bar day:20080101 [] 2
-foo day:20080101 [] 2
-foo day:20080103 [] 1
-</pre>
-
-
-<p>Implementing a new Combiner is a snap. Simply write some Java code that
-extends <code>org.apache.accumulo.core.iterators.Combiner</code>. A good place
-to look for examples is the <code>org.apache.accumulo.core.iterators.user</code> package. Also look at the example StatsCombiner.
-
-<p>To deploy a new aggregator, jar it up and put the jar in accumulo/lib/ext. To see an example look at <a href='examples/README.combiner'>README.combiner</a>
-
-<p>If you would like to see what iterators a table has you can use the config command like in the following example.
-
-<p><pre>
-user@instance perDayCounts> config -t perDayCounts -f iterator
----------+---------------------------------------------+-----------------------------------------------------------
-SCOPE | NAME | VALUE
----------+---------------------------------------------+-----------------------------------------------------------
-table | table.iterator.majc.daycount .............. | 10,org.apache.accumulo.core.iterators.user.SummingCombiner
-table | table.iterator.majc.daycount.opt.columns .. | day
-table | table.iterator.majc.daycount.opt.type ..... | STRING
-table | table.iterator.majc.vers .................. | 20,org.apache.accumulo.core.iterators.VersioningIterator
-table | table.iterator.majc.vers.opt.maxVersions .. | 1
-table | table.iterator.minc.daycount .............. | 10,org.apache.accumulo.core.iterators.user.SummingCombiner
-table | table.iterator.minc.daycount.opt.columns .. | day
-table | table.iterator.minc.daycount.opt.type ..... | STRING
-table | table.iterator.minc.vers .................. | 20,org.apache.accumulo.core.iterators.VersioningIterator
-table | table.iterator.minc.vers.opt.maxVersions .. | 1
-table | table.iterator.scan.daycount .............. | 10,org.apache.accumulo.core.iterators.user.SummingCombiner
-table | table.iterator.scan.daycount.opt.columns .. | day
-table | table.iterator.scan.daycount.opt.type ..... | STRING
-table | table.iterator.scan.vers .................. | 20,org.apache.accumulo.core.iterators.VersioningIterator
-table | table.iterator.scan.vers.opt.maxVersions .. | 1
----------+---------------------------------------------+-----------------------------------------------------------
-</pre>
-
-</body>
-</html>