accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From medi...@apache.org
Subject svn commit: r1337023 - /accumulo/trunk/docs/examples/README
Date Fri, 11 May 2012 04:07:25 GMT
Author: medined
Date: Fri May 11 04:07:25 2012
New Revision: 1337023

URL: http://svn.apache.org/viewvc?rev=1337023&view=rev
Log:
ACCUMULO-588 - add short description of each docs/examples/README.xxx into main README file.

Modified:
    accumulo/trunk/docs/examples/README

Modified: accumulo/trunk/docs/examples/README
URL: http://svn.apache.org/viewvc/accumulo/trunk/docs/examples/README?rev=1337023&r1=1337022&r2=1337023&view=diff
==============================================================================
--- accumulo/trunk/docs/examples/README (original)
+++ accumulo/trunk/docs/examples/README Fri May 11 04:07:25 2012
@@ -16,22 +16,60 @@ Notice:    Licensed to the Apache Softwa
            specific language governing permissions and limitations
            under the License.
 
-Each README in the examples directory highlights the use of particular features of Apache
Accumulo.
-
 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".
+   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 Accumulo user name will be referred to as "username" with password "password" throughout
the examples.
-This user will need to have the ability to create tables.
+   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.
+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 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.combiner:    Using example StatsCombiner to find min, max, sum, and 
+                       count.
+
+   README.constraints: Using constraints with tables.
+
+   README.dirlist:     Storing filesystem information.
+
+   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.maxmutation: Limiting mutation size to avoid running out of memory.
+
+   README.shard:       Using the intersecting iterator with a term index 
+                       partitioned by document.
+
+   README.visibility:  Using visibilities (or combinations of authorizations). 
+                       Also shows user permissions.
+
+
 [1]: /1.5/user_manual/Accumulo_Shell.html#User_Administration



Mime
View raw message