You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by mi...@apache.org on 2014/12/22 06:45:41 UTC

[3/8] hbase git commit: HBASE-12738 Chunk Ref Guide into file-per-chapter

http://git-wip-us.apache.org/repos/asf/hbase/blob/a1fe1e09/src/main/docbkx/faq.xml
----------------------------------------------------------------------
diff --git a/src/main/docbkx/faq.xml b/src/main/docbkx/faq.xml
new file mode 100644
index 0000000..d7bcb0c
--- /dev/null
+++ b/src/main/docbkx/faq.xml
@@ -0,0 +1,270 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<appendix
+    xml:id="faq"
+    version="5.0"
+    xmlns="http://docbook.org/ns/docbook"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:svg="http://www.w3.org/2000/svg"
+    xmlns:m="http://www.w3.org/1998/Math/MathML"
+    xmlns:html="http://www.w3.org/1999/xhtml"
+    xmlns:db="http://docbook.org/ns/docbook">
+    <!--/**
+ * 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.
+ */
+-->
+        <title >FAQ</title>
+        <qandaset defaultlabel='qanda'>
+            <qandadiv><title>General</title>
+                <qandaentry>
+                    <question><para>When should I use HBase?</para></question>
+                    <answer>
+                        <para>See the <xref linkend="arch.overview" /> in the Architecture chapter.
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry>
+                    <question><para>Are there other HBase FAQs?</para></question>
+                    <answer>
+                        <para>
+                            See the FAQ that is up on the wiki, <link xlink:href="http://wiki.apache.org/hadoop/Hbase/FAQ">HBase Wiki FAQ</link>.
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry xml:id="faq.sql">
+                    <question><para>Does HBase support SQL?</para></question>
+                    <answer>
+                        <para>
+                            Not really.  SQL-ish support for HBase via <link xlink:href="http://hive.apache.org/">Hive</link> is in development, however Hive is based on MapReduce which is not generally suitable for low-latency requests.
+                            See the <xref linkend="datamodel" /> section for examples on the HBase client.
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry>
+                    <question><para>How can I find examples of NoSQL/HBase?</para></question>
+                    <answer>
+                        <para>See the link to the BigTable paper in <xref linkend="other.info" /> in the appendix, as
+                            well as the other papers.
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry>
+                    <question><para>What is the history of HBase?</para></question>
+                    <answer>
+                        <para>See <xref linkend="hbase.history"/>.
+                        </para>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+            <qandadiv>
+                <title>Upgrading</title>
+                <qandaentry>
+                    <question>
+                        <para>How do I upgrade Maven-managed projects from HBase 0.94 to HBase 0.96+?</para>
+                    </question>
+                    <answer>
+                        <para>In HBase 0.96, the project moved to a modular structure. Adjust your project's
+                            dependencies to rely upon the <filename>hbase-client</filename> module or another
+                            module as appropriate, rather than a single JAR. You can model your Maven depency
+                            after one of the following, depending on your targeted version of HBase. See <xref
+                                linkend="upgrade0.96"/> or <xref linkend="upgrade0.98"/> for more
+                            information.</para>
+                        <example>
+                            <title>Maven Dependency for HBase 0.98</title>
+                            <programlisting language="xml"><![CDATA[
+<dependency>
+	<groupId>org.apache.hbase</groupId>
+	<artifactId>hbase-client</artifactId>
+	<version>0.98.5-hadoop2</version>
+</dependency>                
+                ]]></programlisting>
+                        </example>
+                        <example>
+                            <title>Maven Dependency for HBase 0.96</title>
+                            <programlisting language="xml"><![CDATA[
+<dependency>
+	<groupId>org.apache.hbase</groupId>
+	<artifactId>hbase-client</artifactId>
+	<version>0.96.2-hadoop2</version>
+</dependency>             
+                ]]></programlisting>
+                        </example>
+                        <example>
+                            <title>Maven Dependency for HBase 0.94</title>
+                            <programlisting language="xml"><![CDATA[
+<dependency>
+	<groupId>org.apache.hbase</groupId>
+	<artifactId>hbase</artifactId>
+	<version>0.94.3</version>
+</dependency>            
+                ]]></programlisting>
+                        </example>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+            <qandadiv xml:id="faq.arch"><title>Architecture</title>
+                <qandaentry xml:id="faq.arch.regions">
+                    <question><para>How does HBase handle Region-RegionServer assignment and locality?</para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="regions.arch" />.
+                        </para>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+            <qandadiv xml:id="faq.config"><title>Configuration</title>
+                <qandaentry xml:id="faq.config.started">
+                    <question><para>How can I get started with my first cluster?</para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="quickstart" />.
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry xml:id="faq.config.options">
+                    <question><para>Where can I learn about the rest of the configuration options?</para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="configuration" />.
+                        </para>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+            <qandadiv xml:id="faq.design"><title>Schema Design / Data Access</title>
+                <qandaentry xml:id="faq.design.schema">
+                    <question><para>How should I design my schema in HBase?</para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="datamodel" /> and <xref linkend="schema" />
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry>
+                    <question><para>
+                        How can I store (fill in the blank) in HBase?
+                    </para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="supported.datatypes" />.
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry xml:id="secondary.indices">
+                    <question><para>
+                        How can I handle secondary indexes in HBase?
+                    </para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="secondary.indexes" />
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry xml:id="faq.changing.rowkeys">
+                    <question><para>Can I change a table's rowkeys?</para></question>
+                    <answer>
+                        <para> This is a very common question. You can't. See <xref
+                            linkend="changing.rowkeys"/>. </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry xml:id="faq.apis">
+                    <question><para>What APIs does HBase support?</para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="datamodel" />, <xref linkend="client" /> and <xref linkend="nonjava.jvm"/>.
+                        </para>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+            <qandadiv xml:id="faq.mapreduce"><title>MapReduce</title>
+                <qandaentry xml:id="faq.mapreduce.use">
+                    <question><para>How can I use MapReduce with HBase?</para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="mapreduce" />
+                        </para>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+            <qandadiv><title>Performance and Troubleshooting</title>
+                <qandaentry>
+                    <question><para>
+                        How can I improve HBase cluster performance?
+                    </para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="performance" />.
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry>
+                    <question><para>
+                        How can I troubleshoot my HBase cluster?
+                    </para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="trouble" />.
+                        </para>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+            <qandadiv xml:id="ec2"><title>Amazon EC2</title>
+                <qandaentry>
+                    <question><para>
+                        I am running HBase on Amazon EC2 and...
+                    </para></question>
+                    <answer>
+                        <para>
+                            EC2 issues are a special case.  See Troubleshooting <xref linkend="trouble.ec2" /> and Performance <xref linkend="perf.ec2" /> sections.
+                        </para>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+            <qandadiv><title xml:id="faq.operations">Operations</title>
+                <qandaentry>
+                    <question><para>
+                        How do I manage my HBase cluster?
+                    </para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="ops_mgt" />
+                        </para>
+                    </answer>
+                </qandaentry>
+                <qandaentry>
+                    <question><para>
+                        How do I back up my HBase cluster?
+                    </para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="ops.backup" />
+                        </para>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+            <qandadiv><title>HBase in Action</title>
+                <qandaentry>
+                    <question><para>Where can I find interesting videos and presentations on HBase?</para></question>
+                    <answer>
+                        <para>
+                            See <xref linkend="other.info" />
+                        </para>
+                    </answer>
+                </qandaentry>
+            </qandadiv>
+        </qandaset>
+    
+</appendix>