You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by bi...@apache.org on 2012/03/23 20:07:52 UTC
svn commit: r1304563 [1/4] - in /incubator/accumulo/site/trunk:
content/accumulo/ content/accumulo/1.4/ content/accumulo/1.4/examples/
content/accumulo/1.4/user_manual/
content/accumulo/user_manual_1.3-incubating/examples/
content/accumulo/user_manual_...
Author: billie
Date: Fri Mar 23 19:07:51 2012
New Revision: 1304563
URL: http://svn.apache.org/viewvc?rev=1304563&view=rev
Log:
ACCUMULO-145 posted 1.4 manual, reorganized, fixed links, added glossary (to be filled in)
Added:
incubator/accumulo/site/trunk/content/accumulo/1.4/
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/batch.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bloom.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bulkIngest.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/combiner.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/constraints.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/dirlist.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filedata.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filter.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/helloworld.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/index.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/isolation.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/mapred.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/shard.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/examples/visibility.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Accumulo_Design.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Accumulo_Shell.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Administration.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Analytics.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Contents.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/High_Speed_Ingest.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Introduction.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Security.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Shell_Commands.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Table_Configuration.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Table_Design.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/Writing_Accumulo_Clients.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/accumulo_user_manual.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/data_distribution.png (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/failure_handling.png (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/img1.png (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/img2.png (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/img3.png (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/img4.png (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/img5.png (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/img6.png (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/img7.png (with props)
incubator/accumulo/site/trunk/content/accumulo/1.4/user_manual/index.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/glossary.mdtext (with props)
incubator/accumulo/site/trunk/content/accumulo/user_manual_1.3-incubating/examples/index.mdtext (with props)
Removed:
incubator/accumulo/site/trunk/content/accumulo/user_manual_1.4-incubating/
Modified:
incubator/accumulo/site/trunk/content/accumulo/notable_features.mdtext
incubator/accumulo/site/trunk/templates/sidenav.mdtext
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/batch.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/batch.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/batch.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/batch.mdtext Fri Mar 23 19:07:51 2012
@@ -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 simple-examples 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 instance zookeepers username password batchtest1 0 10000 50 20000000 500 20 exampleVis
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchScanner instance zookeepers username password batchtest1 100 0 10000 50 20 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
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/batch.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bloom.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bloom.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bloom.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bloom.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,216 @@
+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.4.x
+ - 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 -s 7 instance zookeepers username password bloom_test 1000000 0 1000000000 50 2000000 60000 3 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 -s 7 instance zookeepers username password bloom_test 500 0 1000000000 50 20 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 -s 8 instance zookeepers username password bloom_test 500 0 1000000000 50 20 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.4.x
+ - 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
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter -s 7 instance zookeepers username password bloom_test1 1000000 0 1000000000 50 2000000 60000 3 exampleVis
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test1 -w'
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter -s 8 instance zookeepers username password bloom_test1 1000000 0 1000000000 50 2000000 60000 3 exampleVis
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test1 -w'
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter -s 9 instance zookeepers username password bloom_test1 1000000 0 1000000000 50 2000000 60000 3 exampleVis
+ $ ./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.4.x
+ - 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
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter -s 7 instance zookeepers username password bloom_test2 1000000 0 1000000000 50 2000000 60000 3 exampleVis
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test2 -w'
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter -s 8 instance zookeepers username password bloom_test2 1000000 0 1000000000 50 2000000 60000 3 exampleVis
+ $ ./bin/accumulo shell -u username -p password -e 'flush -t bloom_test2 -w'
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.client.RandomBatchWriter -s 9 instance zookeepers username password bloom_test2 1000000 0 1000000000 50 2000000 60000 3 exampleVis
+ $ ./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 -s 7 instance zookeepers username password bloom_test1 500 0 1000000000 50 20 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 -s 7 instance zookeepers username password bloom_test2 500 0 1000000000 50 20 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'
+ !METADATA => !0
+ 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 PrintInfo command shows that one of the files has a bloom filter
+and its 1.5MB.
+
+ $ ./bin/accumulo org.apache.accumulo.core.file.rfile.PrintInfo /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
+
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bloom.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bulkIngest.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bulkIngest.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bulkIngest.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bulkIngest.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,34 @@
+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. The
+first two arguments to all of the commands except for GenerateTestData are the
+accumulo instance name, and a comma-separated list of zookeepers.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.mapreduce.bulk.SetupTable instance zookeepers username password test_bulk row_00000333 row_00000666
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.mapreduce.bulk.GenerateTestData 0 1000 bulk/test_1.txt
+
+ $ ./bin/tool.sh lib/examples-simple-*[^c].jar org.apache.accumulo.examples.simple.mapreduce.bulk.BulkIngestExample instance zookeepers username password test_bulk bulk tmp/bulkWork
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.mapreduce.bulk.VerifyIngest instance zookeepers username password test_bulk 0 1000
+
+For a high level discussion of bulk ingest, see the docs dir.
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/bulkIngest.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/combiner.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/combiner.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/combiner.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/combiner.mdtext Fri Mar 23 19:07:51 2012
@@ -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 simple-examples 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.4.x
+ - 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.
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/combiner.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/constraints.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/constraints.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/constraints.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/constraints.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,53 @@
+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 simple-examples 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
+create 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.4.x
+ - 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> config -t testConstraints -s table.constraint.1=org.apache.accumulo.examples.simple.constraints.NumericValueConstraint
+ username@instance testConstraints> config -t testConstraints -s table.constraint.2=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>
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/constraints.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/dirlist.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/dirlist.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/dirlist.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/dirlist.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,110 @@
+Title: Apache Accumulo File System Archive
+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 stores filesystem information in accumulo. The example stores the information in the following three tables. More information about the table structures can be found at the end of README.dirlist.
+
+ * directory table : This table stores information about the filesystem directory structure.
+ * index table : This table stores a file name index. It can be used to quickly find files with given name, suffix, or prefix.
+ * data table : This table stores the file data. File with duplicate data are only stored once.
+
+This example shows how to use Accumulo to store a file system history. It has the following classes:
+
+ * Ingest.java - Recursively lists the files and directories under a given path, ingests their names and file info into one Accumulo table, indexes the file names in a separate table, and the file data into a third table.
+ * QueryUtil.java - Provides utility methods for getting the info for a file, listing the contents of a directory, and performing single wild card searches on file or directory names.
+ * Viewer.java - Provides a GUI for browsing the file system information stored in Accumulo.
+ * FileCount.java - Computes recursive counts over file system information and stores them back into the same Accumulo table.
+
+To begin, ingest some data with Ingest.java.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.dirlist.Ingest instance zookeepers username password dirTable indexTable dataTable exampleVis 100000 /local/username/workspace
+
+This may take some time if there are large files in the /local/username/workspace directory. If you use 0 instead of 100000 on the command line, the ingest will run much faster, but it will not put any file data into Accumulo (the dataTable will be empty).
+Note that running this example will create tables dirTable, indexTable, and dataTable in Accumulo that you should delete when you have completed the example.
+If you modify a file or add new files in the directory ingested (e.g. /local/username/workspace), you can run Ingest again to add new information into the Accumulo tables.
+
+To browse the data ingested, use Viewer.java. Be sure to give the "username" user the authorizations to see the data (in this case, run "setauths -u username -s exampleVis" in the shell, and use the string "exampleVis" as the "auths" in command lines below).
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.dirlist.Viewer instance zookeepers username password dirTable dataTable auths /local/username/workspace
+
+To list the contents of specific directories, use QueryUtil.java.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.dirlist.QueryUtil instance zookeepers username password dirTable auths /local/username
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.dirlist.QueryUtil instance zookeepers username password dirTable auths /local/username/workspace
+
+To perform searches on file or directory names, also use QueryUtil.java. Search terms must contain no more than one wild card and cannot contain "/".
+*Note* these queries run on the _indexTable_ table instead of the dirTable table.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.dirlist.QueryUtil instance zookeepers username password indexTable exampleVis filename -search
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.dirlist.QueryUtil instance zookeepers username password indexTable exampleVis 'filename*' -search
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.dirlist.QueryUtil instance zookeepers username password indexTable exampleVis '*jar' -search
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.dirlist.QueryUtil instance zookeepers username password indexTable exampleVis filename*jar -search
+
+To count the number of direct children (directories and files) and descendants (children and children's descendants, directories and files), run the FileCount over the dirTable table.
+The results are written back to the same table. FileCount reads from and writes to Accumulo. This requires scan authorizations for the read and a visibility for the data written.
+In this example, the authorizations and visibility are set to the same value, exampleVis. See README.visibility for more information on visibility and authorizations.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.dirlist.FileCount instance zookeepers username password dirTable exampleVis exampleVis
+
+## Directory Table
+
+Here is a illustration of what data looks like in the directory table:
+
+ row colf:colq [vis] value
+ 000 dir:exec [exampleVis] true
+ 000 dir:hidden [exampleVis] false
+ 000 dir:lastmod [exampleVis] 1291996886000
+ 000 dir:length [exampleVis] 1666
+ 001/local dir:exec [exampleVis] true
+ 001/local dir:hidden [exampleVis] false
+ 001/local dir:lastmod [exampleVis] 1304945270000
+ 001/local dir:length [exampleVis] 272
+ 002/local/Accumulo.README \x7F\xFF\xFE\xCFH\xA1\x82\x97:exec [exampleVis] false
+ 002/local/Accumulo.README \x7F\xFF\xFE\xCFH\xA1\x82\x97:hidden [exampleVis] false
+ 002/local/Accumulo.README \x7F\xFF\xFE\xCFH\xA1\x82\x97:lastmod [exampleVis] 1308746481000
+ 002/local/Accumulo.README \x7F\xFF\xFE\xCFH\xA1\x82\x97:length [exampleVis] 9192
+ 002/local/Accumulo.README \x7F\xFF\xFE\xCFH\xA1\x82\x97:md5 [exampleVis] 274af6419a3c4c4a259260ac7017cbf1
+
+The rows are of the form depth + path, where depth is the number of slashes ("/") in the path padded to 3 digits. This is so that all the children of a directory appear as consecutive keys in Accumulo; without the depth, you would for example see all the subdirectories of /local before you saw /usr.
+For directories the column family is "dir". For files the column family is Long.MAX_VALUE - lastModified in bytes rather than string format so that newer versions sort earlier.
+
+## Index Table
+
+Here is an illustration of what data looks like in the index table:
+
+ row colf:colq [vis]
+ fAccumulo.README i:002/local/Accumulo.README [exampleVis]
+ flocal i:001/local [exampleVis]
+ rEMDAER.olumuccA i:002/local/Accumulo.README [exampleVis]
+ rlacol i:001/local [exampleVis]
+
+The values of the index table are null. The rows are of the form "f" + filename or "r" + reverse file name. This is to enable searches with wildcards at the beginning, middle, or end.
+
+## Data Table
+
+Here is an illustration of what data looks like in the data table:
+
+ row colf:colq [vis] value
+ 274af6419a3c4c4a259260ac7017cbf1 refs:e77276a2b56e5c15b540eaae32b12c69\x00filext [exampleVis] README
+ 274af6419a3c4c4a259260ac7017cbf1 refs:e77276a2b56e5c15b540eaae32b12c69\x00name [exampleVis] /local/Accumulo.README
+ 274af6419a3c4c4a259260ac7017cbf1 ~chunk:\x00\x0FB@\x00\x00\x00\x00 [exampleVis] *******************************************************************************\x0A1. Building\x0A\x0AIn the normal tarball or RPM release of accumulo, [truncated]
+ 274af6419a3c4c4a259260ac7017cbf1 ~chunk:\x00\x0FB@\x00\x00\x00\x01 [exampleVis]
+
+The rows are the md5 hash of the file. Some column family : column qualifier pairs are "refs" : hash of file name + null byte + property name, in which case the value is property value. There can be multiple references to the same file which are distinguished by the hash of the file name.
+Other column family : column qualifier pairs are "~chunk" : chunk size in bytes + chunk number in bytes, in which case the value is the bytes for that chunk of the file. There is an end of file data marker whose chunk number is the number of chunks for the file and whose value is empty.
+
+There may exist multiple copies of the same file (with the same md5 hash) with different chunk sizes or different visibilities. There is an iterator that can be set on the data table that combines these copies into a single copy with a visibility taken from the visibilities of the file references, e.g. (vis from ref1)|(vis from ref2).
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/dirlist.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filedata.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filedata.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filedata.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filedata.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,47 @@
+Title: Apache Accumulo File System Archive Example (Data Only)
+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 archives file data into an Accumulo table. Files with duplicate data are only stored once.
+The example has the following classes:
+
+ * CharacterHistogram - A MapReduce that computes a histogram of byte frequency for each file and stores the histogram alongside the file data. An example use of the ChunkInputFormat.
+ * ChunkCombiner - An Iterator that dedupes file data and sets their visibilities to a combined visibility based on current references to the file data.
+ * ChunkInputFormat - An Accumulo InputFormat that provides keys containing file info (List<Entry<Key,Value>>) and values with an InputStream over the file (ChunkInputStream).
+ * ChunkInputStream - An input stream over file data stored in Accumulo.
+ * FileDataIngest - Takes a list of files and archives them into Accumulo keyed on the SHA1 hashes of the files.
+ * FileDataQuery - Retrieves file data based on the SHA1 hash of the file. (Used by the dirlist.Viewer.)
+ * KeyUtil - A utility for creating and parsing null-byte separated strings into/from Text objects.
+ * VisibilityCombiner - A utility for merging visibilities into the form (VIS1)|(VIS2)|...
+
+This example is coupled with the dirlist example. See README.dirlist for instructions.
+
+If you haven't already run the README.dirlist example, ingest a file with FileDataIngest.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.filedata.FileDataIngest instance zookeepers username password dataTable exampleVis 1000 $ACCUMULO_HOME/README
+
+Open the accumulo shell and look at the data. The row is the MD5 hash of the file, which you can verify by running a command such as 'md5sum' on the file.
+
+ > scan -t dataTable
+
+Run the CharacterHistogram MapReduce to add some information about the file.
+
+ $ bin/tool.sh lib/examples-simple*[^c].jar org.apache.accumulo.examples.simple.filedata.CharacterHistogram instance zookeepers username password dataTable exampleVis exampleVis
+
+Scan again to see the histogram stored in the 'info' column family.
+
+ > scan -t dataTable
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filedata.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filter.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filter.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filter.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filter.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,110 @@
+Title: Apache Accumulo 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 is a simple filter example. It uses the AgeOffFilter that is provided as
+part of the core package org.apache.accumulo.core.iterators.user. Filters are
+iterators that select desired key/value pairs (or weed out undesired ones).
+Filters extend the org.apache.accumulo.core.iterators.Filter class
+and must implement a method accept(Key k, Value v). This method returns true
+if the key/value pair are to be delivered and false if they are to be ignored.
+Filter takes a "negate" parameter which defaults to false. If set to true, the
+return value of the accept method is negated, so that key/value pairs accepted
+by the method are omitted by the Filter.
+
+ username@instance> createtable filtertest
+ username@instance filtertest> setiter -t filtertest -scan -p 10 -n myfilter -ageoff
+ AgeOffFilter removes entries with timestamps more than <ttl> milliseconds old
+ ----------> set AgeOffFilter parameter negate, default false keeps k/v that pass accept method, true rejects k/v that pass accept method:
+ ----------> set AgeOffFilter parameter ttl, time to live (milliseconds): 30000
+ ----------> set AgeOffFilter parameter currentTime, if set, use the given value as the absolute time in milliseconds as the current time of day:
+ username@instance filtertest> scan
+ username@instance filtertest> insert foo a b c
+ username@instance filtertest> scan
+ foo a:b [] c
+ username@instance filtertest>
+
+... wait 30 seconds ...
+
+ username@instance filtertest> scan
+ username@instance filtertest>
+
+Note the absence of the entry inserted more than 30 seconds ago. Since the
+scope was set to "scan", this means the entry is still in Accumulo, but is
+being filtered out at query time. To delete entries from Accumulo based on
+the ages of their timestamps, AgeOffFilters should be set up for the "minc"
+and "majc" scopes, as well.
+
+To force an ageoff of the persisted data, after setting up the ageoff iterator
+on the "minc" and "majc" scopes you can flush and compact your table. This will
+happen automatically as a background operation on any table that is being
+actively written to, but can also be requested in the shell.
+
+The first setiter command used the special -ageoff flag to specify the
+AgeOffFilter, but any Filter can be configured by using the -class flag. The
+following commands show how to enable the AgeOffFilter for the minc and majc
+scopes using the -class flag, then flush and compact the table.
+
+ username@instance filtertest> setiter -t filtertest -minc -majc -p 10 -n myfilter -class org.apache.accumulo.core.iterators.user.AgeOffFilter
+ AgeOffFilter removes entries with timestamps more than <ttl> milliseconds old
+ ----------> set AgeOffFilter parameter negate, default false keeps k/v that pass accept method, true rejects k/v that pass accept method:
+ ----------> set AgeOffFilter parameter ttl, time to live (milliseconds): 30000
+ ----------> set AgeOffFilter parameter currentTime, if set, use the given value as the absolute time in milliseconds as the current time of day:
+ username@instance filtertest> flush
+ 06 10:42:24,806 [shell.Shell] INFO : Flush of table filtertest initiated...
+ username@instance filtertest> compact
+ 06 10:42:36,781 [shell.Shell] INFO : Compaction of table filtertest started for given range
+ username@instance filtertest> flush -t filtertest -w
+ 06 10:42:52,881 [shell.Shell] INFO : Flush of table filtertest completed.
+ username@instance filtertest> compact -t filtertest -w
+ 06 10:43:00,632 [shell.Shell] INFO : Compacting table ...
+ 06 10:43:01,307 [shell.Shell] INFO : Compaction of table filtertest completed for given range
+ username@instance filtertest>
+
+By default, flush and compact execute in the background, but with the -w flag
+they will wait to return until the operation has completed. Both are
+demonstrated above, though only one call to each would be necessary. A
+specific table can be specified with -t.
+
+After the compaction runs, the newly created files will not contain any data
+that should have been aged off, and the Accumulo garbage collector will remove
+the old files.
+
+To see the iterator settings for a table, use config.
+
+ username@instance filtertest> config -t filtertest -f iterator
+ ---------+---------------------------------------------+---------------------------------------------------------------------------
+ SCOPE | NAME | VALUE
+ ---------+---------------------------------------------+---------------------------------------------------------------------------
+ table | table.iterator.majc.myfilter .............. | 10,org.apache.accumulo.core.iterators.user.AgeOffFilter
+ table | table.iterator.majc.myfilter.opt.ttl ...... | 30000
+ table | table.iterator.majc.vers .................. | 20,org.apache.accumulo.core.iterators.user.VersioningIterator
+ table | table.iterator.majc.vers.opt.maxVersions .. | 1
+ table | table.iterator.minc.myfilter .............. | 10,org.apache.accumulo.core.iterators.user.AgeOffFilter
+ table | table.iterator.minc.myfilter.opt.ttl ...... | 30000
+ table | table.iterator.minc.vers .................. | 20,org.apache.accumulo.core.iterators.user.VersioningIterator
+ table | table.iterator.minc.vers.opt.maxVersions .. | 1
+ table | table.iterator.scan.myfilter .............. | 10,org.apache.accumulo.core.iterators.user.AgeOffFilter
+ table | table.iterator.scan.myfilter.opt.ttl ...... | 30000
+ table | table.iterator.scan.vers .................. | 20,org.apache.accumulo.core.iterators.user.VersioningIterator
+ table | table.iterator.scan.vers.opt.maxVersions .. | 1
+ ---------+---------------------------------------------+---------------------------------------------------------------------------
+ username@instance filtertest>
+
+When setting new iterators, make sure to order their priority numbers
+(specified with -p) in the order you would like the iterators to be applied.
+Also, each iterator must have a unique name and priority within each scope.
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/filter.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/helloworld.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/helloworld.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/helloworld.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/helloworld.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,52 @@
+Title: Apache Accumulo Hello World 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.helloworld in the simple-examples module:
+
+ * InsertWithBatchWriter.java - Inserts 10K rows (50K entries) into accumulo with each row having 5 entries
+ * InsertWithOutputFormat.java - Example of inserting data in MapReduce
+ * ReadData.java - Reads all data between two rows
+
+Log into the accumulo shell:
+
+ $ ./bin/accumulo shell -u username -p password
+
+Create a table called 'hellotable':
+
+ username@instance> createtable hellotable
+
+Launch a Java program that inserts data with a BatchWriter:
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.helloworld.InsertWithBatchWriter instance zookeepers username password hellotable
+
+Alternatively, the same data can be inserted using MapReduce writers:
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.helloworld.InsertWithOutputFormat instance zookeepers username password hellotable
+
+On the accumulo status page at the URL below (where 'master' is replaced with the name or IP of your accumulo master), you should see 50K entries
+
+ http://master:50095/
+
+To view the entries, use the shell to scan the table:
+
+ username@instance> table hellotable
+ username@instance hellotable> scan
+
+You can also use a Java class to scan the table:
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.helloworld.ReadData instance zookeepers username password hellotable row_0 row_1001
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/helloworld.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/index.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/index.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/index.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/index.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,63 @@
+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.
+
+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".
+
+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.
+
+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 '>'.
+
+[1]: /accumulo/1.4/user_manual/Accumulo_Shell.html#User_Administration
+[batch](examples/batch.html)
+
+[bloom](examples/bloom.html)
+
+[bulkIngest](examples/bulkIngest.html)
+
+[combiner](examples/combiner.html)
+
+[constraints](examples/constraints.html)
+
+[dirlist](examples/dirlist.html)
+
+[filedata](examples/filedata.html)
+
+[filter](examples/filter.html)
+
+[helloworld](examples/helloworld.html)
+
+[isolation](examples/isolation.html)
+
+[mapred](examples/mapred.html)
+
+[shard](examples/shard.html)
+
+[visibility](examples/visibility.html)
+
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/index.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/isolation.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/isolation.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/isolation.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/isolation.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,50 @@
+Title: Apache Accumulo Isolation 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.
+
+
+Accumulo has an isolated scanner that ensures partial changes to rows are not
+seen. Isolation is documented in ../docs/isolation.html and the user manual.
+
+InterferenceTest is a simple example that shows the effects of scanning with
+and without isolation. This program starts two threads. One threads
+continually upates all of the values in a row to be the same thing, but
+different from what it used to be. The other thread continually scans the
+table and checks that all values in a row are the same. Without isolation the
+scanning thread will sometimes see different values, which is the result of
+reading the row at the same time a mutation is changing the row.
+
+Below, Interference Test is run without isolation enabled for 5000 iterations
+and it reports problems.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.isolation.InterferenceTest instance zookeepers username password isotest 5000 false
+ ERROR Columns in row 053 had multiple values [53, 4553]
+ ERROR Columns in row 061 had multiple values [561, 61]
+ ERROR Columns in row 070 had multiple values [570, 1070]
+ ERROR Columns in row 079 had multiple values [1079, 1579]
+ ERROR Columns in row 088 had multiple values [2588, 1588]
+ ERROR Columns in row 106 had multiple values [2606, 3106]
+ ERROR Columns in row 115 had multiple values [4615, 3115]
+ finished
+
+Below, Interference Test is run with isolation enabled for 5000 iterations and
+it reports no problems.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.isolation.InterferenceTest instance zookeepers username password isotest 5000 true
+ finished
+
+
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/isolation.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/mapred.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/mapred.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/mapred.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/mapred.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,97 @@
+Title: Apache Accumulo MapReduce 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 uses mapreduce and accumulo to compute word counts for a set of
+documents. This is accomplished using a map-only mapreduce job and a
+accumulo table with combiners.
+
+To run this example you will need a directory in HDFS containing text files.
+The accumulo readme will be used to show how to run this example.
+
+ $ hadoop fs -copyFromLocal $ACCUMULO_HOME/README /user/username/wc/Accumulo.README
+ $ hadoop fs -ls /user/username/wc
+ Found 1 items
+ -rw-r--r-- 2 username supergroup 9359 2009-07-15 17:54 /user/username/wc/Accumulo.README
+
+The first part of running this example is to create a table with a combiner
+for the column family count.
+
+ $ ./bin/accumulo shell -u username -p password
+ Shell - Apache Accumulo Interactive Shell
+ - version: 1.4.x
+ - instance name: instance
+ - instance id: 00000000-0000-0000-0000-000000000000
+ -
+ - type 'help' for a list of available commands
+ -
+ username@instance> createtable wordCount
+ username@instance wordCount> setiter -class org.apache.accumulo.core.iterators.user.SummingCombiner -p 10 -t wordCount -majc -minc -scan
+ SummingCombiner interprets Values as Longs and adds them together. A variety of encodings (variable length, fixed length, or string) are available
+ ----------> set SummingCombiner parameter all, set to true to apply Combiner to every column, otherwise leave blank. if true, columns option will be ignored.: false
+ ----------> set SummingCombiner parameter columns, <col fam>[:<col qual>]{,<col fam>[:<col qual>]} escape non-alphanum chars using %<hex>.: count
+ ----------> set SummingCombiner parameter lossy, if true, failed decodes are ignored. Otherwise combiner will error on failed decodes (default false): <TRUE|FALSE>: false
+ ----------> set SummingCombiner parameter type, <VARLEN|FIXEDLEN|STRING|fullClassName>: STRING
+ username@instance wordCount> quit
+
+After creating the table, run the word count map reduce job.
+
+ $ bin/tool.sh lib/examples-simple*[^c].jar org.apache.accumulo.examples.simple.mapreduce.WordCount instance zookeepers /user/username/wc wordCount -u username -p password
+
+ 11/02/07 18:20:11 INFO input.FileInputFormat: Total input paths to process : 1
+ 11/02/07 18:20:12 INFO mapred.JobClient: Running job: job_201102071740_0003
+ 11/02/07 18:20:13 INFO mapred.JobClient: map 0% reduce 0%
+ 11/02/07 18:20:20 INFO mapred.JobClient: map 100% reduce 0%
+ 11/02/07 18:20:22 INFO mapred.JobClient: Job complete: job_201102071740_0003
+ 11/02/07 18:20:22 INFO mapred.JobClient: Counters: 6
+ 11/02/07 18:20:22 INFO mapred.JobClient: Job Counters
+ 11/02/07 18:20:22 INFO mapred.JobClient: Launched map tasks=1
+ 11/02/07 18:20:22 INFO mapred.JobClient: Data-local map tasks=1
+ 11/02/07 18:20:22 INFO mapred.JobClient: FileSystemCounters
+ 11/02/07 18:20:22 INFO mapred.JobClient: HDFS_BYTES_READ=10487
+ 11/02/07 18:20:22 INFO mapred.JobClient: Map-Reduce Framework
+ 11/02/07 18:20:22 INFO mapred.JobClient: Map input records=255
+ 11/02/07 18:20:22 INFO mapred.JobClient: Spilled Records=0
+ 11/02/07 18:20:22 INFO mapred.JobClient: Map output records=1452
+
+After the map reduce job completes, query the accumulo table to see word
+counts.
+
+ $ ./bin/accumulo shell -u username -p password
+ username@instance> table wordCount
+ username@instance wordCount> scan -b the
+ the count:20080906 [] 75
+ their count:20080906 [] 2
+ them count:20080906 [] 1
+ then count:20080906 [] 1
+ there count:20080906 [] 1
+ these count:20080906 [] 3
+ this count:20080906 [] 6
+ through count:20080906 [] 1
+ time count:20080906 [] 3
+ time. count:20080906 [] 1
+ to count:20080906 [] 27
+ total count:20080906 [] 1
+ tserver, count:20080906 [] 1
+ tserver.compaction.major.concurrent.max count:20080906 [] 1
+ ...
+
+Another example to look at is
+org.apache.accumulo.examples.simple.mapreduce.UniqueColumns. This example
+computes the unique set of columns in a table and shows how a map reduce job
+can directly read a tables files from HDFS.
+
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/mapred.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/shard.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/shard.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/shard.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/shard.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,66 @@
+Title: Apache Accumulo Shard 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.
+
+Accumulo has an iterator called the intersecting iterator which supports querying a term index that is partitioned by
+document, or "sharded". This example shows how to use the intersecting iterator through these four programs:
+
+ * Index.java - Indexes a set of text files into an Accumulo table
+ * Query.java - Finds documents containing a given set of terms.
+ * Reverse.java - Reads the index table and writes a map of documents to terms into another table.
+ * ContinuousQuery.java Uses the table populated by Reverse.java to select N random terms per document. Then it continuously and randomly queries those terms.
+
+To run these example programs, create two tables like below.
+
+ username@instance> createtable shard
+ username@instance shard> createtable doc2term
+
+After creating the tables, index some files. The following command indexes all of the java files in the Accumulo source code.
+
+ $ cd /local/username/workspace/accumulo/
+ $ find src -name "*.java" | xargs ./bin/accumulo org.apache.accumulo.examples.simple.shard.Index instance zookeepers shard username password 30
+
+The following command queries the index to find all files containing 'foo' and 'bar'.
+
+ $ cd $ACCUMULO_HOME
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.shard.Query instance zookeepers shard username password foo bar
+ /local/username/workspace/accumulo/src/core/src/test/java/accumulo/core/security/ColumnVisibilityTest.java
+ /local/username/workspace/accumulo/src/core/src/test/java/accumulo/core/client/mock/MockConnectorTest.java
+ /local/username/workspace/accumulo/src/core/src/test/java/accumulo/core/security/VisibilityEvaluatorTest.java
+ /local/username/workspace/accumulo/src/server/src/main/java/accumulo/server/test/functional/RowDeleteTest.java
+ /local/username/workspace/accumulo/src/server/src/test/java/accumulo/server/logger/TestLogWriter.java
+ /local/username/workspace/accumulo/src/server/src/main/java/accumulo/server/test/functional/DeleteEverythingTest.java
+ /local/username/workspace/accumulo/src/core/src/test/java/accumulo/core/data/KeyExtentTest.java
+ /local/username/workspace/accumulo/src/server/src/test/java/accumulo/server/constraints/MetadataConstraintsTest.java
+ /local/username/workspace/accumulo/src/core/src/test/java/accumulo/core/iterators/WholeRowIteratorTest.java
+ /local/username/workspace/accumulo/src/server/src/test/java/accumulo/server/util/DefaultMapTest.java
+ /local/username/workspace/accumulo/src/server/src/test/java/accumulo/server/tabletserver/InMemoryMapTest.java
+
+In order to run ContinuousQuery, we need to run Reverse.java to populate doc2term.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.shard.Reverse instance zookeepers shard doc2term username password
+
+Below ContinuousQuery is run using 5 terms. So it selects 5 random terms from each document, then it continually randomly selects one set of 5 terms and queries. It prints the number of matching documents and the time in seconds.
+
+ $ ./bin/accumulo org.apache.accumulo.examples.simple.shard.ContinuousQuery instance zookeepers shard doc2term username password 5
+ [public, core, class, binarycomparable, b] 2 0.081
+ [wordtodelete, unindexdocument, doctablename, putdelete, insert] 1 0.041
+ [import, columnvisibilityinterpreterfactory, illegalstateexception, cv, columnvisibility] 1 0.049
+ [getpackage, testversion, util, version, 55] 1 0.048
+ [for, static, println, public, the] 55 0.211
+ [sleeptime, wrappingiterator, options, long, utilwaitthread] 1 0.057
+ [string, public, long, 0, wait] 12 0.132
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/shard.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/visibility.mdtext
URL: http://svn.apache.org/viewvc/incubator/accumulo/site/trunk/content/accumulo/1.4/examples/visibility.mdtext?rev=1304563&view=auto
==============================================================================
--- incubator/accumulo/site/trunk/content/accumulo/1.4/examples/visibility.mdtext (added)
+++ incubator/accumulo/site/trunk/content/accumulo/1.4/examples/visibility.mdtext Fri Mar 23 19:07:51 2012
@@ -0,0 +1,131 @@
+Title: Apache Accumulo Visibility, Authorizations, and Permissions 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.
+
+## Creating a new user
+
+ root@instance> createuser username
+ Enter new password for 'username': ********
+ Please confirm new password for 'username': ********
+ root@instance> user username
+ Enter password for user username: ********
+ username@instance> createtable vistest
+ 06 10:48:47,931 [shell.Shell] ERROR: org.apache.accumulo.core.client.AccumuloSecurityException: Error PERMISSION_DENIED - User does not have permission to perform this action
+ username@instance> userpermissions
+ System permissions:
+
+ Table permissions (!METADATA): Table.READ
+ username@instance>
+
+A user does not by default have permission to create a table.
+
+## Granting permissions to a user
+
+ username@instance> user root
+ Enter password for user root: ********
+ root@instance> grant -s System.CREATE_TABLE -u username
+ root@instance> user username
+ Enter password for user username: ********
+ username@instance> createtable vistest
+ username@instance> userpermissions
+ System permissions: System.CREATE_TABLE
+
+ Table permissions (!METADATA): Table.READ
+ Table permissions (vistest): Table.READ, Table.WRITE, Table.BULK_IMPORT, Table.ALTER_TABLE, Table.GRANT, Table.DROP_TABLE
+ username@instance vistest>
+
+## Inserting data with visibilities
+
+Visibilities are boolean AND (&) and OR (|) combinations of authorization
+tokens. Authorization tokens are arbitrary strings taken from a restricted
+ASCII character set. Parentheses are required to specify order of operations
+in visibilities.
+
+ username@instance vistest> insert row f1 q1 v1 -l A
+ username@instance vistest> insert row f2 q2 v2 -l A&B
+ username@instance vistest> insert row f3 q3 v3 -l apple&carrot|broccoli|spinach
+ 06 11:19:01,432 [shell.Shell] ERROR: org.apache.accumulo.core.util.BadArgumentException: cannot mix | and & near index 12
+ apple&carrot|broccoli|spinach
+ ^
+ username@instance vistest> insert row f3 q3 v3 -l (apple&carrot)|broccoli|spinach
+ username@instance vistest>
+
+## Scanning with authorizations
+
+Authorizations are sets of authorization tokens. Each Accumulo user has
+authorizations and each Accumulo scan has authorizations. Scan authorizations
+are only allowed to be a subset of the user's authorizations. By default, a
+user's authorizations set is empty.
+
+ username@instance vistest> scan
+ username@instance vistest> scan -s A
+ 06 11:43:14,951 [shell.Shell] ERROR: java.lang.RuntimeException: org.apache.accumulo.core.client.AccumuloSecurityException: Error BAD_AUTHORIZATIONS - The user does not have the specified authorizations assigned
+ username@instance vistest>
+
+## Setting authorizations for a user
+
+ username@instance vistest> setauths -s A
+ 06 11:53:42,056 [shell.Shell] ERROR: org.apache.accumulo.core.client.AccumuloSecurityException: Error PERMISSION_DENIED - User does not have permission to perform this action
+ username@instance vistest>
+
+A user cannot set authorizations unless the user has the System.ALTER_USER permission.
+The root user has this permission.
+
+ username@instance vistest> user root
+ Enter password for user root: ********
+ root@instance vistest> setauths -s A -u username
+ root@instance vistest> user username
+ Enter password for user username: ********
+ username@instance vistest> scan -s A
+ row f1:q1 [A] v1
+ username@instance vistest> scan
+ row f1:q1 [A] v1
+ username@instance vistest>
+
+The default authorizations for a scan are the user's entire set of authorizations.
+
+ username@instance vistest> user root
+ Enter password for user root: ********
+ root@instance vistest> setauths -s A,B,broccoli -u username
+ root@instance vistest> user username
+ Enter password for user username: ********
+ username@instance vistest> scan
+ row f1:q1 [A] v1
+ row f2:q2 [A&B] v2
+ row f3:q3 [(apple&carrot)|broccoli|spinach] v3
+ username@instance vistest> scan -s B
+ username@instance vistest>
+
+If you want, you can limit a user to only be able to insert data which they can read themselves.
+It can be set with the following constraint.
+
+ username@instance vistest> user root
+ Enter password for user root: ******
+ root@instance vistest> config -t vistest -s table.constraint.1=org.apache.accumulo.core.security.VisibilityConstraint
+ root@instance vistest> user username
+ Enter password for user username: ********
+ username@instance vistest> insert row f4 q4 v4 -l spinach
+ Constraint Failures:
+ ConstraintViolationSummary(constrainClass:org.apache.accumulo.core.security.VisibilityConstraint, violationCode:2, violationDescription:User does not have authorization on column visibility, numberOfViolatingMutations:1)
+ username@instance vistest> insert row f4 q4 v4 -l spinach|broccoli
+ username@instance vistest> scan
+ row f1:q1 [A] v1
+ row f2:q2 [A&B] v2
+ row f3:q3 [(apple&carrot)|broccoli|spinach] v3
+ row f4:q4 [spinach|broccoli] v4
+ username@instance vistest>
+
\ No newline at end of file
Propchange: incubator/accumulo/site/trunk/content/accumulo/1.4/examples/visibility.mdtext
------------------------------------------------------------------------------
svn:eol-style = native