Index: conf/tohtml.xsl =================================================================== --- conf/tohtml.xsl (revision 1028988) +++ conf/tohtml.xsl (working copy) @@ -1,52 +0,0 @@ - - - - - - -
- - HBase Default Configuration - -
- - - - - - - - - - - - - - -
propertydefault valuedescription
- -
-
-
Index: src/main/xslt/configuration_to_docbook_section.xsl =================================================================== --- src/main/xslt/configuration_to_docbook_section.xsl (revision 0) +++ src/main/xslt/configuration_to_docbook_section.xsl (revision 0) @@ -0,0 +1,65 @@ + + + + + +
+HBase Default Configuration + + + + +HBase Default Configuration + +This documentation is generated using the default hbase configuration file, +hbase-default.xml, as source. + + + + + + + + + + + + + Default: + + + + + + +
+
+
Index: src/docbkx/book.xml =================================================================== --- src/docbkx/book.xml (revision 1028988) +++ src/docbkx/book.xml (working copy) @@ -1,4 +1,25 @@ + - The <link xlink:href="http://www.hbase.org">HBase</link> + <title>The Apache <link xlink:href="http://www.hbase.org">HBase</link> Book + 2010Apache Software Foundation + + This is the official book of + Apache HBase, + a distributed column-oriented database built on top of + Apache Hadoop Common and HDFS. + + - Initial layout - + Adding first cuts at Configuration, Getting Started, Data Model + + + 5 October 2010 + + stack + Initial layout + + 0.89.20100924 + + - - Introduction + + Preface This book aims to be the official guide for the HBase version it ships with. @@ -41,7 +79,7 @@ hope to fill in the holes with time. Feel free to add to this book should you feel so inclined by adding a patch to an issue up in the HBase JIRA. - + Getting Started @@ -180,6 +218,21 @@ Data Model + The HBase data model resembles that a traditional RDBMS. + Applications store data into HBase tables. + Tables are made of rows and columns. Table cells + -- the intersection of row and column + coordinates -- are versioned. By default, their + version is a timestamp + auto-assigned by HBase at the time of cell insertion. A cell’s content + is an uninterpreted array of bytes. + + Table row keys are also byte arrays so almost anything can + serve as a row key from strings to binary representations of longs or + even serialized data structures. Rows in HBase tables + are sorted by row key. The sort is byte-ordered. All table accesses are + via the table row key -- its primary key. +
Table @@ -200,7 +253,7 @@
- Versions + Versions<indexterm><primary>Versions</primary></indexterm> A {row, column, version} tuple exactly specifies a cell in HBase. Its possible to have an @@ -1252,20 +1305,130 @@ Here we list HBase tools for administration, analysis, fixup, and debugging. + + Compression + TODO: Compression in hbase... +
+ + LZO + + + Running with LZO enabled is recommended though HBase does not ship with + LZO because of licensing issues. To install LZO and verify its installation + and that its available to HBase, do the following... + +
+ +
+ + <varname> + hbase.regionserver.codec + </varname> + + + To have a RegionServer test a set of codecs and fail-to-start if any + code is missing or misinstalled, add the configuration + + hbase.regionserver.codec + + to your hbase-site.xml with a value of + codecs to test on startup. For example if the + + hbase.regionserver.codec + value is lzo,gz and if lzo is not present + or improperly installed, the misconfigured RegionServer will fail + to start. + + + Administrators might make use of this facility to guard against + the case where a new server is added to cluster but the cluster + requires install of a particular coded. + + +
+
+ + Configuration + + + +
+ <filename>hbase-site.xml</filename> and <filename>hbase-default.xml</filename> + What are these? + + + + Not all configuration options make it out to + hbase-default.xml. Configuration + that it thought rare anyone would change can exist only + in code; the only way to turn up the configurations is + via a reading of the source code. + + + + +
+ +
+ <filename>hbase-env.sh</filename> + +
+
+ <filename>log4j.properties</filename> + +
+
+ Noteworthy Configuration + Below we review a couple of the key configurations. + We'll list those you must to change to suit your context + and others that you should review and consider moving on + from defaults after guaging your deploys load and query profiles. + +
+
+ HBase Glossary column family + column family qualifier cf cf - Define a column family + + Columns in HBase are grouped into column families. + All column members of a column family have a common prefix. For example, the + columns courses:history and + courses:math are both members of the + courses column family. + The colon character (:) delimits the column family from the + column family qualifier. + The column family prefix must be composed of + printable characters. The qualifying tail, the + column family qualifier, can be made of any + arbitrary bytes. Column families must be declared up front + at schema definition time whereas columns do not need to be + defined at schema time but can be conjured on the fly while + the table is up an running. + Physically, all column family members are stored together on the + filesystem. Because tunings and + storage specifications are done at the column family level, it is + advised that all column family members have the same general access + pattern and size characteristics. + + Index + Index: pom.xml =================================================================== --- pom.xml (revision 1029089) +++ pom.xml (working copy) @@ -231,6 +231,30 @@ + org.codehaus.mojo + xml-maven-plugin + + + + transform + + pre-site + + + + + + ${basedir}/src/main/resources/ + + hbase-default.xml + + ${basedir}/src/main/xslt/configuration_to_docbook_section.xsl + ${basedir}/target/site/ + + + + + com.agilejava.docbkx docbkx-maven-plugin 2.0.11 @@ -238,7 +262,6 @@ generate-html - generate-pdf pre-site @@ -255,7 +278,7 @@ true true true - book- + hbase-book- 100 true true