You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by ct...@apache.org on 2014/03/28 01:50:57 UTC
[5/6] git commit: ACCUMULO-1487,
ACCUMULO-1491 Stop packaging docs for monitor
ACCUMULO-1487, ACCUMULO-1491 Stop packaging docs for monitor
Moved docs out of monitor and into docs directory. Added docs to assemblies.
Remove unnecessary goals from release profile. Remove links from docs to
apidocs. Restricted rpms/debs from being placed in lib/ and docs/ in tarball.
Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/a20e19fc
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/a20e19fc
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/a20e19fc
Branch: refs/heads/master
Commit: a20e19fc4f7c7989ba1b50459d9f762063e3e631
Parents: 0428122
Author: Christopher Tubbs <ct...@apache.org>
Authored: Thu Mar 27 20:35:32 2014 -0400
Committer: Christopher Tubbs <ct...@apache.org>
Committed: Thu Mar 27 20:41:08 2014 -0400
----------------------------------------------------------------------
assemble/src/main/assemblies/component.xml | 17 +-
.../core/conf/DefaultConfiguration.java | 11 +-
docs/pom.xml | 21 ++
.../chapters/administration.tex | 2 +-
.../chapters/table_configuration.tex | 4 +-
docs/src/main/resources/administration.html | 171 +++++++++++++++
docs/src/main/resources/bulkIngest.html | 114 ++++++++++
docs/src/main/resources/combiners.html | 87 ++++++++
docs/src/main/resources/constraints.html | 50 +++++
docs/src/main/resources/distributedTracing.html | 99 +++++++++
docs/src/main/resources/documentation.css | 112 ++++++++++
docs/src/main/resources/examples/README | 95 ++++++++
docs/src/main/resources/examples/README.batch | 55 +++++
docs/src/main/resources/examples/README.bloom | 219 +++++++++++++++++++
.../main/resources/examples/README.bulkIngest | 33 +++
.../main/resources/examples/README.classpath | 68 ++++++
docs/src/main/resources/examples/README.client | 79 +++++++
.../src/main/resources/examples/README.combiner | 70 ++++++
.../main/resources/examples/README.constraints | 54 +++++
docs/src/main/resources/examples/README.dirlist | 114 ++++++++++
docs/src/main/resources/examples/README.export | 91 ++++++++
.../src/main/resources/examples/README.filedata | 47 ++++
docs/src/main/resources/examples/README.filter | 110 ++++++++++
.../main/resources/examples/README.helloworld | 47 ++++
.../main/resources/examples/README.isolation | 50 +++++
docs/src/main/resources/examples/README.mapred | 154 +++++++++++++
.../main/resources/examples/README.maxmutation | 47 ++++
docs/src/main/resources/examples/README.regex | 58 +++++
.../main/resources/examples/README.reservations | 66 ++++++
docs/src/main/resources/examples/README.rowhash | 59 +++++
docs/src/main/resources/examples/README.shard | 67 ++++++
.../main/resources/examples/README.tabletofile | 59 +++++
.../src/main/resources/examples/README.terasort | 50 +++++
.../main/resources/examples/README.visibility | 131 +++++++++++
docs/src/main/resources/index.html | 40 ++++
docs/src/main/resources/isolation.html | 51 +++++
docs/src/main/resources/lgroups.html | 45 ++++
docs/src/main/resources/metrics.html | 182 +++++++++++++++
docs/src/main/resources/timestamps.html | 160 ++++++++++++++
pom.xml | 4 +-
.../accumulo/monitor/servlets/BasicServlet.java | 4 +-
.../monitor/servlets/DefaultServlet.java | 26 +--
.../src/main/resources/docs/administration.html | 171 ---------------
.../src/main/resources/docs/bulkIngest.html | 114 ----------
.../src/main/resources/docs/combiners.html | 85 -------
.../src/main/resources/docs/constraints.html | 49 -----
.../main/resources/docs/distributedTracing.html | 99 ---------
.../src/main/resources/docs/documentation.css | 112 ----------
.../src/main/resources/docs/examples/README | 95 --------
.../main/resources/docs/examples/README.batch | 55 -----
.../main/resources/docs/examples/README.bloom | 219 -------------------
.../resources/docs/examples/README.bulkIngest | 33 ---
.../resources/docs/examples/README.classpath | 68 ------
.../main/resources/docs/examples/README.client | 79 -------
.../resources/docs/examples/README.combiner | 70 ------
.../resources/docs/examples/README.constraints | 54 -----
.../main/resources/docs/examples/README.dirlist | 114 ----------
.../main/resources/docs/examples/README.export | 91 --------
.../resources/docs/examples/README.filedata | 47 ----
.../main/resources/docs/examples/README.filter | 110 ----------
.../resources/docs/examples/README.helloworld | 47 ----
.../resources/docs/examples/README.isolation | 50 -----
.../main/resources/docs/examples/README.mapred | 154 -------------
.../resources/docs/examples/README.maxmutation | 47 ----
.../main/resources/docs/examples/README.regex | 58 -----
.../resources/docs/examples/README.reservations | 66 ------
.../main/resources/docs/examples/README.rowhash | 59 -----
.../main/resources/docs/examples/README.shard | 67 ------
.../resources/docs/examples/README.tabletofile | 59 -----
.../resources/docs/examples/README.terasort | 50 -----
.../resources/docs/examples/README.visibility | 131 -----------
.../monitor/src/main/resources/docs/index.html | 41 ----
.../src/main/resources/docs/isolation.html | 39 ----
.../src/main/resources/docs/lgroups.html | 42 ----
.../src/main/resources/docs/metrics.html | 182 ---------------
.../src/main/resources/docs/timestamps.html | 160 --------------
76 files changed, 2982 insertions(+), 2958 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/assemble/src/main/assemblies/component.xml
----------------------------------------------------------------------
diff --git a/assemble/src/main/assemblies/component.xml b/assemble/src/main/assemblies/component.xml
index ccd2653..24515ea 100644
--- a/assemble/src/main/assemblies/component.xml
+++ b/assemble/src/main/assemblies/component.xml
@@ -36,6 +36,8 @@
</includes>
<excludes>
<exclude>${groupId}:${artifactId}-docs</exclude>
+ <exclude>${groupId}:${artifactId}-*:rpm</exclude>
+ <exclude>${groupId}:${artifactId}-*:deb</exclude>
</excludes>
</dependencySet>
<dependencySet>
@@ -46,7 +48,7 @@
<outputFileNameMapping>${artifactId}_user_manual.${artifact.extension}</outputFileNameMapping>
<useTransitiveDependencies>false</useTransitiveDependencies>
<includes>
- <include>${groupId}:${artifactId}-docs</include>
+ <include>${groupId}:${artifactId}-docs:pdf:user-manual</include>
</includes>
</dependencySet>
</dependencySets>
@@ -100,15 +102,26 @@
</excludes>
</fileSet>
<fileSet>
- <directory>../docs</directory>
+ <directory>../docs/src/main/resources</directory>
+ <outputDirectory>/docs</outputDirectory>
<directoryMode>0755</directoryMode>
<fileMode>0644</fileMode>
<includes>
<include>*.html</include>
+ <include>*.css</include>
<include>examples/*</include>
</includes>
</fileSet>
<fileSet>
+ <directory>../docs/target</directory>
+ <outputDirectory>/docs</outputDirectory>
+ <directoryMode>0755</directoryMode>
+ <fileMode>0644</fileMode>
+ <includes>
+ <include>config.html</include>
+ </includes>
+ </fileSet>
+ <fileSet>
<directory>../conf</directory>
<directoryMode>0755</directoryMode>
<fileMode>0755</fileMode>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/core/src/main/java/org/apache/accumulo/core/conf/DefaultConfiguration.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/accumulo/core/conf/DefaultConfiguration.java b/core/src/main/java/org/apache/accumulo/core/conf/DefaultConfiguration.java
index 030e88a..847fd02 100644
--- a/core/src/main/java/org/apache/accumulo/core/conf/DefaultConfiguration.java
+++ b/core/src/main/java/org/apache/accumulo/core/conf/DefaultConfiguration.java
@@ -61,22 +61,15 @@ public class DefaultConfiguration extends AccumuloConfiguration {
}
/*
- * Used by the monitor to show configuration properties
- */
- protected static void generateDocumentation(PrintStream doc) {
- new ConfigurationDocGen(doc).generateHtml();
- }
-
- /*
* Generate documentation for conf/accumulo-site.xml file usage
*/
public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException {
- if (args.length == 2 && args[0].equals("--generate-doc")) {
+ if (args.length == 2 && args[0].equals("--generate-html")) {
new ConfigurationDocGen(new PrintStream(args[1], Constants.UTF8.name())).generateHtml();
} else if (args.length == 2 && args[0].equals("--generate-latex")) {
new ConfigurationDocGen(new PrintStream(args[1], Constants.UTF8.name())).generateLaTeX();
} else {
- throw new IllegalArgumentException("Usage: " + DefaultConfiguration.class.getName() + " --generate-doc <filename> | --generate-latex <filename>");
+ throw new IllegalArgumentException("Usage: " + DefaultConfiguration.class.getName() + " --generate-html <filename> | --generate-latex <filename>");
}
}
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/pom.xml
----------------------------------------------------------------------
diff --git a/docs/pom.xml b/docs/pom.xml
index 32ba317..f7ad760 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -56,6 +56,21 @@
</configuration>
</execution>
<execution>
+ <id>config-html</id>
+ <goals>
+ <goal>java</goal>
+ </goals>
+ <phase>compile</phase>
+ <configuration>
+ <mainClass>org.apache.accumulo.core.conf.DefaultConfiguration</mainClass>
+ <classpathScope>compile</classpathScope>
+ <arguments>
+ <argument>--generate-html</argument>
+ <argument>${project.build.directory}/config.html</argument>
+ </arguments>
+ </configuration>
+ </execution>
+ <execution>
<id>config-appendix</id>
<goals>
<goal>java</goal>
@@ -136,6 +151,12 @@
<source>
<location>${project.build.directory}/accumulo_user_manual.pdf</location>
</source>
+ <source>
+ <location>src/main/resources/</location>
+ </source>
+ <source>
+ <location>${project.build.directory}/config.html</location>
+ </source>
</sources>
</mapping>
</mappings>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/latex/accumulo_user_manual/chapters/administration.tex
----------------------------------------------------------------------
diff --git a/docs/src/main/latex/accumulo_user_manual/chapters/administration.tex b/docs/src/main/latex/accumulo_user_manual/chapters/administration.tex
index 57c8760..08c5108 100644
--- a/docs/src/main/latex/accumulo_user_manual/chapters/administration.tex
+++ b/docs/src/main/latex/accumulo_user_manual/chapters/administration.tex
@@ -161,7 +161,7 @@ secret and make sure that the \texttt{accumulo-site.xml} file is not readable to
Some settings can be modified via the Accumulo shell and take effect immediately, but
some settings require a process restart to take effect. See the configuration documentation
-(available on the monitor web pages and in Appendix~\ref{app:config}) for details.
+(available in the docs directory of the tarball and in Appendix~\ref{app:config}) for details.
\subsection{Deploy Configuration}
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/latex/accumulo_user_manual/chapters/table_configuration.tex
----------------------------------------------------------------------
diff --git a/docs/src/main/latex/accumulo_user_manual/chapters/table_configuration.tex b/docs/src/main/latex/accumulo_user_manual/chapters/table_configuration.tex
index 0e0dad4..a19cb52 100644
--- a/docs/src/main/latex/accumulo_user_manual/chapters/table_configuration.tex
+++ b/docs/src/main/latex/accumulo_user_manual/chapters/table_configuration.tex
@@ -110,7 +110,7 @@ change to an existing constraint class requires Accumulo to be restarted.
An example of constraints can be found in\\
\texttt{accumulo/docs/examples/README.constraints} with corresponding code under\\
-\texttt{accumulo/examples/simple/main/java/accumulo/examples/simple/constraints} .
+\texttt{accumulo/examples/simple/src/main/java/accumulo/examples/simple/constraints} .
\section{Bloom Filters}
As mutations are applied to an Accumulo table, several files are created per tablet. If
@@ -355,7 +355,7 @@ class to Accumulo's lib/ext directory.
An example of a Combiner can be found under
\begingroup\fontsize{8pt}{8pt}\selectfont\begin{verbatim}
-accumulo/examples/simple/main/java/org/apache/accumulo/examples/simple/combiner/StatsCombiner.java
+accumulo/examples/simple/src/main/java/org/apache/accumulo/examples/simple/combiner/StatsCombiner.java
\end{verbatim}\endgroup
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/administration.html
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/administration.html b/docs/src/main/resources/administration.html
new file mode 100644
index 0000000..5898037
--- /dev/null
+++ b/docs/src/main/resources/administration.html
@@ -0,0 +1,171 @@
+<!--
+ 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 Administration</title>
+<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
+</head>
+<body>
+
+<h1>Apache Accumulo Documentation : Administration</h1>
+
+<h3>Starting accumulo for the first time</h3>
+
+<p>For the most part, accumulo is ready to go out of the box. To start it, first you must distribute and install
+the accumulo software to each machine in the cloud that you wish to run on. The software should be installed
+in the same directory on each machine and configured identically (or at least similarly... see the configuration
+sections for more details). Select one machine to be your bootstrap machine, the one that you will start accumulo
+with. Note that you must have passphrase-less ssh access to each machine from your bootstrap machine. On this machine,
+create a conf/masters and conf/slaves file. In the masters file, type the hostname of the machine you wish to run the master on (probably localhost).
+In the slaves file, type the hostnames, separated by newlines of each machine you wish to participate in accumulo as a tablet server. If you neglect
+to create these files, the startup scripts will assume you are trying to run on localhost only, and will instantiate a single-node instance only.
+It is probably a good idea to back up these files, or distribute them to the other nodes as well, so that you can easily boot up accumulo
+from another machine, if necessary. You can also make create a <code>conf/accumulo-env.sh</code> file if you want to configure any custom environment variables.
+
+<p>Once properly configured, you can initialize or prepare an instance of accumulo by running: <code>bin/accumulo init</code><br />
+Follow the prompts and you are ready to go. This step only prepares accumulo to run, it does not start up accumulo.
+
+<h3>Starting accumulo</h3>
+
+<p>Once you have configured accumulo to your liking, and distributed the appropriate configuration to each machine, you can start accumulo with
+bin/start-all.sh. If at any time, you wish to bring accumulo servers online after one or more have been shutdown, you can run bin/start-all.sh again.
+This step will only start services that are not already running. Be aware that if you run this command on more than one machine, you may unintentionally
+start an extra copy of the garbage collector service and the monitoring service, since each of these will run on the server on which you run this script.
+
+<h3>Stopping accumulo</h3>
+
+<p>Similar to the start-all.sh script, we provide a bin/stop-all.sh script to shut down accumulo. This will prompt for the root password so that it can
+ask the master to shut down the tablet servers gracefully. If the tablet servers do not respond, or the master takes too long, you can force a shutdown by hitting Ctrl-C
+at the password prompt, and waiting 15 seconds for the script to force a shutdown. Normally, once the shutdown happens gracefully, unresponsive tablet servers are
+forcibly shut down after 5 seconds.
+
+<h3>Adding a Node</h3>
+
+<p>Update your <code>$ACCUMULO_HOME/conf/slaves</code> (or <code>$ACCUMULO_CONF_DIR/slaves</code>) file to account for the addition; at a minimum this needs to be on the host(s) being added, but in practice it's good to ensure consistent configuration across all nodes.</p>
+
+<pre>
+$ACCUMULO_HOME/bin/accumulo admin start >host(s)> {<host> ...}
+</pre>
+
+<p>Alternatively, you can ssh to each of the hosts you want to add and run <code>$ACCUMULO_HOME/bin/start-here.sh</code>.</p>
+
+<p>Make sure the host in question has the new configuration, or else the tablet server won't start.</p>
+
+<h3>Decomissioning a Node</h3>
+
+<p>If you need to take a node out of operation, you can trigger a graceful shutdown of a tablet server. Accumulo will automatically rebalance the tablets across the available tablet servers.</p>
+
+<pre>
+$ACCUMULO_HOME/bin/accumulo admin stop >host(s)> {<host> ...}
+</pre>
+
+<p>Alternatively, you can ssh to each of the hosts you want to remove and run <code>$ACCUMULO_HOME/bin/stop-here.sh</code>.</p>
+
+<p>Be sure to update your <code>$ACCUMULO_HOME/conf/slaves</code> (or <code>$ACCUMULO_CONF_DIR/slaves</code>) file to account for the removal of these hosts. Bear in mind that the monitor will not re-read the slaves file automatically, so it will report the decomissioned servers as down; it's recommended that you restart the monitor so that the node list is up to date.</p>
+
+<h3>Configuration</h3>
+<p>Accumulo configuration information is stored in a xml file and ZooKeeper. System wide
+configuration information is stored in accumulo-site.xml. In order for accumulo to
+find this file its directory must be on the classpath. Accumulo will log a warning if it can not find
+it, and will use built-in default values. The accumulo scripts try to put the config directory on the classpath.
+
+<p>Starting with version 1.0, per-table configuration was
+introduced. This information is stored in ZooKeeper. This information
+can be manipulated using the config command in the accumulo
+shell. ZooKeeper will notify all tablet servers when config properties
+are modified. This makes it possible to change major compaction
+settings, for example, for a table while accumulo is running.
+
+<p>Per-table configuration settings override system settings.
+
+<p>See the possible configuration options and their default values <a href='config.html'>here</a>
+
+<h3>Managing system resources</h3>
+
+<p>It is very important how disk and memory usage are allocated across the cluster and how servers processes are allocated across the cluster.
+
+<ul>
+ <li> On larger clusters, run the namenode, secondary namenode, jobtracker, accumulo master, and zookeepers on dedicated nodes. On a smaller cluster you may want to run all master processes on one node. When doing this ensure that the max total memory that could be used by all master processes does not exceed system memory. Swapping on your single master node would not be good.
+ <li> Accumulo 1.2 and earlier rely on zookeeper but do not use it heavily. On a large cluster setting up 3 or 5 zookeepers should be plenty. Since there is no performance gain when running more zookeepers, fault tolerance is the only benefit.
+ <li> On slave nodes ensure the memory used by all slave processes is less than system memory. For example the following slave node config could use up to 38G of RAM : tablet server 3G, logger 1G, data node 2G, up to 10 mappers each using 2G, and up 6 reducers each using 2G. If the slave nodes only have 32G, then using 38G will result in swapping which could cause tablet server to lose their lock in zookeeper and die. Even if swapping does not cause tablet servers to die, it will kill performance.
+ <li>Accumulo and map reduce will work with less memory, but it has an impact. Accumulo will minor compact more frequently when it has less map memory, resulting in more major compactions. The minor and major compactions both use CPU and HDFS I/O. The same goes for map reduce, the less memory you give it, the more it has to sort and spill. Try to minimize spilling and compactions as much as possible without causing swapping.
+ <li>Accumulo writes data to disk before it sorts it in memory. This allows data that was in memory when a tablet server crashes to be recovered. Each slave node needs a local directory to write this data to. Ensure the file system holding this directory has at least 100G free on all nodes. Also, if this directory is in a filesystem used by map reduce or hdfs they may effect each others performance.
+</ul>
+
+<p>There are a few settings that determine how much memory accumulo tablet
+servers use. In accumulo-env.sh there is a setting called
+ACCUMULO_TSERVER_OPTS. By default this is set to something like "-Xmx512m
+-Xms512m". These are Java jvm options asking Java to use 512 megabytes of
+memory. By default accumulo stores data written to it outside of the Java
+memory space in order to avoid pauses caused by the Java garbage collector. The
+amount of memory it uses for this data is determined by the accumulo setting
+"tserver.memory.maps.max". Since this memory is outside of the Java managed
+memory, the process can grow larger than the -Xmx setting. So if -Xmx is set
+to 512M and tserver.memory.maps.max is set to 1G, a tablet server process can
+be expected to use 1.5G. If tserver.memory.maps.native.enabled is set to
+false, then accumulo will only use memory managed by Java and the process will
+not use more than what -Xmx is set to. In this case the
+tserver.memory.maps.max setting should be 75% of the -Xmx setting.
+
+<h3>Swappiness</h3>
+
+<p>The linux kernel will swap out memory of running programs to increase
+the size of the disk buffers. This tendency to swap out is controlled by
+a kernel setting called "swappiness." This behavior does not work well for
+large java servers. When a java process runs a garbage collection, it touches
+lots of pages forcing all swapped out pages back into memory. It is suggested
+that swappiness be set to zero.
+
+<pre>
+ # sysctl -w vm.swappiness=0
+ # echo "vm.swappiness = 0" >> /etc/sysctl.conf
+</pre>
+
+<h3>Hadoop timeouts</h3>
+
+<p>In order to detect failed datanodes, use shorter timeouts. Add the following to your
+hdfs-site.xml file:
+
+<pre>
+
+ <property>
+ <name>dfs.socket.timeout</name>
+ <value>3000</value>
+ </property>
+
+ <property>
+ <name>dfs.socket.write.timeout</name>
+ <value>5000</value>
+ </property>
+
+ <property>
+ <name>ipc.client.connect.timeout</name>
+ <value>1000</value>
+ </property>
+
+ <property>
+ <name>ipc.clident.connect.max.retries.on.timeouts</name>
+ <value>2</value>
+ </property>
+
+
+
+</pre>
+
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/bulkIngest.html
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/bulkIngest.html b/docs/src/main/resources/bulkIngest.html
new file mode 100644
index 0000000..9e9896e
--- /dev/null
+++ b/docs/src/main/resources/bulkIngest.html
@@ -0,0 +1,114 @@
+<!--
+ 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 Bulk Ingest</title>
+<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
+</head>
+<body>
+
+<h1>Apache Accumulo Documentation : Bulk Ingest</h2>
+
+<p>Accumulo supports the ability to import sorted files produced by an
+external process into an online table. Often, it is much faster to churn
+through large amounts of data using map/reduce to produce the these files.
+The new files can be incorporated into Accumulo using bulk ingest.
+
+<ul>
+<li>Construct an <code>org.apache.accumulo.core.client.Connector</code> instance</li>
+<li>Call <code>connector.tableOperations().getSplits()</code></li>
+<li>Run a map/reduce job using <code>RangePartitioner</code>
+with splits from the previous step</li>
+<li>Call <code>connector.tableOperations().importDirectory()</code> passing the output directory of the MapReduce job</li>
+</ul>
+
+<p>Files can also be imported using the "importdirectory" shell command.
+
+<p>A complete example is available in <a href='examples/README.bulkIngest'>README.bulkIngest</a>
+
+<p>Importing data using whole files of sorted data can be very efficient, but it differs
+from live ingest in the following ways:
+<ul>
+ <li>Table constraints are not applied against they data in the file.
+ <li>Adding new files to tables are likely to trigger major compactions.
+ <li>The timestamp in the file could contain strange values. Accumulo can be asked to use the ingest timestamp for all values if this is a concern.
+ <li>It is possible to create invalid visibility values (for example "&|"). This will cause errors when the data is accessed.
+ <li>Bulk imports do not effect the entry counts in the monitor page until the files are compacted.
+</ul>
+
+<h2>Best Practices</h2>
+
+<p>Consider two approaches to creating ingest files using map/reduce.
+
+<ol>
+ <li>A large file containing the Key/Value pairs for only a single tablet.
+ <li>A set of small files containing Key/Value pairs for every tablet.
+<ol>
+
+<p>In the first case, adding the file requires telling a single tablet server about a single file. Even if the file
+is 20G in size, it is one call to the tablet server. The tablet server makes one extra file entry in the
+tablet's metadata, and the data is now part of the tablet.
+
+<p>In the second case, an request must be made for each tablet for each file to be added. If there
+100 files and 100 tablets, this will be 10K requests, and the number of files needed to be opened
+for scans on these tablets will be very large. Major compactions will most likely start which will eventually
+fix the problem, but a lot more work needs to be done by accumulo to read these files.
+
+<p>Getting good, fast, bulk import performance depends on creating files like the first, and avoiding files like
+the second.
+
+<p>For this reason, a RangePartitioner should be used to create files when
+writing with the AccumuloFileOutputFormat.
+
+<p>Hash partition is not recommended because it will put keys in random
+groups, exactly like our bad approach.
+
+<P>Any set of cut points for range partitioning can be used in a map
+reduce job, but using Accumulo's current splits is probably the most
+optimal thing to do. However in some cases there may be too many
+splits. For example if there are 2000 splits, you would need to run
+2001 reducers. To overcome this problem use the
+<code>connector.tableOperations.getSplits(<table name>,<max
+splits>)</code> method. This method will not return more than
+<code> <max splits> </code> splits, but the splits it returns
+will optimally partition the data for Accumulo.
+
+<p>Remember that Accumulo never splits rows across tablets.
+Therefore the range partitioner only considers rows when partitioning.
+
+<p>When bulk importing many files into a new table, it might be good to pre-split the table to bring
+additional resources to accepting the data. For example, if you know your data is indexed based on the
+date, pre-creating splits for each day will allow files to fall into natural splits. Having more tablets
+accept the new data means that more resources can be used to import the data right away.
+
+<p>An alternative to bulk ingest is to have a map/reduce job use
+<code>AccumuloOutputFormat</code>, which can support billions of inserts per
+hour, depending on the size of your cluster. This is sufficient for
+most users, but bulk ingest remains the fastest way to incorporate
+data into Accumulo. In addition, bulk ingest has one advantage over
+AccumuloOutputFormat: there is no duplicate data insertion. When one uses
+map/reduce to output data to accumulo, restarted jobs may re-enter
+data from previous failed attempts. Generally, this only matters when
+there are aggregators. With bulk ingest, reducers are writing to new
+map files, so it does not matter. If a reduce fails, you create a new
+map file. When all reducers finish, you bulk ingest the map files
+into Accumulo. The disadvantage to bulk ingest over <code>AccumuloOutputFormat</code> is
+greater latency: the entire map/reduce job must complete
+before any data is available.
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/combiners.html
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/combiners.html b/docs/src/main/resources/combiners.html
new file mode 100644
index 0000000..a5e3dc0
--- /dev/null
+++ b/docs/src/main/resources/combiners.html
@@ -0,0 +1,87 @@
+<!--
+ 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>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/constraints.html
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/constraints.html b/docs/src/main/resources/constraints.html
new file mode 100644
index 0000000..d6e5037
--- /dev/null
+++ b/docs/src/main/resources/constraints.html
@@ -0,0 +1,50 @@
+<!--
+ 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 Constraints</title>
+<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
+</head>
+<body>
+
+<h1>Apache Accumulo Documentation : Constraints</h1>
+
+Accumulo supports constraints. Constraints are applied to mutations at ingest time.
+
+<p>Implementing a new constraint is a snap. Simply write some Java code that
+implements <code>org.apache.accumulo.core.constraints.Constraint</code>.
+
+<p>To deploy a new constraint, jar it up and put the jar in accumulo/lib/ext.
+
+<p>After creating a constraint, set a table specific property to use it. The following example adds two constraints to table foo. In the example com.test.ExampleConstraint and com.test.AnotherConstraint are class names.
+
+<p><pre>
+user@instance:9999 perDayCounts> createtable foo
+user@instance:9999 foo> config -t foo -s table.constraint.1=com.test.ExampleConstraint
+user@instance:9999 foo> config -t foo -s table.constraint.2=com.test.AnotherConstraint
+user@instance:9999 foo> config -t foo -f constraint
+---------+------------------------------------------+-----------------------------------------
+SCOPE | NAME | VALUE
+---------+------------------------------------------+-----------------------------------------
+table | table.constraint.1...................... | com.test.ExampleConstraint
+table | table.constraint.2...................... | com.test.AnotherConstraint
+---------+------------------------------------------+-----------------------------------------
+user@instance:9999 foo>
+</pre>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/distributedTracing.html
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/distributedTracing.html b/docs/src/main/resources/distributedTracing.html
new file mode 100644
index 0000000..54c9095
--- /dev/null
+++ b/docs/src/main/resources/distributedTracing.html
@@ -0,0 +1,99 @@
+<!--
+ 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 Distributed Tracing</title>
+<link rel='stylesheet' type='text/css' href='documentation.css' media='screen'/>
+</head>
+<body>
+
+<h1>Apache Accumulo Documentation : Distributed Tracing</h1>
+
+<p>It can be difficult to determine why some operations are taking longer than expected. For example, you may be looking up items with
+very low latency, but sometimes the lookups take much longer. Determining the cause of the delay is difficult because the system is
+distributed, and the typical lookup is fast.</p>
+
+<p>To provide insight into what accumulo is doing during your scan, you can turn on tracing before you do your operation:</p>
+
+<pre>
+ DistributedTrace.enable(instance, zooReader, hostname, "myApplication");
+ Trace scanTrace = Trace.on("client:scan");
+ BatchScanner scanner = conn.createBatchScanner(...);
+ // Configure your scanner
+ for (Entry<Key, Value> entry : scanner) {
+ }
+ Trace.off();
+</pre>
+
+
+<p>Accumulo has been instrumented to record the time that various operations take when tracing is turned on. The fact that tracing is
+enabled follows all the requests made on behalf of the user throughout the distributed infrastructure of accumulo, and across all
+threads of execution.</p>
+
+<p>These time spans will be inserted into the trace accumulo table. You can browse recent traces from the accumulo monitor page.
+You can also read the trace table directly.</p>
+
+<p>Tracing is supported in the shell. For example:
+
+<pre>
+root@test> createtable test
+root@test test> insert a b c d
+root@test test> trace on
+root@test test> scan
+a b:c [] d
+root@test test> trace off
+Waiting for trace information
+Waiting for trace information
+Waiting for trace information
+Trace started at 2011/03/16 09:20:31.387
+Time Start Service@Location Name
+ 3355+0 shell@host2 shell:root
+ 1+1 shell@host2 client:listUsers
+ 1+1434 tserver@host2 getUserAuthorizations
+ 1+1434 shell@host2 client:getUserAuthorizations
+ 10+1550 shell@host2 scan
+ 9+1551 shell@host2 scan:location
+ 7+1552 shell@host2 client:startScan
+ 6+1553 tserver@host2 startScan
+ 5+1553 tserver@host2 tablet read ahead 11
+ 1+1559 shell@host2 client:closeScan
+ 1+1561 shell@host2 client:listUsers
+</pre>
+
+<p>Here we can see that the shell is getting the list of users (which is used for tab-completion) after every command. While
+unexpected, it is a fast operation. In fact, all the requests are very fast, and most of the time is spent waiting for the user
+to make a request while tracing is turned on.</p>
+
+<p>Spans are added to the trace table asynchronously. The user may have to wait several seconds for all requests to complete before the
+trace information is complete.</p>
+
+<p>You can extract the trace data out of the trace table. Each span is a stored as a column in a row named for the trace id.
+The following code will print out a trace:</p>
+
+<pre>
+String table = AccumuloConfiguration.getSystemConfiguration().get(Property.TRACE_TABLE);
+Scanner scanner = shellState.connector.createScanner(table, auths);
+scanner.setRange(new Range(new Text(Long.toHexString(scanTrace.traceId()))));
+TraceDump.printTrace(scanner, new Printer() {
+ void print(String line) {
+ System.out.println(line);
+ }
+});
+</pre>
+
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/documentation.css
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/documentation.css b/docs/src/main/resources/documentation.css
new file mode 100644
index 0000000..3457dac
--- /dev/null
+++ b/docs/src/main/resources/documentation.css
@@ -0,0 +1,112 @@
+/*
+* 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, body {
+ font-size: 10pt;
+ font-family: verdana, arial;
+}
+
+h1 {
+ font-size: 1.7em;
+ font-variant: small-caps;
+ text-align: left;
+}
+
+h2 {
+ font-size: 1.3em;
+ text-align: left;
+}
+
+.highlight {
+ background-color: rgb(206,244,181);
+}
+
+.deprecated {
+ text-decoration: line-through;
+}
+
+table {
+ min-width: 60%;
+ border: 1px #333333 solid;
+ border-spacing-top: 0;
+ border-spacing-bottom: 0;
+ border: 1px #333333 solid;
+ border: 1px #333333 solid;
+}
+
+th {
+ border-top: 0;
+ border-bottom: 3px #333333 solid;
+ border-left: 1px #333333 dotted;
+ border-right: 0;
+ border-spacing-top: 0;
+ border-spacing-bottom: 0;
+ text-align: center;
+ font-variant: small-caps;
+ padding-left: 0.1em;
+ padding-right: 0.1em;
+ padding-top: 0.2em;
+ padding-bottom: 0.2em;
+ vertical-align: bottom;
+}
+
+td {
+ border-top: 0;
+ border-bottom: 0;
+ border-left: 0;
+ border-right: 0;
+ border-spacing-top: 0;
+ border-spacing-bottom: 0;
+ padding-left: 0.05em;
+ padding-right: 0.05em;
+ padding-top: 0.15em;
+ padding-bottom: 0.15em;
+}
+
+thead {
+ color: rgb(66,114,185);
+ text-align: center;
+ text-weight: bold;
+}
+
+td {
+ font-size: 10pt;
+ text-align:left;
+ padding-left:7pt;
+ padding-right:7pt;
+}
+
+pre {
+ font-size: 9pt;
+}
+
+a {
+ text-decoration: none;
+ color: #0000ff;
+ line-height: 1.5em;
+}
+
+a:hover {
+ color: #004400;
+ text-decoration: underline;
+}
+
+.large {
+ font-size: 1.5em;
+ font-variant: small-caps;
+ text-align: left;
+}
+
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/examples/README
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/examples/README b/docs/src/main/resources/examples/README
new file mode 100644
index 0000000..4211050
--- /dev/null
+++ b/docs/src/main/resources/examples/README
@@ -0,0 +1,95 @@
+Title: Apache Accumulo Examples
+Notice: 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.
+
+Before running any of the examples, the following steps must be performed.
+
+1. Install and run Accumulo via the instructions found in $ACCUMULO_HOME/README.
+ Remember the instance name. It will be referred to as "instance" throughout
+ the examples. A comma-separated list of zookeeper servers will be referred
+ to as "zookeepers".
+
+2. Create an Accumulo user (see the [user manual][1]), or use the root user.
+ The "username" Accumulo user name with password "password" is used
+ throughout the examples. This user needs the ability to create tables.
+
+In all commands, you will need to replace "instance", "zookeepers",
+"username", and "password" with the values you set for your Accumulo instance.
+
+Commands intended to be run in bash are prefixed by '$'. These are always
+assumed to be run from the $ACCUMULO_HOME directory.
+
+Commands intended to be run in the Accumulo shell are prefixed by '>'.
+
+Each README in the examples directory highlights the use of particular
+features of Apache Accumulo.
+
+ README.batch: Using the batch writer and batch scanner.
+
+ README.bloom: Creating a bloom filter enabled table to increase query
+ performance.
+
+ README.bulkIngest: Ingesting bulk data using map/reduce jobs on Hadoop.
+
+ README.classpath: Using per-table classpaths.
+
+ README.client: Using table operations, reading and writing data in Java.
+
+ README.combiner: Using example StatsCombiner to find min, max, sum, and
+ count.
+
+ README.constraints: Using constraints with tables.
+
+ README.dirlist: Storing filesystem information.
+
+ README.export: Exporting and importing tables.
+
+ README.filedata: Storing file data.
+
+ README.filter: Using the AgeOffFilter to remove records more than 30
+ seconds old.
+
+ README.helloworld: Inserting records both inside map/reduce jobs and
+ outside. And reading records between two rows.
+
+ README.isolation: Using the isolated scanner to ensure partial changes
+ are not seen.
+
+ README.mapred: Using MapReduce to read from and write to Accumulo
+ tables.
+
+ README.maxmutation: Limiting mutation size to avoid running out of memory.
+
+ README.regex: Using MapReduce and Accumulo to find data using regular
+ expressions.
+
+ README.rowhash: Using MapReduce to read a table and write to a new
+ column in the same table.
+
+ README.shard: Using the intersecting iterator with a term index
+ partitioned by document.
+
+ README.tabletofile: Using MapReduce to read a table and write one of its
+ columns to a file in HDFS.
+
+ README.terasort: Generating random data and sorting it using Accumulo.
+
+ README.visibility: Using visibilities (or combinations of authorizations).
+ Also shows user permissions.
+
+
+[1]: /1.5/user_manual/Accumulo_Shell.html#User_Administration
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/examples/README.batch
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/examples/README.batch b/docs/src/main/resources/examples/README.batch
new file mode 100644
index 0000000..05f2304
--- /dev/null
+++ b/docs/src/main/resources/examples/README.batch
@@ -0,0 +1,55 @@
+Title: Apache Accumulo Batch Writing and Scanning Example
+Notice: 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.
+
+This tutorial uses the following Java classes, which can be found in org.apache.accumulo.examples.simple.client in the examples-simple module:
+
+ * SequentialBatchWriter.java - writes mutations with sequential rows and random values
+ * RandomBatchWriter.java - used by SequentialBatchWriter to generate random values
+ * RandomBatchScanner.java - reads random rows and verifies their values
+
+This is an example of how to use the batch writer and batch scanner. To compile
+the example, run maven and copy the produced jar into the accumulo lib dir.
+This is already done in the tar distribution.
+
+Below are commands that add 10000 entries to accumulo and then do 100 random
+queries. The write command generates random 50 byte values.
+
+Be sure to use the name of your instance (given as instance here) and the appropriate
+list of zookeeper nodes (given as zookeepers here).
+
+Before you run this, you must ensure that the user you are running has the
+"exampleVis" authorization. (you can set this in the shell with "setauths -u username -s exampleVis")
+
+ $ ./bin/accumulo shell -u root -e "setauths -u username -s exampleVis"
+
+You must also create the table, batchtest1, ahead of time. (In the shell, use "createtable batchtest1")
+
+ $ ./bin/accumulo shell -u username -e "createtable batchtest1"
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.SequentialBatchWriter -i instance -z zookeepers -u username -p password -t batchtest1 --start 0 --num 10000 --size 50 --batchMemory 20M --batchLatency 500 --batchThreads 20 --vis exampleVis
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchScanner -i instance -z zookeepers -u username -p password -t batchtest1 --num 100 --min 0 --max 10000 --size 50 --scanThreads 20 --vis exampleVis
+ 07 11:33:11,103 [client.CountingVerifyingReceiver] INFO : Generating 100 random queries...
+ 07 11:33:11,112 [client.CountingVerifyingReceiver] INFO : finished
+ 07 11:33:11,260 [client.CountingVerifyingReceiver] INFO : 694.44 lookups/sec 0.14 secs
+
+ 07 11:33:11,260 [client.CountingVerifyingReceiver] INFO : num results : 100
+
+ 07 11:33:11,364 [client.CountingVerifyingReceiver] INFO : Generating 100 random queries...
+ 07 11:33:11,370 [client.CountingVerifyingReceiver] INFO : finished
+ 07 11:33:11,416 [client.CountingVerifyingReceiver] INFO : 2173.91 lookups/sec 0.05 secs
+
+ 07 11:33:11,416 [client.CountingVerifyingReceiver] INFO : num results : 100
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/examples/README.bloom
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/examples/README.bloom b/docs/src/main/resources/examples/README.bloom
new file mode 100644
index 0000000..6fe4602
--- /dev/null
+++ b/docs/src/main/resources/examples/README.bloom
@@ -0,0 +1,219 @@
+Title: Apache Accumulo Bloom Filter Example
+Notice: 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.
+
+This example shows how to create a table with bloom filters enabled. It also
+shows how bloom filters increase query performance when looking for values that
+do not exist in a table.
+
+Below table named bloom_test is created and bloom filters are enabled.
+
+ $ ./bin/accumulo shell -u username -p password
+ Shell - Apache Accumulo Interactive Shell
+ - version: 1.5.0
+ - instance name: instance
+ - instance id: 00000000-0000-0000-0000-000000000000
+ -
+ - type 'help' for a list of available commands
+ -
+ username@instance> setauths -u username -s exampleVis
+ username@instance> createtable bloom_test
+ username@instance bloom_test> config -t bloom_test -s table.bloom.enabled=true
+ username@instance bloom_test> exit
+
+Below 1 million random values are inserted into accumulo. The randomly
+generated rows range between 0 and 1 billion. The random number generator is
+initialized with the seed 7.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter --seed 7 -i instance -z zookeepers -u username -p password -t bloom_test --num 1000000 -min 0 -max 1000000000 -valueSize 50 -batchMemory 2M -batchLatency 60s -batchThreads 3 --vis exampleVis
+
+Below the table is flushed:
+
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test -w'
+ 05 10:40:06,069 [shell.Shell] INFO : Flush of table bloom_test completed.
+
+After the flush completes, 500 random queries are done against the table. The
+same seed is used to generate the queries, therefore everything is found in the
+table.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchScanner --seed 7 -i instance -z zookeepers -u username -p password -t bloom_test --num 500 --min 0 --max 1000000000 --size 50 -batchThreads 20 --vis exampleVis
+ Generating 500 random queries...finished
+ 96.19 lookups/sec 5.20 secs
+ num results : 500
+ Generating 500 random queries...finished
+ 102.35 lookups/sec 4.89 secs
+ num results : 500
+
+Below another 500 queries are performed, using a different seed which results
+in nothing being found. In this case the lookups are much faster because of
+the bloom filters.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchScanner --seed 8 -i instance -z zookeepers -u username -p password -t bloom_test --num 500 --min 0 --max 1000000000 --size 50 -batchThreads 20 -auths exampleVis
+ Generating 500 random queries...finished
+ 2212.39 lookups/sec 0.23 secs
+ num results : 0
+ Did not find 500 rows
+ Generating 500 random queries...finished
+ 4464.29 lookups/sec 0.11 secs
+ num results : 0
+ Did not find 500 rows
+
+********************************************************************************
+
+Bloom filters can also speed up lookups for entries that exist. In accumulo
+data is divided into tablets and each tablet has multiple map files. Every
+lookup in accumulo goes to a specific tablet where a lookup is done on each
+map file in the tablet. So if a tablet has three map files, lookup performance
+can be three times slower than a tablet with one map file. However if the map
+files contain unique sets of data, then bloom filters can help eliminate map
+files that do not contain the row being looked up. To illustrate this two
+identical tables were created using the following process. One table had bloom
+filters, the other did not. Also the major compaction ratio was increased to
+prevent the files from being compacted into one file.
+
+ * Insert 1 million entries using RandomBatchWriter with a seed of 7
+ * Flush the table using the shell
+ * Insert 1 million entries using RandomBatchWriter with a seed of 8
+ * Flush the table using the shell
+ * Insert 1 million entries using RandomBatchWriter with a seed of 9
+ * Flush the table using the shell
+
+After following the above steps, each table will have a tablet with three map
+files. Flushing the table after each batch of inserts will create a map file.
+Each map file will contain 1 million entries generated with a different seed.
+This is assuming that Accumulo is configured with enough memory to hold 1
+million inserts. If not, then more map files will be created.
+
+The commands for creating the first table without bloom filters are below.
+
+ $ ./bin/accumulo shell -u username -p password
+ Shell - Apache Accumulo Interactive Shell
+ - version: 1.5.0
+ - instance name: instance
+ - instance id: 00000000-0000-0000-0000-000000000000
+ -
+ - type 'help' for a list of available commands
+ -
+ username@instance> setauths -u username -s exampleVis
+ username@instance> createtable bloom_test1
+ username@instance bloom_test1> config -t bloom_test1 -s table.compaction.major.ratio=7
+ username@instance bloom_test1> exit
+
+ $ ARGS="-i instance -z zookeepers -u username -p password -t bloom_test1 --num 1000000 --min 0 --max 1000000000 --size 50 --batchMemory 2M --batchLatency 60s --batchThreads 3 --auths exampleVis"
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter --seed 7 $ARGS
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test1 -w'
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter --seed 8 $ARGS
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test1 -w'
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter --seed 9 $ARGS
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test1 -w'
+
+The commands for creating the second table with bloom filers are below.
+
+ $ ./bin/accumulo shell -u username -p password
+ Shell - Apache Accumulo Interactive Shell
+ - version: 1.5.0
+ - instance name: instance
+ - instance id: 00000000-0000-0000-0000-000000000000
+ -
+ - type 'help' for a list of available commands
+ -
+ username@instance> setauths -u username -s exampleVis
+ username@instance> createtable bloom_test2
+ username@instance bloom_test2> config -t bloom_test2 -s table.compaction.major.ratio=7
+ username@instance bloom_test2> config -t bloom_test2 -s table.bloom.enabled=true
+ username@instance bloom_test2> exit
+
+ $ ARGS="-i instance -z zookeepers -u username -p password -t bloom_test2 --num 1000000 --min 0 --max 1000000000 --size 50 --batchMemory 2M --batchLatency 60s --batchThreads 3 --auths exampleVis"
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter --seed 7 $ARGS
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test2 -w'
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter --seed 8 $ARGS
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test2 -w'
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter --seed 9 $ARGS
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test2 -w'
+
+Below 500 lookups are done against the table without bloom filters using random
+NG seed 7. Even though only one map file will likely contain entries for this
+seed, all map files will be interrogated.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchScanner --seed 7 -i instance -z zookeepers -u username -p password -t bloom_test1 --num 500 --min 0 --max 1000000000 --size 50 --scanThreads 20 --auths exampleVis
+ Generating 500 random queries...finished
+ 35.09 lookups/sec 14.25 secs
+ num results : 500
+ Generating 500 random queries...finished
+ 35.33 lookups/sec 14.15 secs
+ num results : 500
+
+Below the same lookups are done against the table with bloom filters. The
+lookups were 2.86 times faster because only one map file was used, even though three
+map files existed.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchScanner --seed 7 -i instance -z zookeepers -u username -p password -t bloom_test2 --num 500 --min 0 --max 1000000000 --size 50 -scanThreads 20 --auths exampleVis
+ Generating 500 random queries...finished
+ 99.03 lookups/sec 5.05 secs
+ num results : 500
+ Generating 500 random queries...finished
+ 101.15 lookups/sec 4.94 secs
+ num results : 500
+
+You can verify the table has three files by looking in HDFS. To look in HDFS
+you will need the table ID, because this is used in HDFS instead of the table
+name. The following command will show table ids.
+
+ $ ./bin/accumulo shell -u username -p password -e 'tables -l'
+ accumulo.metadata => !0
+ accumulo.root => +r
+ bloom_test1 => o7
+ bloom_test2 => o8
+ trace => 1
+
+So the table id for bloom_test2 is o8. The command below shows what files this
+table has in HDFS. This assumes Accumulo is at the default location in HDFS.
+
+ $ hadoop fs -lsr /accumulo/tables/o8
+ drwxr-xr-x - username supergroup 0 2012-01-10 14:02 /accumulo/tables/o8/default_tablet
+ -rw-r--r-- 3 username supergroup 52672650 2012-01-10 14:01 /accumulo/tables/o8/default_tablet/F00000dj.rf
+ -rw-r--r-- 3 username supergroup 52436176 2012-01-10 14:01 /accumulo/tables/o8/default_tablet/F00000dk.rf
+ -rw-r--r-- 3 username supergroup 52850173 2012-01-10 14:02 /accumulo/tables/o8/default_tablet/F00000dl.rf
+
+Running the rfile-info command shows that one of the files has a bloom filter
+and its 1.5MB.
+
+ $ ./bin/accumulo rfile-info /accumulo/tables/o8/default_tablet/F00000dj.rf
+ Locality group : <DEFAULT>
+ Start block : 0
+ Num blocks : 752
+ Index level 0 : 43,598 bytes 1 blocks
+ First key : row_0000001169 foo:1 [exampleVis] 1326222052539 false
+ Last key : row_0999999421 foo:1 [exampleVis] 1326222052058 false
+ Num entries : 999,536
+ Column families : [foo]
+
+ Meta block : BCFile.index
+ Raw size : 4 bytes
+ Compressed size : 12 bytes
+ Compression type : gz
+
+ Meta block : RFile.index
+ Raw size : 43,696 bytes
+ Compressed size : 15,592 bytes
+ Compression type : gz
+
+ Meta block : acu_bloom
+ Raw size : 1,540,292 bytes
+ Compressed size : 1,433,115 bytes
+ Compression type : gz
+
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/examples/README.bulkIngest
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/examples/README.bulkIngest b/docs/src/main/resources/examples/README.bulkIngest
new file mode 100644
index 0000000..e07dc9b
--- /dev/null
+++ b/docs/src/main/resources/examples/README.bulkIngest
@@ -0,0 +1,33 @@
+Title: Apache Accumulo Bulk Ingest Example
+Notice: 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.
+
+This is an example of how to bulk ingest data into accumulo using map reduce.
+
+The following commands show how to run this example. This example creates a
+table called test_bulk which has two initial split points. Then 1000 rows of
+test data are created in HDFS. After that the 1000 rows are ingested into
+accumulo. Then we verify the 1000 rows are in accumulo.
+
+ $ PKG=org.apache.accumulo.examples.simple.mapreduce.bulk
+ $ ARGS="-i instance -z zookeepers -u username -p password"
+ $ ./bin/accumulo $PKG.SetupTable $ARGS -t test_bulk row_00000333 row_00000666
+ $ ./bin/accumulo $PKG.GenerateTestData --start-row 0 --count 1000 --output bulk/test_1.txt
+ $ ./bin/tool.sh lib/accumulo-examples-simple.jar $PKG.BulkIngestExample $ARGS -t test_bulk --inputDir bulk --workDir tmp/bulkWork
+ $ ./bin/accumulo $PKG.VerifyIngest $ARGS -t test_bulk --start-row 0 --count 1000
+
+For a high level discussion of bulk ingest, see the docs dir.
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/examples/README.classpath
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/examples/README.classpath b/docs/src/main/resources/examples/README.classpath
new file mode 100644
index 0000000..79da239
--- /dev/null
+++ b/docs/src/main/resources/examples/README.classpath
@@ -0,0 +1,68 @@
+Title: Apache Accumulo Classpath Example
+Notice: 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.
+
+
+This example shows how to use per table classpaths. The example leverages a
+test jar which contains a Filter that supresses rows containing "foo". The
+example shows copying the FooFilter.jar into HDFS and then making an Accumulo
+table reference that jar.
+
+
+Execute the following command in the shell.
+
+ $ hadoop fs -copyFromLocal $ACCUMULO_HOME/test/src/test/resources/FooFilter.jar /user1/lib
+
+Execute following in Accumulo shell to setup classpath context
+
+ root@test15> config -s general.vfs.context.classpath.cx1=hdfs://<namenode host>:<namenode port>/user1/lib
+
+Create a table
+
+ root@test15> createtable nofoo
+
+The following command makes this table use the configured classpath context
+
+ root@test15 nofoo> config -t nofoo -s table.classpath.context=cx1
+
+The following command configures an iterator thats in FooFilter.jar
+
+ root@test15 nofoo> setiter -n foofilter -p 10 -scan -minc -majc -class org.apache.accumulo.test.FooFilter
+ Filter accepts or rejects each Key/Value pair
+ ----------> set FooFilter parameter negate, default false keeps k/v that pass accept method, true rejects k/v that pass accept method: false
+
+The commands below show the filter is working.
+
+ root@test15 nofoo> insert foo1 f1 q1 v1
+ root@test15 nofoo> insert noo1 f1 q1 v2
+ root@test15 nofoo> scan
+ noo1 f1:q1 [] v2
+ root@test15 nofoo>
+
+Below, an attempt is made to add the FooFilter to a table thats not configured
+to use the clasppath context cx1. This fails util the table is configured to
+use cx1.
+
+ root@test15 nofoo> createtable nofootwo
+ root@test15 nofootwo> setiter -n foofilter -p 10 -scan -minc -majc -class org.apache.accumulo.test.FooFilter
+ 2013-05-03 12:49:35,943 [shell.Shell] ERROR: java.lang.IllegalArgumentException: org.apache.accumulo.test.FooFilter
+ root@test15 nofootwo> config -t nofootwo -s table.classpath.context=cx1
+ root@test15 nofootwo> setiter -n foofilter -p 10 -scan -minc -majc -class org.apache.accumulo.test.FooFilter
+ Filter accepts or rejects each Key/Value pair
+ ----------> set FooFilter parameter negate, default false keeps k/v that pass accept method, true rejects k/v that pass accept method: false
+
+
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/examples/README.client
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/examples/README.client b/docs/src/main/resources/examples/README.client
new file mode 100644
index 0000000..f6b8bcb
--- /dev/null
+++ b/docs/src/main/resources/examples/README.client
@@ -0,0 +1,79 @@
+Title: Apache Accumulo Client Examples
+Notice: 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.
+
+This documents how you run the simplest java examples.
+
+This tutorial uses the following Java classes, which can be found in org.apache.accumulo.examples.simple.client in the examples-simple module:
+
+ * Flush.java - flushes a table
+ * RowOperations.java - reads and writes rows
+ * ReadWriteExample.java - creates a table, writes to it, and reads from it
+
+Using the accumulo command, you can run the simple client examples by providing their
+class name, and enough arguments to find your accumulo instance. For example,
+the Flush class will flush a table:
+
+ $ PACKAGE=org.apache.accumulo.examples.simple.client
+ $ bin/accumulo $PACKAGE.Flush -u root -p mypassword -i instance -z zookeeper -t trace
+
+The very simple RowOperations class demonstrates how to read and write rows using the BatchWriter
+and Scanner:
+
+ $ bin/accumulo $PACKAGE.RowOperations -u root -p mypassword -i instance -z zookeeper
+ 2013-01-14 14:45:24,738 [client.RowOperations] INFO : This is everything
+ 2013-01-14 14:45:24,744 [client.RowOperations] INFO : Key: row1 column:1 [] 1358192724640 false Value: This is the value for this key
+ 2013-01-14 14:45:24,744 [client.RowOperations] INFO : Key: row1 column:2 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,744 [client.RowOperations] INFO : Key: row1 column:3 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,744 [client.RowOperations] INFO : Key: row1 column:4 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,746 [client.RowOperations] INFO : Key: row2 column:1 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,746 [client.RowOperations] INFO : Key: row2 column:2 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,746 [client.RowOperations] INFO : Key: row2 column:3 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,746 [client.RowOperations] INFO : Key: row2 column:4 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,747 [client.RowOperations] INFO : Key: row3 column:1 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,747 [client.RowOperations] INFO : Key: row3 column:2 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,747 [client.RowOperations] INFO : Key: row3 column:3 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,747 [client.RowOperations] INFO : Key: row3 column:4 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,756 [client.RowOperations] INFO : This is row1 and row3
+ 2013-01-14 14:45:24,757 [client.RowOperations] INFO : Key: row1 column:1 [] 1358192724640 false Value: This is the value for this key
+ 2013-01-14 14:45:24,757 [client.RowOperations] INFO : Key: row1 column:2 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,757 [client.RowOperations] INFO : Key: row1 column:3 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,757 [client.RowOperations] INFO : Key: row1 column:4 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,761 [client.RowOperations] INFO : Key: row3 column:1 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,761 [client.RowOperations] INFO : Key: row3 column:2 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,761 [client.RowOperations] INFO : Key: row3 column:3 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,761 [client.RowOperations] INFO : Key: row3 column:4 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,765 [client.RowOperations] INFO : This is just row3
+ 2013-01-14 14:45:24,769 [client.RowOperations] INFO : Key: row3 column:1 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,770 [client.RowOperations] INFO : Key: row3 column:2 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,770 [client.RowOperations] INFO : Key: row3 column:3 [] 1358192724642 false Value: This is the value for this key
+ 2013-01-14 14:45:24,770 [client.RowOperations] INFO : Key: row3 column:4 [] 1358192724642 false Value: This is the value for this key
+
+To create a table, write to it and read from it:
+
+ $ bin/accumulo $PACKAGE.ReadWriteExample -u root -p mypassword -i instance -z zookeeper --createtable --create --read
+ hello%00; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+ hello%01; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+ hello%02; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+ hello%03; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+ hello%04; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+ hello%05; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+ hello%06; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+ hello%07; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+ hello%08; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+ hello%09; datatypes:xml [LEVEL1|GROUP1] 1358192329450 false -> world
+
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/examples/README.combiner
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/examples/README.combiner b/docs/src/main/resources/examples/README.combiner
new file mode 100644
index 0000000..f388e5b
--- /dev/null
+++ b/docs/src/main/resources/examples/README.combiner
@@ -0,0 +1,70 @@
+Title: Apache Accumulo Combiner Example
+Notice: 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.
+
+This tutorial uses the following Java class, which can be found in org.apache.accumulo.examples.simple.combiner in the examples-simple module:
+
+ * StatsCombiner.java - a combiner that calculates max, min, sum, and count
+
+This is a simple combiner example. To build this example run maven and then
+copy the produced jar into the accumulo lib dir. This is already done in the
+tar distribution.
+
+ $ bin/accumulo shell -u username
+ Enter current password for 'username'@'instance': ***
+
+ Shell - Apache Accumulo Interactive Shell
+ -
+ - version: 1.5.0
+ - instance name: instance
+ - instance id: 00000000-0000-0000-0000-000000000000
+ -
+ - type 'help' for a list of available commands
+ -
+ username@instance> createtable runners
+ username@instance runners> setiter -t runners -p 10 -scan -minc -majc -n decStats -class org.apache.accumulo.examples.simple.combiner.StatsCombiner
+ Combiner that keeps track of min, max, sum, and count
+ ----------> set StatsCombiner parameter all, set to true to apply Combiner to every column, otherwise leave blank. if true, columns option will be ignored.:
+ ----------> set StatsCombiner parameter columns, <col fam>[:<col qual>]{,<col fam>[:<col qual>]} escape non aplhanum chars using %<hex>.: stat
+ ----------> set StatsCombiner parameter radix, radix/base of the numbers: 10
+ username@instance runners> setiter -t runners -p 11 -scan -minc -majc -n hexStats -class org.apache.accumulo.examples.simple.combiner.StatsCombiner
+ Combiner that keeps track of min, max, sum, and count
+ ----------> set StatsCombiner parameter all, set to true to apply Combiner to every column, otherwise leave blank. if true, columns option will be ignored.:
+ ----------> set StatsCombiner parameter columns, <col fam>[:<col qual>]{,<col fam>[:<col qual>]} escape non aplhanum chars using %<hex>.: hstat
+ ----------> set StatsCombiner parameter radix, radix/base of the numbers: 16
+ username@instance runners> insert 123456 name first Joe
+ username@instance runners> insert 123456 stat marathon 240
+ username@instance runners> scan
+ 123456 name:first [] Joe
+ 123456 stat:marathon [] 240,240,240,1
+ username@instance runners> insert 123456 stat marathon 230
+ username@instance runners> insert 123456 stat marathon 220
+ username@instance runners> scan
+ 123456 name:first [] Joe
+ 123456 stat:marathon [] 220,240,690,3
+ username@instance runners> insert 123456 hstat virtualMarathon 6a
+ username@instance runners> insert 123456 hstat virtualMarathon 6b
+ username@instance runners> scan
+ 123456 hstat:virtualMarathon [] 6a,6b,d5,2
+ 123456 name:first [] Joe
+ 123456 stat:marathon [] 220,240,690,3
+
+In this example a table is created and the example stats combiner is applied to
+the column family stat and hstat. The stats combiner computes min,max,sum, and
+count. It can be configured to use a different base or radix. In the example
+above the column family stat is configured for base 10 and the column family
+hstat is configured for base 16.
http://git-wip-us.apache.org/repos/asf/accumulo/blob/a20e19fc/docs/src/main/resources/examples/README.constraints
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/examples/README.constraints b/docs/src/main/resources/examples/README.constraints
new file mode 100644
index 0000000..b15b409
--- /dev/null
+++ b/docs/src/main/resources/examples/README.constraints
@@ -0,0 +1,54 @@
+Title: Apache Accumulo Constraints Example
+Notice: 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.
+
+This tutorial uses the following Java classes, which can be found in org.apache.accumulo.examples.simple.constraints in the examples-simple module:
+
+ * AlphaNumKeyConstraint.java - a constraint that requires alphanumeric keys
+ * NumericValueConstraint.java - a constraint that requires numeric string values
+
+This an example of how to create a table with constraints. Below a table is
+created with two example constraints. One constraints does not allow non alpha
+numeric keys. The other constraint does not allow non numeric values. Two
+inserts that violate these constraints are attempted and denied. The scan at
+the end shows the inserts were not allowed.
+
+ $ ./bin/accumulo shell -u username -p password
+
+ Shell - Apache Accumulo Interactive Shell
+ -
+ - version: 1.5.0
+ - instance name: instance
+ - instance id: 00000000-0000-0000-0000-000000000000
+ -
+ - type 'help' for a list of available commands
+ -
+ username@instance> createtable testConstraints
+ username@instance testConstraints> constraint -a org.apache.accumulo.examples.simple.constraints.NumericValueConstraint
+ username@instance testConstraints> constraint -a org.apache.accumulo.examples.simple.constraints.AlphaNumKeyConstraint
+ username@instance testConstraints> insert r1 cf1 cq1 1111
+ username@instance testConstraints> insert r1 cf1 cq1 ABC
+ Constraint Failures:
+ ConstraintViolationSummary(constrainClass:org.apache.accumulo.examples.simple.constraints.NumericValueConstraint, violationCode:1, violationDescription:Value is not numeric, numberOfViolatingMutations:1)
+ username@instance testConstraints> insert r1! cf1 cq1 ABC
+ Constraint Failures:
+ ConstraintViolationSummary(constrainClass:org.apache.accumulo.examples.simple.constraints.NumericValueConstraint, violationCode:1, violationDescription:Value is not numeric, numberOfViolatingMutations:1)
+ ConstraintViolationSummary(constrainClass:org.apache.accumulo.examples.simple.constraints.AlphaNumKeyConstraint, violationCode:1, violationDescription:Row was not alpha numeric, numberOfViolatingMutations:1)
+ username@instance testConstraints> scan
+ r1 cf1:cq1 [] 1111
+ username@instance testConstraints>
+