Author: medined Date: Wed Feb 27 00:03:48 2013 New Revision: 1450543 URL: http://svn.apache.org/r1450543 Log: ACCUMULO-1104, ACCUMULO-1093, ACCUMULO-1094, ACCUMULO-1095, ACCUMULO-1099, ACCUMULO-1097, ACCUMULO-1102 - Improve documentation
Modified: accumulo/branches/1.5/docs/src/user_manual/chapters/clients.tex accumulo/branches/1.5/docs/src/user_manual/chapters/design.tex accumulo/branches/1.5/docs/src/user_manual/chapters/shell.tex accumulo/branches/1.5/docs/src/user_manual/chapters/table_configuration.tex accumulo/branches/1.5/docs/src/user_manual/chapters/table_design.tex Modified: accumulo/branches/1.5/docs/src/user_manual/chapters/clients.tex URL: http://svn.apache.org/viewvc/accumulo/branches/1.5/docs/src/user_manual/chapters/clients.tex?rev=1450543&r1=1450542&r2=1450543&view=diff ============================================================================== --- accumulo/branches/1.5/docs/src/user_manual/chapters/clients.tex (original) +++ accumulo/branches/1.5/docs/src/user_manual/chapters/clients.tex Wed Feb 27 00:03:48 2013 @@ -27,7 +27,7 @@ of the different ways to execute client \item using the tool script \end{itemize} -Inorder to run client code written to run against Accumulo, you will need to +In order to run client code written to run against Accumulo, you will need to include the jars that Accumulo depends on in your classpath. Accumulo client code depends on Hadoop and Zookeeper. For Hadoop add the hadoop core jar, all of the jars in the Hadoop lib directory, and the conf directory to the @@ -123,7 +123,7 @@ to efficiently return ranges of consecut \subsection{Scanner} -To retrieve data, Clients use a Scanner, which provides acts like an Iterator over +To retrieve data, Clients use a Scanner, which acts like an Iterator over keys and values. Scanners can be configured to start and stop at particular keys, and to return a subset of the columns available. Modified: accumulo/branches/1.5/docs/src/user_manual/chapters/design.tex URL: http://svn.apache.org/viewvc/accumulo/branches/1.5/docs/src/user_manual/chapters/design.tex?rev=1450543&r1=1450542&r2=1450543&view=diff ============================================================================== --- accumulo/branches/1.5/docs/src/user_manual/chapters/design.tex (original) +++ accumulo/branches/1.5/docs/src/user_manual/chapters/design.tex Wed Feb 27 00:03:48 2013 @@ -133,7 +133,7 @@ delete entry when the new file is create If a TabletServer fails, the Master detects it and automatically reassigns the tablets assigned from the failed server to other servers. Any key-value pairs that were in -memory at the time the TabletServer are automatically reapplied from the Write-Ahead +memory at the time the TabletServer fails are automatically reapplied from the Write-Ahead Log to prevent any loss of data. The Master will coordinate the copying of write-ahead logs to HDFS so the logs Modified: accumulo/branches/1.5/docs/src/user_manual/chapters/shell.tex URL: http://svn.apache.org/viewvc/accumulo/branches/1.5/docs/src/user_manual/chapters/shell.tex?rev=1450543&r1=1450542&r2=1450543&view=diff ============================================================================== --- accumulo/branches/1.5/docs/src/user_manual/chapters/shell.tex (original) +++ accumulo/branches/1.5/docs/src/user_manual/chapters/shell.tex Wed Feb 27 00:03:48 2013 @@ -66,7 +66,7 @@ root@myinstance mytable> createtable tes root@myinstance testtable> -root@myinstance junk> deletetable testtable +root@myinstance testtable> deletetable testtable root@myinstance> \end{verbatim} Modified: accumulo/branches/1.5/docs/src/user_manual/chapters/table_configuration.tex URL: http://svn.apache.org/viewvc/accumulo/branches/1.5/docs/src/user_manual/chapters/table_configuration.tex?rev=1450543&r1=1450542&r2=1450543&view=diff ============================================================================== --- accumulo/branches/1.5/docs/src/user_manual/chapters/table_configuration.tex (original) +++ accumulo/branches/1.5/docs/src/user_manual/chapters/table_configuration.tex Wed Feb 27 00:03:48 2013 @@ -21,13 +21,13 @@ behavior of Accumulo as well as improve These include locality groups, constraints, bloom filters, iterators, and block cache. \section{Locality Groups} -Accumulo supports storing of sets of column families separately on disk to allow -clients to scan over columns that are frequently used together efficient and to avoid -scanning over column families that are not requested. After a locality group is set +Accumulo supports storing sets of column families separately on disk to allow +clients to efficiently scan over columns that are frequently used together and to avoid +scanning over column families that are not requested. After a locality group is set, Scanner and BatchScanner operations will automatically take advantage of them whenever the fetchColumnFamilies() method is used. -By default tables place all column families into the same ``default" locality group. +By default, tables place all column families into the same ``default'' locality group. Additional locality groups can be configured anytime via the shell or programmatically as follows: @@ -38,10 +38,9 @@ programmatically as follows: usage: setgroups <group>=<col fam>{,<col fam>}{ <group>=<col fam>{,<col fam>}} [-?] -t <table> -user@myinstance mytable> setgroups -t mytable group_one=colf1,colf2 +user@myinstance mytable> setgroups group_one=colf1,colf2 -t mytable -user@myinstance mytable> getgroups -t mytable -group_one=colf1,colf2 +user@myinstance mytable> getgroups group_one=colf1,colf2 -t mytable \end{verbatim} \normalsize @@ -51,8 +50,7 @@ group_one=colf1,colf2 \begin{verbatim} Connector conn; -HashMap<String,Set<Text>> localityGroups = - new HashMap<String, Set<Text>>(); +HashMap<String,Set<Text>> localityGroups = new HashMap<String, Set<Text>>(); HashSet<Text> metadataColumns = new HashSet<Text>(); metadataColumns.add(new Text("domain")); @@ -470,7 +468,7 @@ compact tablets that overlap the given r \section{Pre-splitting tables} -Accumulo will balance and distribute tables accross servers. Before a +Accumulo will balance and distribute tables across servers. Before a table gets large, it will be maintained as a single tablet on a single server. This limits the speed at which data can be added or queried to the speed of a single node. To improve performance when the a table @@ -503,7 +501,7 @@ of data may change over time. For examp information, and data is continually added and removed to maintain a window of current information, tablets for older rows may be empty. -Accumulo supports tablet merging, which can be used to reduce delete +Accumulo supports tablet merging, which can be used to reduce the number of split points. The following command will merge all rows from ``A'' to ``Z'' into a single tablet: @@ -536,7 +534,7 @@ root@myinstance> merge -t myTable -s 100 By default, small tablets will not be merged into tablets that are already larger than the given size. This can leave isolated small tablets. To force small tablets to be merged into larger tablets use -the ``--force'' option: +the ``--{}--force'' option: \small \begin{verbatim} @@ -562,7 +560,7 @@ Consider an indexing scheme that uses da For example ``20110823-15:20:25.013'' might be a row that specifies a date and time. In some cases, we might like to delete rows based on this date, say to remove all the data older than the current year. -Accumulo supports a delete range operation which can efficiently +Accumulo supports a delete range operation which efficiently removes data between two rows. For example: \small @@ -582,7 +580,7 @@ root@myinstance> deleterange -t myTable \normalsize The shell will not allow you to delete an unbounded range (no start) -unless you provide the ``--force'' option. +unless you provide the ``--{}--force'' option. Range deletion is implemented using splits at the given start/end positions, and will affect the number of splits in the table. Modified: accumulo/branches/1.5/docs/src/user_manual/chapters/table_design.tex URL: http://svn.apache.org/viewvc/accumulo/branches/1.5/docs/src/user_manual/chapters/table_design.tex?rev=1450543&r1=1450542&r2=1450543&view=diff ============================================================================== --- accumulo/branches/1.5/docs/src/user_manual/chapters/table_design.tex (original) +++ accumulo/branches/1.5/docs/src/user_manual/chapters/table_design.tex Wed Feb 27 00:03:48 2013 @@ -19,7 +19,7 @@ \section{Basic Table} Since Accumulo tables are sorted by row ID, each table can be thought of as being -indexed by the row ID. Lookups performed row ID can be executed quickly, by doing +indexed by the row ID. Lookups performed by row ID can be executed quickly, by doing a binary search, first across the tablets, and then within a tablet. Clients should choose a row ID carefully in order to support their desired application. A simple rule is to select a unique identifier as the row ID for each entity to be stored and assign