HBASE-526 Add documentation src and build to the 0.1 branch

Second part of documentation commit.


git-svn-id: https://svn.apache.org/repos/asf/hadoop/hbase/trunk@638612 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2008-03-18 22:32:14 +00:00
parent feb4f2d2b6
commit 9fa72c0177
11 changed files with 113 additions and 76 deletions

View File

@ -95,6 +95,7 @@ Hbase Change Log
HBASE-443 Move internal classes out of HStore
HBASE-515 At least double default timeouts between regionserver and master
HBASE-529 RegionServer needs to recover if datanode goes down
HBASE-456 Clearly state which ports need to be opened in order to run HBase
Branch 0.1

View File

@ -1 +1 @@
See http://wiki.apache.org/lucene-hadoop/Hbase
See the docs directory or http://hbase.org

View File

@ -285,7 +285,6 @@
<path refid="classpath" />
<pathelement path="${java.class.path}"/>
</classpath>
<group title="${Name}" packages="org.apache.hadoop.hbase.*"/>
</javadoc>
</target>

View File

@ -108,6 +108,9 @@ document.write("Last Published: " + document.lastModified);
<div class="menupagetitle">Overview</div>
</div>
<div class="menuitem">
<a href="api/overview-summary.html#overview_description">Getting Started</a>
</div>
<div class="menuitem">
<a href="api/index.html">API Docs</a>
</div>
<div class="menuitem">
@ -152,6 +155,10 @@ document.write("Last Published: " + document.lastModified);
<ul>
<li>
<a href="api/overview-summary.html#overview_description">Getting Started</a>
</li>
<li>
<a href="api/index.html">API Docs</a>
</li>

View File

@ -5,10 +5,10 @@
/Producer (FOP 0.20.5) >>
endobj
5 0 obj
<< /Length 740 /Filter [ /ASCII85Decode /FlateDecode ]
<< /Length 810 /Filter [ /ASCII85Decode /FlateDecode ]
>>
stream
Gat=)a`?,Y(r#;b3$pF574_W&G$DH?WG+3<6dpZ;@7_,83$?n<[kC2YG`g%1n\P3Ts''p\//.L$M?$<n!m0.`LTeohT^[>ZoZ%4,@4\&WOrshJ#5l%/^.]9V#9Rq&l)D9J,3q/"C"'L'brth0Orp-V!?_'+7mnm:@=W#ePa$oW*@C4*U9;JLC'm%e&'W0+D5Glb\PnfN-KA<S8_W5qlSG,VOuj'*12SVs=*8@Wam6&tDkaS2i(fPP;q^_hLjL*rTTG0G4*?e/Zjp:;YauFWe"%.m,G]ru40B(,<Zbq2Za=`+TjHO<I'EN+nQroc2>HhRGU,[2Aq>,$+P,s>J0M[,31<<OJ7-;^YQmt\UUNq:C0?(d!LC^h_'Z:!dtN^sV_VH.8(WI@-r(++"_Nk[?aCHA@9`"6Xt/$4DV^LAEAWb<CPB.Or?oQjnWRidq]N5Ng2R:o,N@#h&K8G=)X*eJAi#G<;)G@D-F8b#8-keVc8*"eo"s7CI%fel;.'6KQkM[re+*WIQTq6).F8cf_Do7r0j1&>*OGS`;AXY+G*apM+M5>%"N+mYL`QE=mLj8t)=?>396HG,XOH$DfT48d3uK+/3t5umBJdA*4<@-3Sh]Hp,9/I(bo[rlb^eb^4fVmQ5JA`^%OlJiq2E-L?m+$)')!NA`V*#,7G6B2jr#u4,)f?/dI;n_@'NE^(I*b!]2,7ZZ4^H,S!OICAc3"`"/Dt<bS?I+SjOIq5A!$B[f~>
Gat=*c#T:-(qfGS3[QYb.YNK5BX`,QSsl+9*1@osaM7p'#D#$`qo[ng_@@WJ`s6sF^>8`g8FeNV^8sGI#t,oi39^.&3!a&T$]t4p+?Y\["@:?E5dU]EmX?]sam[&YbQ@J$m[Hc$/[(VQ.7A:hrds@3ihXB/*Tr*31'W.p3he%S2"^S$DBm;%*/Z4%6YXjtc-WU/q]`Gj&lBs&B2=AbF>?)>Bj5Xo6BfHL6&20c%E`t,1[&,O#%ZMhP"f1?4RLmo[ceAqL)*uRkt";L%=[*VLun0`C2th>$b`rQ*j_0)Ar;e^ZJptLG3cfMr&o)WSBa"er;[gu+W+*a\b@4Im^I]h[8]+&7nS;>5T)P3[I`H1US59E^_hT1YqjtO7B'5\;#"!Z$+oE,n/92:JYKpoHKs*5`F.>_>)(3e2SE=A-P.9iUt/dJRrn\\iZS%gg>b6D8RCboK]<hfB=8*9+U`Vm(Q@TPE%VLofgtl(&n9h+NpSFo_9*4'9]r7[+*c8YYM3%E.*jNfT9lluH(a#ad%;[&NV8'ldIh$+g;0@$ACU2n]fo[3_k=>k)>$$RNnbJT7s&fUIIZWC:AdLRaa<6Wr#*IFJYJf*"akl1ZoXLVB%8%XYK@Z^ip62Y6[]mn)oNN+0jUUr%#1C4fA\9tlM,A&2iN-togcn_^<nX?0#Q6!Be#Z6g7YJn0a`_#71dBOe/W9/'s*u;=*K04TiQXqV(hNj#h:HO3g$UTpKeY=hO*X+"]O"qN)3nYImJ9dZ&987YJmA!`3hJ.&oEp!^B)\2l`ShLBPhHl/pY.n.5\1,#8!Wb:B~>
endstream
endobj
6 0 obj
@ -26,6 +26,7 @@ endobj
9 0 R
10 0 R
11 0 R
12 0 R
]
endobj
8 0 obj
@ -42,10 +43,10 @@ endobj
9 0 obj
<< /Type /Annot
/Subtype /Link
/Rect [ 108.0 555.4 154.992 543.4 ]
/Rect [ 108.0 555.4 180.996 543.4 ]
/C [ 0 0 0 ]
/Border [ 0 0 0 ]
/A << /URI (api/index.html)
/A << /URI (api/overview-summary.html#overview_description)
/S /URI >>
/H /I
>>
@ -53,10 +54,10 @@ endobj
10 0 obj
<< /Type /Annot
/Subtype /Link
/Rect [ 108.0 542.2 132.0 530.2 ]
/Rect [ 108.0 542.2 154.992 530.2 ]
/C [ 0 0 0 ]
/Border [ 0 0 0 ]
/A << /URI (http://wiki.apache.org/hadoop/Hbase)
/A << /URI (api/index.html)
/S /URI >>
/H /I
>>
@ -67,33 +68,44 @@ endobj
/Rect [ 108.0 529.0 132.0 517.0 ]
/C [ 0 0 0 ]
/Border [ 0 0 0 ]
/A << /URI (http://wiki.apache.org/hadoop/Hbase/FAQ)
/A << /URI (http://wiki.apache.org/hadoop/Hbase)
/S /URI >>
/H /I
>>
endobj
12 0 obj
<< /Type /Annot
/Subtype /Link
/Rect [ 108.0 515.8 132.0 503.8 ]
/C [ 0 0 0 ]
/Border [ 0 0 0 ]
/A << /URI (http://wiki.apache.org/hadoop/Hbase/FAQ)
/S /URI >>
/H /I
>>
endobj
13 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F3
/BaseFont /Helvetica-Bold
/Encoding /WinAnsiEncoding >>
endobj
13 0 obj
14 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F5
/BaseFont /Times-Roman
/Encoding /WinAnsiEncoding >>
endobj
14 0 obj
15 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F1
/BaseFont /Helvetica
/Encoding /WinAnsiEncoding >>
endobj
15 0 obj
16 0 obj
<< /Type /Font
/Subtype /Type1
/Name /F2
@ -112,33 +124,34 @@ endobj
endobj
3 0 obj
<<
/Font << /F3 12 0 R /F5 13 0 R /F1 14 0 R /F2 15 0 R >>
/Font << /F3 13 0 R /F5 14 0 R /F1 15 0 R /F2 16 0 R >>
/ProcSet [ /PDF /ImageC /Text ] >>
endobj
xref
0 16
0 17
0000000000 65535 f
0000002239 00000 n
0000002297 00000 n
0000002347 00000 n
0000002510 00000 n
0000002568 00000 n
0000002618 00000 n
0000000015 00000 n
0000000071 00000 n
0000000902 00000 n
0000001022 00000 n
0000001067 00000 n
0000001265 00000 n
0000001426 00000 n
0000001607 00000 n
0000001792 00000 n
0000001905 00000 n
0000002015 00000 n
0000002123 00000 n
0000000972 00000 n
0000001092 00000 n
0000001144 00000 n
0000001342 00000 n
0000001535 00000 n
0000001697 00000 n
0000001878 00000 n
0000002063 00000 n
0000002176 00000 n
0000002286 00000 n
0000002394 00000 n
trailer
<<
/Size 16
/Size 17
/Root 2 0 R
/Info 4 0 R
>>
startxref
2459
2730
%%EOF

View File

@ -108,6 +108,9 @@ document.write("Last Published: " + document.lastModified);
<a href="index.html">Overview</a>
</div>
<div class="menuitem">
<a href="api/overview-summary.html#overview_description">Getting Started</a>
</div>
<div class="menuitem">
<a href="api/index.html">API Docs</a>
</div>
<div class="menuitem">
@ -162,6 +165,12 @@ document.write("Last Published: " + document.lastModified);
</li>
</ul>
<ul>
<li>
<a href="api/overview-summary.html#overview_description">Getting Started</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>started</em>
</li>
</ul>
<ul>
<li>
<a href="api/index.html">API Docs</a>&nbsp;&nbsp;___________________&nbsp;&nbsp;<em>api</em>

View File

@ -5,10 +5,10 @@
/Producer (FOP 0.20.5) >>
endobj
5 0 obj
<< /Length 628 /Filter [ /ASCII85Decode /FlateDecode ]
<< /Length 666 /Filter [ /ASCII85Decode /FlateDecode ]
>>
stream
GatUpd;GF-'Sc(%$=BYHok\+W\4kXGgXN7(MR8;LW]Vtl<IuYZNV<&Jgr:ZUNPn'`T4;m?mpQ%-8:rRr&.f0\8;dK@Y:MqH*FOE/)hXs4EJe/F@utTEn&;sqndM%P..1[_f;a/RMV9@SnYc$AFlC?,\h^QHm2:-Ol&ST-!DKTc8<-+NjG7!MFJIR("RB\9r`H\h)hAI"U`GqaF?ue5FX`<:BpBcs.ef0d-e4YtQ^M,(iIN"FYd4HZnJh?-+mbD)1$X5ris=*-DSM$5lb40i#2uJ@f:a>e:ln'^-4(QVZoq/O&DfcN$jdh\T4;],^XCeQgT?r!8lp)]65j#a?RXOZB:Aqn5/BeaS3X]7Q-H@mqq4q"KH]Jf%=KXNM@:(6:QR/XIWsQ0C?T^k,-aAX(DF2;8OqgfSY@@??g:e="q&atp&._T'G%*Z;]bJ1Q?W@citjAeb@qm;-9(j^:o12CDZ-_<CZ[9Xe<q\\A&Zks*'X4f"ttVl%L.M^"="-7TSt"%TTPlQmXgARX%>8MmaX%K..aMY1BnN<5S?C!=d_ogs)$83A"3ii&;FIY&;iX>hK[>ZX@;9lpUW&*d<M(EhGsC0$IJ[O/6srC[pCW?mVKub]%6l^@.AlL~>
GatUq?#Q2d'Sc)P'u!?plIj08E1+/X51F;IK%,^$W]Vtl<IuYZNV;h]7h_@k'T"/7ic?[-pGr$/>fGQtPn+.S#fN-dg:tQn@,k[GRP+kBS)Y2KT8+QGJ_uBn1@bKOOs"RQ(:U;gg546)@duC$k&k:Vf=EZA0_GVE"6/d/1BX$:c3$-D"HXk^gVmAs[h>d5=h%sMLT^i/cs-3RZ^!F>oWHE7EAFqB,>k7sPB![=;sb7)Y9Z68it6GM_'j\BIisEX;_1E*CLJ2KHE?h@8@<>N@Aku2I/>o1ni).G^bCYe:pR9E*.mYqJmq9t!;dDh^A&Y<m!$^c$);Ss(X8k,O6.@W3dGX"@,<4IBmrS!I_Nng7ENG`.cs)?o:^q'M,'0V!lGVU0@C\;D!Vp@)c7K@c6dCg:_`GnB78:"!2ZB-&(DK\o%,f.H.+@dgil?$'cra!;GGV[C3St]h7\,4Z[mLGY(#TqVKaL.4U\=Ph$7q)nOu&@e$S:ZK]\%dq-]EBWnP[(^nA7".31J3]jg`_kLb.LRR;;J@2-M-!STOY8/S9NaLjV'Wbj5]R6NTpO9Ce.4U!VG,L/R86Pf;Pf=Ll]WQj#HDXft/[LkeRFILG)Bede/,]:9GR5p)GafP-K8A"0q3fiC5%6Et3M.PLJ!]#J<o`*a8X@3~>
endstream
endobj
6 0 obj
@ -72,17 +72,17 @@ endobj
xref
0 12
0000000000 65535 f
0000001451 00000 n
0000001509 00000 n
0000001559 00000 n
0000001489 00000 n
0000001547 00000 n
0000001597 00000 n
0000000015 00000 n
0000000071 00000 n
0000000790 00000 n
0000000896 00000 n
0000001008 00000 n
0000001117 00000 n
0000001227 00000 n
0000001335 00000 n
0000000828 00000 n
0000000934 00000 n
0000001046 00000 n
0000001155 00000 n
0000001265 00000 n
0000001373 00000 n
trailer
<<
/Size 12
@ -90,5 +90,5 @@ trailer
/Info 4 0 R
>>
startxref
1679
1717
%%EOF

View File

@ -30,6 +30,7 @@
<a href="ext:lists">mailing list</a> or browse the archives.
</p>
<ul>
<li><a href="ext:api/started">Getting Started</a></li>
<li><a href="ext:api/index">API Docs</a></li>
<li><a href="ext:wiki">Wiki</a></li>
<li><a href="ext:faq">FAQ</a></li>

View File

@ -33,6 +33,7 @@ See http://forrest.apache.org/docs/linking.html for more info.
<docs label="Documentation">
<overview label="Overview" href="index.html" />
<started label="Getting Started" href="ext:api/started" />
<api label="API Docs" href="ext:api/index" />
<wiki label="Wiki" href="ext:wiki" />
<faq label="FAQ" href="ext:faq" />
@ -54,6 +55,7 @@ See http://forrest.apache.org/docs/linking.html for more info.
<cygwin href="http://www.cygwin.com/" />
<osx href="http://www.apple.com/macosx" />
<api href="api/">
<started href="overview-summary.html#overview_description" />
<index href="index.html" />
<org href="org/">
<apache href="apache/">

View File

@ -1107,7 +1107,6 @@ public class HRegion implements HConstants {
* <i>ts</i>.
*
* @param row row key
* @param ts
* @return map of values
* @throws IOException
*/

View File

@ -22,7 +22,7 @@
<title>HBase</title>
</head>
<body bgcolor="white">
HBase is the <a href="http://lucene.apache.org/hadoop">Hadoop</a> simple database.
<a href="http://hbase.org">HBase</a> is the <a href="http://lucene.apache.org/hadoop">Hadoop</a> simple database.
<h2><a name="requirements">Requirements</a></h2>
<ul>
@ -31,58 +31,61 @@ HBase is the <a href="http://lucene.apache.org/hadoop">Hadoop</a> simple databas
<h2><a name="getting_started" >Getting Started</a></h2>
<p>
What follows presumes you are installing hbase for the first time. If upgrading your
hbase instance, see <a href="#upgrading">Upgrading</a>.
What follows presumes you are installing HBase for the first time. If upgrading your
HBase instance, see <a href="#upgrading">Upgrading</a>.
</p>
<p>
Start by defining the following directory variables for your convenience:
Start by defining the following environment variables for your convenience:
</p>
<p>
<ul>
<li><code>${HBASE_HOME}</code>: The HBase root.
<li><code>${HBASE_HOME}</code>: Set HBASE_HOME to the location of the HBase root: e.g. <code>/user/local/hbase</code>.
</li>
</ul>
</p>
<p>Edit <code>${HBASE_HOME}/conf/hbase-env.sh</code>. In this file you can
set the heapsize for HBase, etc. At a minimum, set
<code>JAVA_HOME</code> to the root of your Java installation.
set the heapsize for HBase, etc. At a minimum, set <code>JAVA_HOME</code> to point at the root of
your Java installation.
<p>
If you are running a standalone operation, proceed to <a href=#runandconfirm>Running
and Confirming Your Installation</a>. If you are running a distributed operation, continue below.
If you are running a standalone operation, there should be nothing further to configure; proceed to
<a href=#runandconfirm>Running and Confirming Your Installation</a>. If you are running a distributed
operation, continue reading.
</p>
<h2><a name="distributed" >Distributed Operation</a></h2>
<p>Distributed mode requires an instance of the Hadoop Distributed File System (DFS).
See the Hadoop <a href="http://lucene.apache.org/hadoop/api/overview-summary.html#overview_description">
requirements and instructions</a> for running a distributed operation. Configuring HBase for a
distributed operation requires modification of the following two files:
requirements and instructions</a> for how to set up a DFS.</p>
<p>Once you have confirmed your DFS setup, configuring HBase requires modification of the following two files:
<code>${HBASE_HOME}/conf/hbase-site.xml</code> and <code>${HBASE_HOME}/conf/regionservers</code>.
The former needs to be pointed at the running Hadoop DFS instance. The latter file lists
all members of the HBase cluster.
all the members of the HBase cluster.
</p>
<p>
<code>hbase-site.xml</code> allows the user to override the properties defined in
Use <code>hbase-site.xml</code> to override the properties defined in
<code>${HBASE_HOME}/conf/hbase-default.xml</code> (<code>hbase-default.xml</code> itself
should never be modified). At a minimum the <code>hbase.master</code> and the
<code>hbase.rootdir</code> properties should be redefined
in <code>hbase-site.xml</code> to define the <code>host:port</code> pair on which to run the
HMaster (<a href="http://wiki.apache.org/lucene-hadoop/Hbase/HbaseArchitecture">read about the
Hbase master, regionservers, etc</a>) and to point hbase at the Hadoop filesystem to use. For
example:
in <code>hbase-site.xml</code> to configure the <code>host:port</code> pair on which the
HMaster runs (<a href="http://wiki.apache.org/lucene-hadoop/Hbase/HbaseArchitecture">read about the
HBase master, regionservers, etc</a>) and to point HBase at the Hadoop filesystem to use. For
example, adding the below to your hbase-site.xml says the master is up on port 60000 on the host
example.org and that HBase should use the <code>/hbase</code> directory in the HDFS whose namenode
is at port 9000, again on example.org:
</p>
<pre>
&lt;configuration&gt;
&lt;property&gt;
&lt;name&gt;hbase.master&lt;/name&gt;
&lt;value&gt;localhost:60000&lt;/value&gt;
&lt;value&gt;example.org:60000&lt;/value&gt;
&lt;description&gt;The host and port that the HBase master runs at.
&lt;/description&gt;
&lt;/property&gt;
&lt;property&gt;
&lt;name&gt;hbase.rootdir&lt;/name&gt;
&lt;value&gt;hdfs://localhost:9000/hbase&lt;/value&gt;
&lt;value&gt;hdfs://example.org:9000/hbase&lt;/value&gt;
&lt;description&gt;The directory shared by region servers.
&lt;/description&gt;
&lt;/property&gt;
@ -91,18 +94,19 @@ example:
</pre>
<p>
The <code>regionserver</code> file lists all the hosts running HRegionServers, one
host per line (This file is synonymous to the slaves file at
host per line (This file is HBase synonym of the hadoop slaves file at
<code>${HADOOP_HOME}/conf/slaves</code>).
</p>
<h2><a name="runandconfirm">Running and Confirming Your Installation</a></h2>
<p>If you are running in standalone, non-distributed mode, hbase by default uses
<p>If you are running in standalone, non-distributed mode, HBase by default uses
the local filesystem.</p>
<p>If you are running a distributed cluster you will need to start the Hadoop DFS daemons
before starting HBase and stop the daemons after HBase has shut down. Start and
stop the Hadoop DFS daemons as per the Hadoop
<a href="http://lucene.apache.org/hadoop/api/overview-summary.html">instructions</a>. HBase
does not normally use the mapreduce daemons. These do not need to be started.</p>
stop the Hadoop DFS daemons by running <code>${HADOOP_HOME}/bin/start-dfs.sh</code>.
Ensure it started properly by testing the put and get of files into the Hadoop filesystem.
HBase does not normally use the mapreduce daemons. These do not need to be started.</p>
<p>Start HBase with the following command:
</p>
@ -112,11 +116,11 @@ ${HBASE_HOME}/bin/start-hbase.sh
<p>
Once HBase has started, enter <code>${HBASE_HOME}/bin/hbase shell</code> to obtain a
shell against HBase from which you can execute HQL commands (HQL is a severe subset of SQL).
In the HBase shell, type
<code>help;</code> to see a list of supported HQL commands. Note that all commands in the HBase
In the HBase shell, type <code>help;</code> to see a list of supported HQL commands. Note
that all commands in the HBase
shell must end with <code>;</code>. Test your installation by creating, viewing, and dropping
a table, as per the help instructions. Be patient with the <code>create</code> and
<code>drop</code> operations as they may each take 10 seconds or more. To stop hbase, exit the
<code>drop</code> operations as they may each take 10 seconds or more. To stop HBase, exit the
HBase shell and enter:
</p>
<pre>
@ -130,19 +134,21 @@ before stopping the Hadoop daemons.
The default location for logs is <code>${HBASE_HOME}/logs</code>.
</p>
<p>HBase also puts up a UI listing vital attributes. By default its deployed on the master host
at port 60010.</p>
at port 60010 (HBase regionservers listen on port 60020 by default and put up an informational
http server at 60030).</p>
<h2><a name="upgrading" >Upgrading</a></h2>
<p>After installing the new HBase, before starting your cluster, run the
<code>${HBASE_DIR}/bin/hbase migrate</code> migration script. It will make any
adjustments to the filesystem data under <code>hbase.rootdir</code> necessary to run
the hbase version (It does not change your install unless you explicitly ask it to).
<p>After installing a new HBase on top of data written by a previous HBase version, before
starting your cluster, run the <code>${HBASE_DIR}/bin/hbase migrate</code> migration script.
It will make any adjustments to the filesystem data under <code>hbase.rootdir</code> necessary to run
the HBase version. It does not change your install unless you explicitly ask it to.
</p>
<h2><a name="related" >Related Documentation</a></h2>
<ul>
<li><a href="http://wiki.apache.org/lucene-hadoop/Hbase">HBase Home Page</a>
<li><a href="http://wiki.apache.org/lucene-hadoop/Hbase/HbaseArchitecture">HBase Architecture</a>
<li><a href="http://hbase.org">HBase Home Page</a>
<li><a href="http://wiki.apache.org/hadoop/Hbase">HBase Wiki</a>
<li><a href="http://hadoop.apache.org/">Hadoop Home Page</a>
</ul>
</body>